# Class yii\apidoc\models\TypeDoc

Inheritance | yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Implements | yii\base\Configurable
Subclasses | yii\apidoc\models\ClassDoc, yii\apidoc\models\InterfaceDoc, yii\apidoc\models\TraitDoc
Available since version | 2.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

Property | Type | Description | Defined 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[] | This property is read-only. | yii\apidoc\models\TypeDoc
$nativeProperties | yii\apidoc\models\PropertyDoc[] | This property is read-only. | yii\apidoc\models\TypeDoc
$packageName | string|null |  | yii\apidoc\models\BaseDoc
$phpDocContext | \phpDocumentor\Reflection\DocBlock\Context |  | yii\apidoc\models\BaseDoc
$properties | yii\apidoc\models\PropertyDoc[] |  | yii\apidoc\models\TypeDoc
$protectedMethods | yii\apidoc\models\MethodDoc[] | This property is read-only. | yii\apidoc\models\TypeDoc
$protectedProperties | yii\apidoc\models\PropertyDoc[] | This property is read-only. | yii\apidoc\models\TypeDoc
$publicMethods | yii\apidoc\models\MethodDoc[] | This property is read-only. | yii\apidoc\models\TypeDoc
$publicProperties | yii\apidoc\models\PropertyDoc[] | This property is read-only. | 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

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\BaseObject
__construct() |  | yii\apidoc\models\TypeDoc
__get() | Returns the value of an object property. | yii\base\BaseObject
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject
__set() | Sets value of an object property. | yii\base\BaseObject
__unset() | Sets an object property to null. | yii\base\BaseObject
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
extractFirstSentence() | Extracts first sentence out of text | yii\apidoc\models\BaseDoc
findSubject() | Finds subject (method or property) by name | yii\apidoc\models\TypeDoc
getFirstTag() | Get the first tag of a given name | yii\apidoc\models\BaseDoc
getNativeMethods() |  | yii\apidoc\models\TypeDoc
getNativeProperties() |  | yii\apidoc\models\TypeDoc
getPackageName() | Returns the Composer package for this type, if it can be determined from $sourceFile. | yii\apidoc\models\BaseDoc
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\BaseObject
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject
hasTag() | Checks if doc has tag of a given name | yii\apidoc\models\BaseDoc
init() | Initializes the object. | yii\base\BaseObject
removeTag() | Removes tag of a given name | yii\apidoc\models\BaseDoc

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
mbUcFirst() | Multibyte version of ucfirst() | yii\apidoc\models\BaseDoc

## Property Details

$authors public property
public $authors = []
$methods public property
public yii\apidoc\models\MethodDoc[] $methods = []
$namespace public property
public $namespace = null
$nativeMethods public property

This property is read-only.

public yii\apidoc\models\MethodDoc[] $nativeMethods = null
$nativeProperties public property

This property is read-only.

public yii\apidoc\models\PropertyDoc[] $nativeProperties = null
$properties public property
public yii\apidoc\models\PropertyDoc[] $properties = []
$protectedMethods public property

This property is read-only.

public yii\apidoc\models\MethodDoc[] $protectedMethods = null
$protectedProperties public property

This property is read-only.

public yii\apidoc\models\PropertyDoc[] $protectedProperties = null
$publicMethods public property

This property is read-only.

public yii\apidoc\models\MethodDoc[] $publicMethods = null
$publicProperties public property

This property is read-only.

public yii\apidoc\models\PropertyDoc[] $publicProperties = null

## Method Details

__construct() public method

public 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.

public null|yii\apidoc\models\MethodDoc|yii\apidoc\models\PropertyDoc findSubject ( $subjectName )
$subjectName |  |

getNativeMethods() public method

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

getNativeProperties() public method

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

getProtectedMethods() public method

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

getProtectedProperties() public method

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

getPublicMethods() public method

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

getPublicProperties() public method

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