* @author Alexander Makarov * @since 2.0 */ class PhpDocController extends Controller { public $defaultAction = 'property'; /** * @var bool whether to update class docs directly. Setting this to false will just output docs * for copy and paste. */ public $updateFiles = true; /** * @var bool whether to add copyright header to php files. This should be skipped in application code. */ public $skipFrameworkRequirements = false; /** * Generates `@property` annotations in class files from getters and setters * * Property description will be taken from getter or setter or from an `@property` annotation * in the getters docblock if there is one defined. * * See https://github.com/yiisoft/yii2/wiki/Core-framework-code-style#documentation for details. * * @param string $root the directory to parse files from. Defaults to YII2_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 YII2_PATH. */ public function actionFix($root = null) { $files = $this->findFiles($root, false); $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); if (!$this->skipFrameworkRequirements) { $this->fixFileDoc($lines); } $this->fixDocBlockIndentation($lines); $lines = array_values($this->fixLineSpacing($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', 'skipFrameworkRequirements']); } protected function findFiles($root, $needsInclude = true) { $except = []; if ($needsInclude) { $extensionExcept = [ 'apidoc' => [ '/helpers/PrettyPrinter.php', '/extensions/apidoc/helpers/ApiIndexer.php', '/extensions/apidoc/helpers/ApiMarkdownLaTeX.php', ], 'codeception' => [ '/TestCase.php', '/DbTestCase.php', ], 'gii' => [ '/components/DiffRendererHtmlInline.php', '/generators/extension/default/AutoloadExample.php', ], 'swiftmailer' => [ '/Logger.php', ], 'twig' => [ '/Extension.php', '/Optimizer.php', '/Template.php', '/TwigSimpleFileLoader.php', '/ViewRendererStaticClassProxy.php', ], ]; } else { $extensionExcept = []; } if ($root === null) { $root = dirname(YII2_PATH); $extensionPath = "$root/extensions"; foreach (scandir($extensionPath) as $extension) { if (ctype_alpha($extension) && is_dir($extensionPath . '/' . $extension)) { Yii::setAlias("@yii/$extension", "$extensionPath/$extension"); } } $except = [ '/apps/', '/build/', '/docs/', '/extensions/composer/', '/framework/BaseYii.php', '/framework/Yii.php', 'assets/', 'tests/', 'vendor/', ]; foreach($extensionExcept as $ext => $paths) { foreach($paths as $path) { $except[] = "/extensions/$ext$path"; } } } elseif (preg_match('~extensions/([\w-]+)[\\\\/]?$~', $root, $matches)) { $extensionPath = dirname(rtrim($root, '\\/')); $this->setUpExtensionAliases($extensionPath); list(, $extension) = $matches; Yii::setAlias("@yii/$extension", "$root"); if (is_file($autoloadFile = Yii::getAlias("@yii/$extension/vendor/autoload.php"))) { include($autoloadFile); } if (isset($extensionExcept[$extension])) { foreach($extensionExcept[$extension] as $path) { $except[] = $path; } } $except[] = '/vendor/'; $except[] = '/tests/'; $except[] = '/docs/'; // // composer extension does not contain yii code // if ($extension === 'composer') { // return []; // } } elseif (preg_match('~apps/([\w-]+)[\\\\/]?$~', $root, $matches)) { $extensionPath = dirname(dirname(rtrim($root, '\\/'))) . '/extensions'; $this->setUpExtensionAliases($extensionPath); list(, $appName) = $matches; Yii::setAlias("@app-$appName", "$root"); if (is_file($autoloadFile = Yii::getAlias("@app-$appName/vendor/autoload.php"))) { include($autoloadFile); } $except[] = '/runtime/'; $except[] = '/vendor/'; $except[] = '/tests/'; $except[] = '/docs/'; } $root = FileHelper::normalizePath($root); $options = [ 'filter' => function ($path) { if (is_file($path)) { $file = basename($path); if ($file[0] < 'A' || $file[0] > 'Z') { return false; } } return null; }, 'only' => ['*.php'], 'except' => array_merge($except, [ '.git/', 'views/', 'requirements/', 'gii/generators/', 'vendor/', ]), ]; return FileHelper::findFiles($root, $options); } private function setUpExtensionAliases($extensionPath) { foreach (scandir($extensionPath) as $extension) { if (ctype_alpha($extension) && is_dir($extensionPath . '/' . $extension)) { Yii::setAlias("@yii/$extension", "$extensionPath/$extension"); } } } /** * Fix file PHPdoc */ protected function fixFileDoc(&$lines) { // find namespace $namespace = false; $namespaceLine = ''; $contentAfterNamespace = false; foreach($lines as $i => $line) { $line = trim($line); if (!empty($line)) { if (strncmp($line, 'namespace', 9) === 0) { $namespace = $i; $namespaceLine = $line; } elseif ($namespace !== false) { $contentAfterNamespace = $i; break; } } } if ($namespace !== false && $contentAfterNamespace !== false) { while($contentAfterNamespace > 0) { array_shift($lines); $contentAfterNamespace--; } $lines = array_merge([ " $line) { if (preg_match('~^(\s*)/\*\*$~', $line, $matches)) { $docBlock = true; $indent = $matches[1]; } elseif (preg_match('~^(\s*)\*+/~', $line)) { if ($docBlock) { // could be the end of normal comment $lines[$i] = $indent . ' */'; } $docBlock = false; $codeBlock = false; $listIndent = ''; $tag = false; } elseif ($docBlock) { $line = ltrim($line); if (isset($line[0]) && $line[0] === '*') { $line = substr($line, 1); } if (isset($line[0]) && $line[0] === ' ') { $line = substr($line, 1); } $docLine = str_replace("\t", ' ', rtrim($line)); if (empty($docLine)) { $listIndent = ''; } elseif ($docLine[0] === '@') { $listIndent = ''; $codeBlock = false; $tag = true; $docLine = preg_replace('/\s+/', ' ', $docLine); $docLine = $this->fixParamTypes($docLine); } elseif (preg_match('/^(~~~|```)/', $docLine)) { $codeBlock = !$codeBlock; $listIndent = ''; } elseif (preg_match('/^(\s*)([0-9]+\.|-|\*|\+) /', $docLine, $matches)) { $listIndent = str_repeat(' ', strlen($matches[0])); $tag = false; $lines[$i] = $indent . ' * ' . $docLine; continue; } if ($codeBlock) { $lines[$i] = rtrim($indent . ' * ' . $docLine); } else { $lines[$i] = rtrim($indent . ' * ' . (empty($listIndent) && !$tag ? $docLine : ($listIndent . ltrim($docLine)))); } } } } protected function fixParamTypes($line) { return preg_replace_callback('~@(param|return) ([\w\\|]+)~i', function($matches) { $types = explode('|', $matches[2]); foreach($types as $i => $type) { switch($type){ case 'integer': $types[$i] = 'int'; break; case 'boolean': $types[$i] = 'bool'; break; } } return '@' . $matches[1] . ' ' . implode('|', $types); }, $line); } /** * Fixes line spacing code style for properties and constants */ protected function fixLineSpacing($lines) { $propertiesOnly = false; // remove blank lines between properties $skip = true; $level = 0; foreach($lines as $i => $line) { if (strpos($line, 'class ') !== false) { $skip = false; } if ($skip) { continue; } // keep spaces in multi line arrays if (strpos($line, '*') === false && strncmp(trim($line), "'SQLSTATE[", 10) !== 0) { $level += substr_count($line, '[') - substr_count($line, ']'); } if (trim($line) === '') { if ($level == 0) { unset($lines[$i]); } } elseif (ltrim($line)[0] !== '*' && strpos($line, 'function ') !== false) { break; } elseif (trim($line) === '}') { $propertiesOnly = true; break; } } $lines = array_values($lines); // add back some $endofUse = false; $endofConst = false; $endofPublic = false; $endofProtected = false; $endofPrivate = false; $skip = true; $level = 0; // track array properties $property = ''; foreach($lines as $i => $line) { if (strpos($line, 'class ') !== false) { $skip = false; } if ($skip) { continue; } // check for multi line array if ($level > 0) { ${'endof'.$property} = $i; } $line = trim($line); if (strncmp($line, 'public $', 8) === 0 || strncmp($line, 'public static $', 15) === 0) { $endofPublic = $i; $property = 'Public'; $level = 0; } elseif (strncmp($line, 'protected $', 11) === 0 || strncmp($line, 'protected static $', 18) === 0) { $endofProtected = $i; $property = 'Protected'; $level = 0; } elseif (strncmp($line, 'private $', 9) === 0 || strncmp($line, 'private static $', 16) === 0) { $endofPrivate = $i; $property = 'Private'; $level = 0; } elseif (substr($line,0 , 6) === 'const ') { $endofConst = $i; $property = false; } elseif (substr($line,0 , 4) === 'use ') { $endofUse = $i; $property = false; } elseif (!empty($line) && $line[0] === '*') { $property = false; } elseif (!empty($line) && $line[0] !== '*' && strpos($line, 'function ') !== false || $line === '}') { break; } // check for multi line array if ($property !== false && strncmp($line, "'SQLSTATE[", 10) !== 0) { $level += substr_count($line, '[') - substr_count($line, ']'); } } $endofAll = false; foreach(['Private', 'Protected', 'Public', 'Const', 'Use'] as $var) { if (${'endof'.$var} !== false) { $endofAll = ${'endof'.$var}; break; } } // $this->checkPropertyOrder($lineInfo); $result = []; foreach($lines as $i => $line) { $result[] = $line; if (!($propertiesOnly && $i === $endofAll)) { if ($i === $endofUse || $i === $endofConst || $i === $endofPublic || $i === $endofProtected || $i === $endofPrivate) { $result[] = ''; } if ($i === $endofAll) { $result[] = ''; } } } return $result; } protected function checkPropertyOrder($lineInfo) { // TODO } protected function updateClassPropertyDocs($file, $className, $propertyDoc) { try { $ref = new \ReflectionClass($className); } catch (\Exception $e) { $this->stderr("[ERR] Unable to create ReflectionClass for class '$className': " . $e->getMessage() . "\n", Console::FG_RED); return false; } if ($ref->getFileName() != $file) { $this->stderr("[ERR] Unable to create ReflectionClass for class: $className loaded class is not from file: $file\n", Console::FG_RED); return false; } if (!$ref->isSubclassOf('yii\base\Object') && $className != 'yii\base\Object') { $this->stderr("[INFO] Skipping class $className as it is not a subclass of yii\\base\\Object.\n", Console::FG_BLUE, Console::BOLD); return false; } if ($ref->isSubclassOf('yii\db\BaseActiveRecord')) { $this->stderr("[INFO] Skipping class $className as it is an ActiveRecord class, property handling is not supported yet.\n", Console::FG_BLUE, Console::BOLD); return false; } $oldDoc = $ref->getDocComment(); $newDoc = $this->cleanDocComment($this->updateDocComment($oldDoc, $propertyDoc)); $seenSince = false; $seenAuthor = false; // TODO move these checks to different action $lines = explode("\n", $newDoc); $firstLine = trim($lines[1]); if ($firstLine === '*' || strncmp($firstLine, '* @', 3) === 0) { $this->stderr("[WARN] Class $className has no short description.\n", Console::FG_YELLOW, Console::BOLD); } foreach ($lines as $line) { $line = trim($line); if (strncmp($line, '* @since ', 9) === 0) { $seenSince = true; } elseif (strncmp($line, '* @author ', 10) === 0) { $seenAuthor = true; } } if (!$this->skipFrameworkRequirements) { if (!$seenSince) { $this->stderr("[ERR] No @since found in class doc in file: $file\n", Console::FG_RED); } if (!$seenAuthor) { $this->stderr("[ERR] No @author found in class doc in file: $file\n", Console::FG_RED); } } if (trim($oldDoc) != trim($newDoc)) { $fileContent = explode("\n", file_get_contents($file)); $start = $ref->getStartLine() - 2; $docStart = $start - count(explode("\n", $oldDoc)) + 1; $newFileContent = []; $n = count($fileContent); for ($i = 0; $i < $n; $i++) { if ($i > $start || $i < $docStart) { $newFileContent[] = $fileContent[$i]; } else { $newFileContent[] = trim($newDoc); $i = $start; } } file_put_contents($file, implode("\n", $newFileContent)); return true; } return false; } /** * remove multi empty lines and trim trailing whitespace * * @param $doc * @return string */ protected function cleanDocComment($doc) { $lines = explode("\n", $doc); $n = count($lines); for ($i = 0; $i < $n; $i++) { $lines[$i] = rtrim($lines[$i]); if (trim($lines[$i]) == '*' && trim($lines[$i + 1]) == '*') { unset($lines[$i]); } } return implode("\n", $lines); } /** * Replace property annotations in doc comment * @param $doc * @param $properties * @return string */ protected function updateDocComment($doc, $properties) { $lines = explode("\n", $doc); $propertyPart = false; $propertyPosition = false; foreach ($lines as $i => $line) { $line = trim($line); if (strncmp($line, '* @property ', 12) === 0) { $propertyPart = true; } elseif ($propertyPart && $line == '*') { $propertyPosition = $i; $propertyPart = false; } if (strncmp($line, '* @author ', 10) === 0 && $propertyPosition === false) { $propertyPosition = $i - 1; $propertyPart = false; } if ($propertyPart) { unset($lines[$i]); } } // if no properties or other tags where present add properties at the end if ($propertyPosition === false) { $propertyPosition = count($lines) - 2; } $finalDoc = ''; foreach ($lines as $i => $line) { $finalDoc .= $line . "\n"; if ($i == $propertyPosition) { $finalDoc .= $properties; } } return $finalDoc; } protected function generateClassPropertyDocs($fileName) { $phpdoc = ""; $file = str_replace("\r", "", str_replace("\t", " ", file_get_contents($fileName, true))); $ns = $this->match('#\nnamespace (?[\w\\\\]+);\n#', $file); $namespace = reset($ns); $namespace = $namespace['name']; $classes = $this->match('#\n(?:abstract )?class (?\w+)( extends .+)?( implements .+)?\n\{(?.*)\n\}(\n|$)#', $file); if (count($classes) > 1) { $this->stderr("[ERR] There should be only one class in a file: $fileName\n", Console::FG_RED); return false; } if (count($classes) < 1) { $interfaces = $this->match('#\ninterface (?\w+)( extends .+)?\n\{(?.*)\n\}(\n|$)#', $file); if (count($interfaces) == 1) { return false; } elseif (count($interfaces) > 1) { $this->stderr("[ERR] There should be only one interface in a file: $fileName\n", Console::FG_RED); } else { $traits = $this->match('#\ntrait (?\w+)\n\{(?.*)\n\}(\n|$)#', $file); if (count($traits) == 1) { return false; } elseif (count($traits) > 1) { $this->stderr("[ERR] There should be only one class/trait/interface in a file: $fileName\n", Console::FG_RED); } else { $this->stderr("[ERR] No class in file: $fileName\n", Console::FG_RED); } } return false; } $className = null; foreach ($classes as &$class) { $className = $namespace . '\\' . $class['name']; $gets = $this->match( '#\* @return (?[\w\\|\\\\\\[\\]]+)(?: (?(?:(?!\*/|\* @).)+?)(?:(?!\*/).)+|[\s\n]*)\*/' . '[\s\n]{2,}public function (?get)(?\w+)\((?:,? ?\$\w+ ?= ?[^,]+)*\)#', $class['content'], true); $sets = $this->match( '#\* @param (?[\w\\|\\\\\\[\\]]+) \$\w+(?: (?(?:(?!\*/|\* @).)+?)(?:(?!\*/).)+|[\s\n]*)\*/' . '[\s\n]{2,}public function (?set)(?\w+)\(\$\w+(?:, ?\$\w+ ?= ?[^,]+)*\)#', $class['content'], true); // check for @property annotations in getter and setter $properties = $this->match( '#\* @(?property) (?[\w\\|\\\\\\[\\]]+)(?: (?(?:(?!\*/|\* @).)+?)(?:(?!\*/).)+|[\s\n]*)\*/' . '[\s\n]{2,}public function [g|s]et(?\w+)\(((?:,? ?\$\w+ ?= ?[^,]+)*|\$\w+(?:, ?\$\w+ ?= ?[^,]+)*)\)#', $class['content']); $acrs = array_merge($properties, $gets, $sets); $props = []; foreach ($acrs as &$acr) { $acr['name'] = lcfirst($acr['name']); $acr['comment'] = trim(preg_replace('#(^|\n)\s+\*\s?#', '$1 * ', $acr['comment'])); $props[$acr['name']][$acr['kind']] = [ 'type' => $acr['type'], 'comment' => $this->fixSentence($acr['comment']), ]; } ksort($props); if (count($props) > 0) { $phpdoc .= " *\n"; foreach ($props as $propName => &$prop) { $docline = ' * @'; $docline .= 'property'; // Do not use property-read and property-write as few IDEs support complex syntax. $note = ''; if (isset($prop['get']) && isset($prop['set'])) { if ($prop['get']['type'] != $prop['set']['type']) { $note = ' Note that the type of this property differs in getter and setter.' . ' See [[get' . ucfirst($propName) . '()]] and [[set' . ucfirst($propName) . '()]] for details.'; } } elseif (isset($prop['get'])) { // check if parent class has setter defined $c = $className; $parentSetter = false; while ($parent = get_parent_class($c)) { if (method_exists($parent, 'set' . ucfirst($propName))) { $parentSetter = true; break; } $c = $parent; } if (!$parentSetter) { $note = ' This property is read-only.'; // $docline .= '-read'; } } elseif (isset($prop['set'])) { // check if parent class has getter defined $c = $className; $parentGetter = false; while ($parent = get_parent_class($c)) { if (method_exists($parent, 'set' . ucfirst($propName))) { $parentGetter = true; break; } $c = $parent; } if (!$parentGetter) { $note = ' This property is write-only.'; // $docline .= '-write'; } } else { continue; } $docline .= ' ' . $this->getPropParam($prop, 'type') . " $$propName "; $comment = explode("\n", $this->getPropParam($prop, 'comment') . $note); foreach ($comment as &$cline) { $cline = ltrim($cline, '* '); } $docline = wordwrap($docline . implode(' ', $comment), 110, "\n * ") . "\n"; $phpdoc .= $docline; } $phpdoc .= " *\n"; } } return [$className, $phpdoc]; } protected function match($pattern, $subject, $split = false) { $sets = []; // split subject by double newlines because regex sometimes has problems with matching // in the complete set of methods // example: yii\di\ServiceLocator setComponents() is not recognized in the whole but in // a part of the class. $parts = $split ? explode("\n\n", $subject) : [$subject]; foreach($parts as $part) { preg_match_all($pattern . 'suU', $part, $matches, PREG_SET_ORDER); foreach ($matches as &$set) { foreach ($set as $i => $match) if (is_numeric($i) /*&& $i != 0*/) unset($set[$i]); $sets[] = $set; } } return $sets; } protected function fixSentence($str) { // TODO fix word wrap if ($str == '') return ''; return strtoupper(substr($str, 0, 1)) . substr($str, 1) . ($str[strlen($str) - 1] != '.' ? '.' : ''); } protected function getPropParam($prop, $param) { return isset($prop['property']) ? $prop['property'][$param] : (isset($prop['get']) ? $prop['get'][$param] : $prop['set'][$param]); } }