Class yii\apidoc\models\InterfaceDoc

All Classes | Properties | Methods

Inheritance	yii\apidoc\models\InterfaceDoc » 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/InterfaceDoc.php

Represents API documentation information for an interface.

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
$implementedBy			yii\apidoc\models\InterfaceDoc
$methods	yii\apidoc\models\MethodDoc[]		yii\apidoc\models\TypeDoc
$name			yii\apidoc\models\BaseDoc
$namespace			yii\apidoc\models\TypeDoc
$nativeMethods	yii\apidoc\models\MethodDoc[]	This property is read-only.	yii\apidoc\models\TypeDoc
$nativeProperties	yii\apidoc\models\PropertyDoc[]	This property is read-only.	yii\apidoc\models\TypeDoc
$packageName	string\|null		yii\apidoc\models\BaseDoc
$parentInterfaces			yii\apidoc\models\InterfaceDoc
$phpDocContext	\phpDocumentor\Reflection\DocBlock\Context		yii\apidoc\models\BaseDoc
$properties	yii\apidoc\models\PropertyDoc[]		yii\apidoc\models\TypeDoc
$protectedMethods	yii\apidoc\models\MethodDoc[]	This property is read-only.	yii\apidoc\models\TypeDoc
$protectedProperties	yii\apidoc\models\PropertyDoc[]	This property is read-only.	yii\apidoc\models\TypeDoc
$publicMethods	yii\apidoc\models\MethodDoc[]	This property is read-only.	yii\apidoc\models\TypeDoc
$publicProperties	yii\apidoc\models\PropertyDoc[]	This property is read-only.	yii\apidoc\models\TypeDoc
$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
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()		yii\apidoc\models\InterfaceDoc
__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
mbUcFirst()	Multibyte version of ucfirst()	yii\apidoc\models\BaseDoc

Property Details

$implementedBy public property

public $implementedBy = []

$parentInterfaces public property

public $parentInterfaces = []

Method Details

__construct() public method

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