Class yii\apidoc\models\MethodDoc

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\MethodDoc » yii\apidoc\models\FunctionDoc » yii\apidoc\models\BaseDoc » yii\base\Object
Available since version2.0

Represents API documentation information for a method.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$definedBy yii\apidoc\models\MethodDoc
$deprecatedReason yii\apidoc\models\BaseDoc
$deprecatedSince yii\apidoc\models\BaseDoc
$description yii\apidoc\models\BaseDoc
$endLine yii\apidoc\models\BaseDoc
$exceptions yii\apidoc\models\FunctionDoc
$isAbstract yii\apidoc\models\MethodDoc
$isFinal yii\apidoc\models\MethodDoc
$isReturnByReference yii\apidoc\models\FunctionDoc
$isStatic yii\apidoc\models\MethodDoc
$name yii\apidoc\models\BaseDoc
$params yii\apidoc\models\ParamDoc[] yii\apidoc\models\FunctionDoc
$phpDocContext \phpDocumentor\Reflection\DocBlock\Context yii\apidoc\models\BaseDoc
$return yii\apidoc\models\FunctionDoc
$returnType yii\apidoc\models\FunctionDoc
$returnTypes yii\apidoc\models\FunctionDoc
$shortDescription yii\apidoc\models\BaseDoc
$since yii\apidoc\models\BaseDoc
$sourceFile yii\apidoc\models\BaseDoc
$startLine yii\apidoc\models\BaseDoc
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc
$visibility yii\apidoc\models\MethodDoc

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() yii\apidoc\models\MethodDoc
extractFirstSentence() Extracts first sentence out of text yii\apidoc\models\BaseDoc
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
hasTag() Checks if doc has tag of a given name yii\apidoc\models\BaseDoc
removeTag() Removes tag of a given name yii\apidoc\models\BaseDoc

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
mbUcFirst() Multibyte version of ucfirst() yii\apidoc\models\BaseDoc

Property Details

$definedBy public property
public $definedBy = null
$isAbstract public property
public $isAbstract = null
$isFinal public property
public $isFinal = null
$isStatic public property
public $isStatic = null
$visibility public property
public $visibility = null

Method Details

__construct() public method

public void __construct ( $reflector = null, $context = null, $config = [] )
$reflector \phpDocumentor\Reflection\ClassReflector\MethodReflector
$context yii\apidoc\models\Context
$config array