Class luya\admin\openapi\phpdoc\PhpDocUses

Inheritanceluya\admin\openapi\phpdoc\PhpDocUses
Available since version3.3.0

Uses PhpDoc Annotation Parser

Property Details

Hide inherited properties

$definition protected property
protected $definition null
$phpDocParser protected property
protected $phpDocParser null

Method Details

Hide inherited methods

__construct() public method

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

            
getDescription() public method

Description.

public string getDescription ( )

                public function getDescription()
{
    return isset($this->definition[2]) ? ltrim($this->definition[2], '$') : '';
}

            
getType() public method

PhpDocType

public luya\admin\openapi\phpdoc\PhpDocType getType ( )

                public function getType()
{
    return new PhpDocType($this->phpDocParser, $this->definition[1] ?? null);
}