<?php /** * @link http://www.yiiframework.com/ * @copyright Copyright (c) 2008 Yii Software LLC * @license http://www.yiiframework.com/license/ */ namespace yii\apidoc\models; use phpDocumentor\Reflection\DocBlock\Tag\ParamTag; use phpDocumentor\Reflection\DocBlock\Tag\PropertyTag; use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag; use phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag; /** * Represents API documentation information for a `function`. * * @author Carsten Brandt <mail@cebe.cc> * @since 2.0 */ class FunctionDoc extends BaseDoc { /** * @var ParamDoc[] */ public $params = []; public $exceptions = []; public $return; public $returnType; public $returnTypes; public $isReturnByReference; /** * @param \phpDocumentor\Reflection\FunctionReflector $reflector * @param Context $context * @param array $config */ public function __construct($reflector = null, $context = null, $config = []) { parent::__construct($reflector, $context, $config); if ($reflector === null) { return; } $this->isReturnByReference = $reflector->isByRef(); foreach ($reflector->getArguments() as $arg) { $arg = new ParamDoc($arg, $context, ['sourceFile' => $this->sourceFile]); $this->params[$arg->name] = $arg; } foreach ($this->tags as $i => $tag) { if ($tag instanceof ThrowsTag) { $this->exceptions[$tag->getType()] = $tag->getDescription(); unset($this->tags[$i]); } elseif ($tag instanceof PropertyTag) { // ignore property tag } elseif ($tag instanceof ParamTag) { $paramName = $tag->getVariableName(); if (!isset($this->params[$paramName]) && $context !== null) { $context->errors[] = [ 'line' => $this->startLine, 'file' => $this->sourceFile, 'message' => "Undefined parameter documented: $paramName in {$this->name}().", ]; continue; } $this->params[$paramName]->description = ucfirst($tag->getDescription()); $this->params[$paramName]->type = $tag->getType(); $this->params[$paramName]->types = $tag->getTypes(); unset($this->tags[$i]); } elseif ($tag instanceof ReturnTag) { $this->returnType = $tag->getType(); $this->returnTypes = $tag->getTypes(); $this->return = ucfirst($tag->getDescription()); unset($this->tags[$i]); } } } }