Class luya\admin\openapi\phpdoc\PhpDocUses
| Inheritance | luya\admin\openapi\phpdoc\PhpDocUses |
|---|---|
| Available since version | 3.3.0 |
| Source Code | https://github.com/luyadev/luya-module-admin/blob/master/src/openapi/phpdoc/PhpDocUses.php |
Uses PhpDoc Annotation Parser
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $definition | luya\admin\openapi\phpdoc\PhpDocUses | ||
| $phpDocParser | luya\admin\openapi\phpdoc\PhpDocUses |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | luya\admin\openapi\phpdoc\PhpDocUses | |
| getDescription() | Description. | luya\admin\openapi\phpdoc\PhpDocUses |
| getType() | PhpDocType | luya\admin\openapi\phpdoc\PhpDocUses |
Property Details
Method Details
| public void __construct ( luya\admin\openapi\phpdoc\PhpDocParser $phpDocParser, array $definition ) | ||
| $phpDocParser | ||
| $definition | ||
public function __construct(PhpDocParser $phpDocParser, array $definition)
{
$this->phpDocParser = $phpDocParser;
$this->definition = $definition;
}
Description.
| public string getDescription ( ) |
public function getDescription()
{
return isset($this->definition[2]) ? ltrim($this->definition[2], '$') : '';
}
PhpDocType
| public luya\admin\openapi\phpdoc\PhpDocType getType ( ) |
public function getType()
{
return new PhpDocType($this->phpDocParser, $this->definition[1] ?? null);
}