Class yii\apidoc\models\BaseDoc

All Classes | Properties | Methods

Inheritance	yii\apidoc\models\BaseDoc » yii\base\Object
Subclasses	yii\apidoc\models\ClassDoc, yii\apidoc\models\ConstDoc, yii\apidoc\models\EventDoc, yii\apidoc\models\FunctionDoc, yii\apidoc\models\InterfaceDoc, yii\apidoc\models\MethodDoc, yii\apidoc\models\PropertyDoc, yii\apidoc\models\TraitDoc, yii\apidoc\models\TypeDoc
Available since version	2.0

Base class for API documentation information.

Public Properties

Hide inherited properties

Property	Type	Defined By
$deprecatedReason		yii\apidoc\models\BaseDoc
$deprecatedSince		yii\apidoc\models\BaseDoc
$description		yii\apidoc\models\BaseDoc
$endLine		yii\apidoc\models\BaseDoc
$name		yii\apidoc\models\BaseDoc
$phpDocContext	\phpDocumentor\Reflection\DocBlock\Context	yii\apidoc\models\BaseDoc
$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
__construct()		yii\apidoc\models\BaseDoc
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

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

Property Details

$deprecatedReason public property

public $deprecatedReason = null

$deprecatedSince public property

public $deprecatedSince = null

$description public property

public $description = null

$endLine public property

public $endLine = null

$name public property

public $name = null

$phpDocContext public property

public \phpDocumentor\Reflection\DocBlock\Context $phpDocContext = null

$shortDescription public property

public $shortDescription = null

$since public property

public $since = null

$sourceFile public property

public $sourceFile = null

$startLine public property

public $startLine = null

$tags public property

public \phpDocumentor\Reflection\DocBlock\Tag[] $tags = []

Method Details

__construct() public method

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

extractFirstSentence() public static method

Extracts first sentence out of text

public static string extractFirstSentence ( $text )
$text	string

getFirstTag() public method (available since version 2.0.5)

Get the first tag of a given name

public \phpDocumentor\Reflection\DocBlock\Tag getFirstTag ( $name )
$name	string

hasTag() public method

Checks if doc has tag of a given name

public boolean hasTag ( $name )
$name	string	Tag name
return	boolean	If doc has tag of a given name

mbUcFirst() protected static method (available since version 2.0.6)

Multibyte version of ucfirst()

protected static void mbUcFirst ( $string )
$string

removeTag() public method

Removes tag of a given name

public void removeTag ( $name )
$name	string