fixed file PHPdoc

issue #3026

build/controllers/PhpDocController.php

@@ -40,6 +40,73 @@ class PhpDocController extends Controller
      * @param string $root the directory to parse files from. Defaults to YII_PATH.
      */
     public function actionProperty($root = null)
+    {
+        $files = $this->findFiles($root);
+
+        $nFilesTotal = 0;
+        $nFilesUpdated = 0;
+        foreach ($files as $file) {
+            $result = $this->generateClassPropertyDocs($file);
+            if ($result !== false) {
+                list($className, $phpdoc) = $result;
+                if ($this->updateFiles) {
+                    if ($this->updateClassPropertyDocs($file, $className, $phpdoc)) {
+                        $nFilesUpdated++;
+                    }
+                } elseif (!empty($phpdoc)) {
+                    $this->stdout("\n[ " . $file . " ]\n\n", Console::BOLD);
+                    $this->stdout($phpdoc);
+                }
+            }
+            $nFilesTotal++;
+        }
+
+        $this->stdout("\nParsed $nFilesTotal files.\n");
+        $this->stdout("Updated $nFilesUpdated files.\n");
+    }
+
+    /**
+     * Fix some issues with PHPdoc in files
+     *
+     * @param string $root the directory to parse files from. Defaults to YII_PATH.
+     */
+    public function actionFix($root = null)
+    {
+        $files = $this->findFiles($root);
+
+        $nFilesTotal = 0;
+        $nFilesUpdated = 0;
+        foreach ($files as $file) {
+            $contents = file_get_contents($file);
+            $sha = sha1($contents);
+
+            // fix line endings
+            $lines = preg_split('/(\r\n|\n|\r)/', $contents);
+
+            $this->fixFileDoc($lines);
+
+            $newContent = implode("\n", $lines);
+            if ($sha !== sha1($newContent)) {
+                $nFilesUpdated++;
+            }
+            file_put_contents($file, $newContent);
+            $nFilesTotal++;
+        }
+
+        $this->stdout("\nParsed $nFilesTotal files.\n");
+        $this->stdout("Updated $nFilesUpdated files.\n");
+
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function options($actionId)
+    {
+        return array_merge(parent::options($actionId), ['updateFiles']);
+    }
+
+    protected function findFiles($root)
     {
         $except = [];
         if ($root === null) {
@@ -89,35 +156,42 @@ class PhpDocController extends Controller
                 'vendor/',
             ]),
         ];
-        $files = FileHelper::findFiles($root, $options);
+        return FileHelper::findFiles($root, $options);
-        $nFilesTotal = 0;
-        $nFilesUpdated = 0;
-        foreach ($files as $file) {
-            $result = $this->generateClassPropertyDocs($file);
-            if ($result !== false) {
-                list($className, $phpdoc) = $result;
-                if ($this->updateFiles) {
-                    if ($this->updateClassPropertyDocs($file, $className, $phpdoc)) {
-                        $nFilesUpdated++;
-                    }
-                } elseif (!empty($phpdoc)) {
-                    $this->stdout("\n[ " . $file . " ]\n\n", Console::BOLD);
-                    $this->stdout($phpdoc);
-                }
-            }
-            $nFilesTotal++;
     }
 
-        $this->stdout("\nParsed $nFilesTotal files.\n");
+    protected function fixFileDoc(&$lines)
-        $this->stdout("Updated $nFilesUpdated files.\n");
-    }
-
-    /**
-     * @inheritdoc
-     */
-    public function options($actionId)
     {
-        return array_merge(parent::options($actionId), ['updateFiles']);
+        // find namespace
+        $namespace = false;
+        $namespaceLine = '';
+        $contentAfterNamespace = false;
+        foreach($lines as $i => $line) {
+            if (substr(trim($line), 0, 9) === 'namespace') {
+                $namespace = $i;
+                $namespaceLine = trim($line);
+            } elseif ($namespace !== false && trim($line) !== '') {
+                $contentAfterNamespace = $i;
+                break;
+            }
+        }
+
+        if ($namespace !== false && $contentAfterNamespace !== false) {
+            while($contentAfterNamespace > 0) {
+                array_shift($lines);
+                $contentAfterNamespace--;
+            }
+            $lines = array_merge([
+                "<?php",
+                "/**",
+                " * @link http://www.yiiframework.com/",
+                " * @copyright Copyright (c) 2008 Yii Software LLC",
+                " * @license http://www.yiiframework.com/license/",
+                " */",
+                "",
+                $namespaceLine,
+                ""
+            ], $lines);
+        }
     }
 
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)

extensions/apidoc/templates/bootstrap/ApiRenderer.php

@@ -6,6 +6,7 @@
  */
 
 namespace yii\apidoc\templates\bootstrap;
+
 use yii\apidoc\models\Context;
 use yii\console\Controller;
 use Yii;

extensions/apidoc/templates/bootstrap/GuideRenderer.php

@@ -6,6 +6,7 @@
  */
 
 namespace yii\apidoc\templates\bootstrap;
+
 use Yii;
 use yii\helpers\Html;
 

extensions/apidoc/templates/bootstrap/RendererTrait.php

@@ -1,6 +1,8 @@
 <?php
 /**
- * @author Carsten Brandt <mail@cebe.cc>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
  */
 
 namespace yii\apidoc\templates\bootstrap;

extensions/codeception/BasePage.php

@@ -1,4 +1,9 @@
 <?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
 
 namespace yii\codeception;
 

extensions/debug/models/search/Mail.php

@@ -1,4 +1,9 @@
 <?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
 
 namespace yii\debug\models\search;
 

extensions/debug/panels/MailPanel.php

@@ -1,4 +1,9 @@
 <?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
 
 namespace yii\debug\panels;
 

extensions/smarty/ViewRenderer.php

@@ -1,9 +1,7 @@
 <?php
 /**
- * Smarty view renderer class file.
- *
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

extensions/sphinx/IndexSchema.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

extensions/twig/ViewRenderer.php

@@ -1,9 +1,7 @@
 <?php
 /**
- * Twig view renderer class file.
- *
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

extensions/twig/ViewRendererStaticClassProxy.php

@@ -1,9 +1,7 @@
 <?php
 /**
- * Twig ViewRendererStaticClassProxy class file.
- *
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/console/Application.php

@@ -1,7 +1,5 @@
 <?php
 /**
- * Console Application class file.
- *
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/console/controllers/MessageController.php

@@ -1,6 +1,5 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/console/controllers/MigrateController.php

@@ -1,6 +1,5 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/db/ActiveQuery.php

@@ -1,6 +1,5 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/db/ActiveRecord.php

@@ -1,6 +1,5 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/db/ActiveRecordInterface.php

@@ -1,8 +1,8 @@
 <?php
 /**
- *
+ * @link http://www.yiiframework.com/
- *
+ * @copyright Copyright (c) 2008 Yii Software LLC
- * @author Carsten Brandt <mail@cebe.cc>
+ * @license http://www.yiiframework.com/license/
  */
 
 namespace yii\db;

framework/db/BaseActiveRecord.php

@@ -1,6 +1,5 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/db/Migration.php

@@ -6,6 +6,7 @@
  */
 
 namespace yii\db;
+
 use yii\di\Instance;
 
 /**

framework/db/TableSchema.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/db/mssql/TableSchema.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/db/pgsql/QueryBuilder.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC

framework/db/pgsql/Schema.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC

framework/helpers/ArrayHelper.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/BaseArrayHelper.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/BaseFileHelper.php

@@ -1,7 +1,5 @@
 <?php
 /**
- * Filesystem helper class file.
- *
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/helpers/BaseHtmlPurifier.php

@@ -1,9 +1,10 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
+
 namespace yii\helpers;
 
 /**

framework/helpers/BaseInflector.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/BaseMarkdown.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/BaseVarDumper.php

@@ -1,8 +1,7 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/FileHelper.php

@@ -1,7 +1,5 @@
 <?php
 /**
- * Filesystem helper class file.
- *
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/helpers/HtmlPurifier.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/Markdown.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * @copyright Copyright (c) 2008 Yii Software LLC
  * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/helpers/VarDumper.php

@@ -1,8 +1,7 @@
 <?php
 /**
- * @author Qiang Xue <qiang.xue@gmail.com>
  * @link http://www.yiiframework.com/
- * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
 

framework/validators/ImageValidator.php

@@ -1,7 +1,5 @@
 <?php
 /**
- * Image validator class file.
- *
  * @link http://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/

framework/widgets/ActiveField.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license http://www.yiiframework.com/license/
  */
+
 namespace yii\widgets;
 
 use Yii;