Class yii\apidoc\models\PropertyDoc

All Classes | Properties | Methods
Inheritanceyii\apidoc\models\PropertyDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/models/PropertyDoc.php

Represents API documentation information for a property.

Public Properties

Hide inherited properties

Property Type Description Defined By
$defaultValue yii\apidoc\models\PropertyDoc
$definedBy yii\apidoc\models\PropertyDoc
$deprecatedReason yii\apidoc\models\BaseDoc
$deprecatedSince yii\apidoc\models\BaseDoc
$description yii\apidoc\models\BaseDoc
$endLine yii\apidoc\models\BaseDoc
$getter yii\apidoc\models\PropertyDoc
$isReadOnly boolean If property is read only. yii\apidoc\models\PropertyDoc
$isStatic yii\apidoc\models\PropertyDoc
$isWriteOnly boolean If property is write only. yii\apidoc\models\PropertyDoc
$name yii\apidoc\models\BaseDoc
$phpDocContext \phpDocumentor\Reflection\DocBlock\Context yii\apidoc\models\BaseDoc
$setter yii\apidoc\models\PropertyDoc
$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
$type yii\apidoc\models\PropertyDoc
$types yii\apidoc\models\PropertyDoc
$visibility yii\apidoc\models\PropertyDoc

Public Methods

Hide inherited methods

Method Description Defined By
__construct() yii\apidoc\models\PropertyDoc
extractFirstSentence() Extracts first sentence out of text yii\apidoc\models\BaseDoc
getFirstTag() Get the first tag of a given name yii\apidoc\models\BaseDoc
getIsReadOnly() yii\apidoc\models\PropertyDoc
getIsWriteOnly() yii\apidoc\models\PropertyDoc
getPackageName() Returns the Composer package for this type, if it can be determined from $sourceFile. 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

Hide inherited properties

$defaultValue public property
public $defaultValue = null
$definedBy public property
public $definedBy = null
$getter public property
public $getter = null
$isReadOnly public property

If property is read only. This property is read-only.

public boolean $isReadOnly = null
$isStatic public property
public $isStatic = null
$isWriteOnly public property

If property is write only. This property is read-only.

public boolean $isWriteOnly = null
$setter public property
public $setter = null
$type public property
public $type = null
$types public property
public $types = null
$visibility public property
public $visibility = null

Method Details

Hide inherited methods

__construct() public method

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

                public function __construct($reflector = null, $context = null, $config = [])
{
    parent::__construct($reflector, $context, $config);
    if ($reflector === null) {
        return;
    }
    $this->visibility = $reflector->getVisibility();
    $this->isStatic = $reflector->isStatic();
    // bypass $reflector->getDefault() for short array syntax
    if ($reflector->getNode()->default) {
        $this->defaultValue = PrettyPrinter::getRepresentationOfValue($reflector->getNode()->default);
    }
    $hasInheritdoc = false;
    foreach ($this->tags as $tag) {
        if ($tag->getName() === 'inheritdoc') {
            $hasInheritdoc = true;
        }
        if ($tag instanceof VarTag) {
            $this->type = $tag->getType();
            $this->types = $tag->getTypes();
            $this->description = static::mbUcFirst($tag->getDescription());
            $this->shortDescription = BaseDoc::extractFirstSentence($this->description);
        }
    }
    if (empty($this->shortDescription) && $context !== null && !$hasInheritdoc) {
        $context->warnings[] = [
            'line' => $this->startLine,
            'file' => $this->sourceFile,
            'message' => "No short description for element '{$this->name}'",
        ];
    }
}
extractFirstSentence() public static method

Defined in: yii\apidoc\models\BaseDoc::extractFirstSentence()

Extracts first sentence out of text

public static string extractFirstSentence ( $text )
$text string 

                public static function extractFirstSentence($text)
{
    if (mb_strlen($text, 'utf-8') > 4 && ($pos = mb_strpos($text, '.', 4, 'utf-8')) !== false) {
        $sentence = mb_substr($text, 0, $pos + 1, 'utf-8');
        if (mb_strlen($text, 'utf-8') >= $pos + 3) {
            $abbrev = mb_substr($text, $pos - 1, 4, 'utf-8');
            if ($abbrev === 'e.g.' || $abbrev === 'i.e.') { // do not break sentence after abbreviation
                $sentence .= static::extractFirstSentence(mb_substr($text, $pos + 1, mb_strlen($text, 'utf-8'), 'utf-8'));
            }
        }
        return $sentence;
    }
    return $text;
}
getFirstTag() public method (available since version 2.0.5)

Defined in: yii\apidoc\models\BaseDoc::getFirstTag()

Get the first tag of a given name

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

Tag name.
return \phpDocumentor\Reflection\DocBlock\Tag|null

Tag instance, null if not found.

 

                public function getFirstTag($name)
{
    foreach ($this->tags as $i => $tag) {
        if (strtolower($tag->getName()) == $name) {
            return $this->tags[$i];
        }
    }
    return null;
}
getIsReadOnly() public method

public boolean getIsReadOnly ( )
return boolean

If property is read only

 

                public function getIsReadOnly()
{
    return $this->getter !== null && $this->setter === null;
}
getIsWriteOnly() public method

public boolean getIsWriteOnly ( )
return boolean

If property is write only

 

                public function getIsWriteOnly()
{
    return $this->getter === null && $this->setter !== null;
}
getPackageName() public method (available since version 2.1.3)

Defined in: yii\apidoc\models\BaseDoc::getPackageName()

Returns the Composer package for this type, if it can be determined from $sourceFile.

public string|null getPackageName ( )

                public function getPackageName()
{
    if (!$this->sourceFile || !preg_match('/\/vendor\/([\w\-]+\/[\w\-]+)/', $this->sourceFile, $match)) {
        return null;
    }
    return $match[1];
}
hasTag() public method

Defined in: yii\apidoc\models\BaseDoc::hasTag()

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

 

                public function hasTag($name)
{
    foreach ($this->tags as $tag) {
        if (strtolower($tag->getName()) == $name) {
            return true;
        }
    }
    return false;
}
mbUcFirst() protected static method (available since version 2.0.6)

Defined in: yii\apidoc\models\BaseDoc::mbUcFirst()

Multibyte version of ucfirst()

protected static void mbUcFirst ( $string )
$string 

                protected static function mbUcFirst($string)
{
    $firstChar = mb_strtoupper(mb_substr($string, 0, 1, 'utf-8'), 'utf-8');
    return $firstChar . mb_substr($string, 1, mb_strlen($string, 'utf-8'), 'utf-8');
}
removeTag() public method

Defined in: yii\apidoc\models\BaseDoc::removeTag()

Removes tag of a given name

public void removeTag ( $name )
$name string 

                public function removeTag($name)
{
    foreach ($this->tags as $i => $tag) {
        if (strtolower($tag->getName()) == $name) {
            unset($this->tags[$i]);
        }
    }
}