Class yii\apidoc\models\TypeDoc

Inheritanceyii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\Object
Implementsyii\base\Configurable
Subclassesyii\apidoc\models\ClassDoc, yii\apidoc\models\InterfaceDoc, yii\apidoc\models\TraitDoc
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/TypeDoc.php

Base class for API documentation information for classes, interfaces and traits.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$authors yii\apidoc\models\TypeDoc
$deprecatedReason yii\apidoc\models\BaseDoc
$deprecatedSince yii\apidoc\models\BaseDoc
$description yii\apidoc\models\BaseDoc
$endLine yii\apidoc\models\BaseDoc
$methods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$name yii\apidoc\models\BaseDoc
$namespace yii\apidoc\models\TypeDoc
$nativeMethods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$nativeProperties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$phpDocContext \phpDocumentor\Reflection\DocBlock\Context yii\apidoc\models\BaseDoc
$properties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$protectedMethods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$protectedProperties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$publicMethods yii\apidoc\models\MethodDoc[] yii\apidoc\models\TypeDoc
$publicProperties yii\apidoc\models\PropertyDoc[] yii\apidoc\models\TypeDoc
$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

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__construct() yii\apidoc\models\TypeDoc
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
extractFirstSentence() Extracts first sentence out of text yii\apidoc\models\BaseDoc
findSubject() Finds subject (method or property) by name yii\apidoc\models\TypeDoc
getNativeMethods() yii\apidoc\models\TypeDoc
getNativeProperties() yii\apidoc\models\TypeDoc
getProtectedMethods() yii\apidoc\models\TypeDoc
getProtectedProperties() yii\apidoc\models\TypeDoc
getPublicMethods() yii\apidoc\models\TypeDoc
getPublicProperties() yii\apidoc\models\TypeDoc
hasMethod() Returns a value indicating whether a method is defined. yii\base\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
hasTag() Checks if doc has tag of a given name yii\apidoc\models\BaseDoc
init() Initializes the object. yii\base\Object
removeTag() Removes tag of a given name yii\apidoc\models\BaseDoc

Property Details

$authors public property
$authors = []
$methods public property
yii\apidoc\models\MethodDoc[] $methods = []
$namespace public property
$namespace = null
$nativeMethods public read-only property
yii\apidoc\models\MethodDoc[] getNativeMethods( )
$nativeProperties public read-only property
yii\apidoc\models\PropertyDoc[] getNativeProperties( )
$properties public property
yii\apidoc\models\PropertyDoc[] $properties = []
$protectedMethods public read-only property
yii\apidoc\models\MethodDoc[] getProtectedMethods( )
$protectedProperties public read-only property
yii\apidoc\models\PropertyDoc[] getProtectedProperties( )
$publicMethods public read-only property
yii\apidoc\models\MethodDoc[] getPublicMethods( )
$publicProperties public read-only property
yii\apidoc\models\PropertyDoc[] getPublicProperties( )

Method Details

__construct() public method

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

Finds subject (method or property) by name

If there is a property with the same as a method, the method will be returned if the name is not stated explicitly by prefixing with $.

Example for method attributes() and property $attributes which both may exist:

  • $subjectName = '$attributes' finds a property or nothing.
  • $subjectName = 'attributes()' finds a method or nothing.
  • $subjectName = 'attributes' finds the method if it exists, if not it will find the property.
null|yii\apidoc\models\MethodDoc|yii\apidoc\models\PropertyDoc findSubject( $subjectName )
$subjectName
getNativeMethods() public method

yii\apidoc\models\MethodDoc[] getNativeMethods( )
getNativeProperties() public method

yii\apidoc\models\PropertyDoc[] getNativeProperties( )
getProtectedMethods() public method

yii\apidoc\models\MethodDoc[] getProtectedMethods( )
getProtectedProperties() public method

yii\apidoc\models\PropertyDoc[] getProtectedProperties( )
getPublicMethods() public method

yii\apidoc\models\MethodDoc[] getPublicMethods( )
getPublicProperties() public method

yii\apidoc\models\PropertyDoc[] getPublicProperties( )