Class luya\admin\openapi\phpdoc\PhpDocReturn

Inheritanceluya\admin\openapi\phpdoc\PhpDocReturn
Available since version3.2.0
Source Code https://github.com/luyadev/luya-module-admin/blob/master/src/openapi/phpdoc/PhpDocReturn.php

Return Object from PhpDoc.

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

public void getDescription ( )

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

            
getType() public method

PhpDocType

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

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