Class yii\apidoc\models\InterfaceDoc
| Inheritance | yii\ |
|---|---|
| Available since extension's version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/InterfaceDoc.php |
Represents API documentation information for an interface.
Public Properties
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | yii\ |
|
| extractFirstSentence() | Extracts first sentence out of text | yii\ |
| findSubject() | Finds subject (method or property) by name | yii\ |
| getFirstTag() | Get the first tag of a given name | yii\ |
| getNativeMethods() | yii\ |
|
| getNativeProperties() | yii\ |
|
| getPackageName() | Returns the Composer package for this type, if it can be determined from $sourceFile. | yii\ |
| getProtectedMethods() | yii\ |
|
| getProtectedProperties() | yii\ |
|
| getPublicMethods() | yii\ |
|
| getPublicProperties() | yii\ |
|
| hasTag() | Checks if doc has tag of a given name | yii\ |
| removeTag() | Removes tag of a given name | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| mbUcFirst() | Multibyte version of ucfirst() | yii\ |
Property Details
Method Details
| public mixed __construct ( \ | ||
| $reflector | \ |
|
| $context | yii\ |
|
| $config | array | |
public function __construct($reflector = null, $context = null, $config = [])
{
parent::__construct($reflector, $context, $config);
if ($reflector === null) {
return;
}
foreach ($reflector->getParentInterfaces() as $interface) {
$this->parentInterfaces[] = ltrim($interface, '\\');
}
foreach ($this->methods as $method) {
$method->isAbstract = true;
}
// interface can not have properties
$this->properties = [];
}
Defined in:
yii\
Extracts first sentence out of text
| public static string extractFirstSentence ( string $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;
}
Defined in:
yii\
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\ | ||
| $subjectName | mixed | |
public function findSubject($subjectName)
{
if (empty($subjectName)) {
return null;
}
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;
}
Defined in:
yii\
Get the first tag of a given name
| public \ | ||
| $name | string |
Tag name. |
| return | \ |
Tag instance, |
|---|---|---|
public function getFirstTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
return $this->tags[$i];
}
}
return null;
}
Defined in:
yii\
| public yii\ |
public function getNativeMethods()
{
return $this->getFilteredMethods(null, $this->name);
}
Defined in:
yii\
| public yii\ |
public function getNativeProperties()
{
return $this->getFilteredProperties(null, $this->name);
}
Defined in:
yii\
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\
| public yii\ |
public function getProtectedMethods()
{
return $this->getFilteredMethods('protected');
}
| public yii\ |
public function getProtectedProperties()
{
return $this->getFilteredProperties('protected');
}
Defined in:
yii\
| public yii\ |
public function getPublicMethods()
{
return $this->getFilteredMethods('public');
}
Defined in:
yii\
| public yii\ |
public function getPublicProperties()
{
return $this->getFilteredProperties('public');
}
Defined in:
yii\
Checks if doc has tag of a given name
| public boolean hasTag ( string $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\
Multibyte version of ucfirst()
| protected static mixed mbUcFirst ( mixed $string ) | ||
| $string | mixed | |
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\
Removes tag of a given name
| public mixed removeTag ( string $name ) | ||
| $name | string | |
public function removeTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
unset($this->tags[$i]);
}
}
}