Class yii\apidoc\models\ClassDoc
Inheritance | yii\apidoc\models\ClassDoc » yii\apidoc\models\TypeDoc » yii\apidoc\models\BaseDoc » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/ClassDoc.php |
Represents API documentation information for a class
.
Public Properties
Public Methods
Protected 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
Method Details
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()");
}
public void __construct ( $reflector = null, $context = null, $config = [] ) | ||
$reflector | \phpDocumentor\Reflection\Php\Class_ | |
$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->parentClass = ltrim($reflector->getParent(), '\\');
if (empty($this->parentClass)) {
$this->parentClass = null;
}
$this->isAbstract = $reflector->isAbstract();
$this->isFinal = $reflector->isFinal();
foreach ($reflector->getInterfaces() as $interface) {
$this->interfaces[] = ltrim($interface, '\\');
}
foreach ($reflector->getUsedTraits() as $trait) {
$this->traits[] = ltrim($trait, '\\');
}
foreach ($reflector->getConstants() as $constantReflector) {
$docBlock = $constantReflector->getDocBlock();
if ($docBlock !== null && count($docBlock->getTagsByName('event')) > 0) {
$event = new EventDoc($constantReflector, null, null, $docBlock);
$event->definedBy = $this->name;
$this->events[$event->name] = $event;
} else {
$constant = new ConstDoc($constantReflector);
$constant->definedBy = $this->name;
$this->constants[$constant->name] = $constant;
}
}
}
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);
}
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.
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;
}
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);
}
}
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.
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);
}
}
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);
}
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);
}
::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();
}
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 |
protected static function convertInlineLinks($content)
{
if (!$content) {
return $content;
}
return preg_replace('/{@link\s*([\w\d\\\\():$]+(?:\|[^}]*)?)}/', "[[$1]]", $content);
}
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;
}
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 (($subject = parent::findSubject($subjectName)) !== null) {
return $subject;
}
foreach ($this->events as $name => $event) {
if ($subjectName == $name) {
return $event;
}
}
foreach ($this->constants as $name => $constant) {
if ($subjectName == $name) {
return $constant;
}
}
return null;
}
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, |
---|
public function getFirstTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
return $this->tags[$i];
}
}
return null;
}
public yii\apidoc\models\EventDoc[] getNativeEvents ( ) |
public function getNativeEvents()
{
$events = [];
foreach ($this->events as $name => $event) {
if ($event->definedBy != $this->name) {
continue;
}
$events[$name] = $event;
}
return $events;
}
Defined in: yii\apidoc\models\TypeDoc::getNativeMethods()
public yii\apidoc\models\MethodDoc[] getNativeMethods ( ) |
public function getNativeMethods()
{
return $this->getFilteredMethods(null, $this->name);
}
Defined in: yii\apidoc\models\TypeDoc::getNativeProperties()
public yii\apidoc\models\PropertyDoc[] getNativeProperties ( ) |
public function getNativeProperties()
{
return $this->getFilteredProperties(null, $this->name);
}
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];
}
Defined in: yii\apidoc\models\TypeDoc::getProtectedMethods()
public yii\apidoc\models\MethodDoc[] getProtectedMethods ( ) |
public function getProtectedMethods()
{
return $this->getFilteredMethods('protected');
}
public yii\apidoc\models\PropertyDoc[] getProtectedProperties ( ) |
public function getProtectedProperties()
{
return $this->getFilteredProperties('protected');
}
Defined in: yii\apidoc\models\TypeDoc::getPublicMethods()
public yii\apidoc\models\MethodDoc[] getPublicMethods ( ) |
public function getPublicMethods()
{
return $this->getFilteredMethods('public');
}
Defined in: yii\apidoc\models\TypeDoc::getPublicProperties()
public yii\apidoc\models\PropertyDoc[] getPublicProperties ( ) |
public function getPublicProperties()
{
return $this->getFilteredProperties('public');
}
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);
}
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);
}
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;
}
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()
{
}
Defined in: yii\apidoc\models\TypeDoc::initProperties()
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;
}
}
}
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');
}
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]);
}
}
}
Defined in: yii\apidoc\models\BaseDoc::splitTypes()
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];
}