Class yii\apidoc\models\TraitDoc

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

Represents API documentation information for a trait.

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
$fullName 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
$packageName string|null yii\apidoc\models\BaseDoc
$phpDocContext \phpDocumentor\Reflection\Types\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 string|null Available since this version. yii\apidoc\models\BaseDoc
$sinceMap array A mapping where keys are versions and values are descriptions. yii\apidoc\models\BaseDoc
$sourceFile yii\apidoc\models\BaseDoc
$startLine yii\apidoc\models\BaseDoc
$tags \phpDocumentor\Reflection\DocBlock\Tag[] yii\apidoc\models\BaseDoc
$todos \phpDocumentor\Reflection\DocBlock\Tags\Generic[] yii\apidoc\models\BaseDoc
$traits yii\apidoc\models\TraitDoc
$usedBy yii\apidoc\models\TraitDoc

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\TraitDoc
__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
convertInlineLinks() Converts inline links to unified format. yii\apidoc\models\BaseDoc
initProperties() yii\apidoc\models\TypeDoc
mbUcFirst() Multibyte version of ucfirst() yii\apidoc\models\BaseDoc
splitTypes() yii\apidoc\models\BaseDoc

Property Details

Hide inherited properties

$traits public property
public $traits = []
$usedBy public property
public $usedBy = []

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__construct() public method

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

                public function __construct($reflector = null, $context = null, $config = [])
{
    parent::__construct($reflector, $context, $config);
    if ($reflector === null) {
        return;
    }
    foreach ($reflector->getUsedTraits() as $trait) {
        $this->traits[] = ltrim($trait, '\\');
    }
}

            
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set (not null).

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}

            
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}

            
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}

            
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}

            
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
convertInlineLinks() protected static method

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

Converts inline links to unified format.

See also yii\apidoc\helpers\ApiMarkdownTrait::parseApiLinks().

protected static string|null convertInlineLinks ( $content )
$content string|null

extractFirstSentence() public static method

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

Extracts first sentence out of text.

public static string extractFirstSentence ( $text, $prevText '' )
$text string
$prevText string

                public static function extractFirstSentence($text, $prevText = '')
{
    $text = str_replace(["\r\n", "\n"], ' ', $text);
    $length = mb_strlen($text, 'utf-8');
    if ($length > 4 && ($pos = mb_strpos($text, '. ', 4, 'utf-8')) !== false) {
        $sentence = mb_substr($text, 0, $pos + 1, 'utf-8');
        $prevText  .= $sentence;
        if ($length >= $pos + 2) {
            $abbrev = mb_substr($text, $pos - 3, 4, 'utf-8');
            // do not break sentence after abbreviation
            if ($abbrev === 'e.g.' ||
                $abbrev === 'i.e.' ||
                mb_substr_count($prevText, '`', 'utf-8') % 2 === 1
            ) {
                $sentence .= static::extractFirstSentence(
                    mb_substr($text, $pos + 1, $length, 'utf-8'),
                    $prevText
                );
            }
        }
        return $sentence;
    }
    return $text;
}

            
findSubject() public method

Defined in: yii\apidoc\models\TypeDoc::findSubject()

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

                public function findSubject($subjectName)
{
    if (empty($subjectName)) {
        return null;
    }
    $subjectName = ltrim(str_replace($this->namespace, '', $subjectName), '\\');
    if ($subjectName[0] !== '$') {
        foreach ($this->methods as $name => $method) {
            if (rtrim($subjectName, '()') == $name) {
                return $method;
            }
        }
    }
    if (substr_compare($subjectName, '()', -2, 2) === 0) {
        return null;
    }
    if ($this->properties === null) {
        return null;
    }
    foreach ($this->properties as $name => $property) {
        if (ltrim($subjectName, '$') == ltrim($name, '$')) {
            return $property;
        }
    }
    return null;
}

            
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;
}

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

                public function getNativeMethods()
{
    return $this->getFilteredMethods(null, $this->name);
}

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

                public function getNativeProperties()
{
    return $this->getFilteredProperties(null, $this->name);
}

            
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];
}

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

                public function getProtectedMethods()
{
    return $this->getFilteredMethods('protected');
}

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

                public function getProtectedProperties()
{
    return $this->getFilteredProperties('protected');
}

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

                public function getPublicMethods()
{
    return $this->getFilteredMethods('public');
}

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

                public function getPublicProperties()
{
    return $this->getFilteredProperties('public');
}

            
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name

return boolean

Whether the method is defined

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

            
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}

            
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;
}

            
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}

            
initProperties() protected method
protected void initProperties ( $reflector, $context )
$reflector \phpDocumentor\Reflection\Php\Class_
$context yii\apidoc\models\Context

                protected function initProperties($reflector, $context)
{
    foreach ($reflector->getProperties() as $propertyReflector) {
        if ($propertyReflector->getDocBlock() && $propertyReflector->getDocBlock()->hasTag('internal')) {
            continue;
        }
        if ((string) $propertyReflector->getVisibility() !== 'private') {
            $property = new PropertyDoc($propertyReflector, $context, ['sourceFile' => $this->sourceFile]);
            $property->definedBy = $this->name;
            $this->properties[$property->name] = $property;
        }
    }
}

            
mbUcFirst() protected static method (available since version 2.0.6)
Deprecated Use \yii\helpers\StringHelper::mb_ucfirst() instead

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]);
        }
    }
}

            
splitTypes() protected method
protected string[] splitTypes ( $aggregatedType )
$aggregatedType \phpDocumentor\Reflection\Php\Factory\Type|null

                protected function splitTypes($aggregatedType)
{
    if ($aggregatedType === null) {
        return [];
    }
    $types = [];
    foreach ($aggregatedType as $type) {
        $types[] = (string) $type;
    }
    return $types ?: [(string) $aggregatedType];
}