mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 06:37:55 +08:00
57 lines
1.5 KiB
PHP
57 lines
1.5 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\apidoc\models;
|
|
|
|
use yii\apidoc\helpers\PrettyPrinter;
|
|
use yii\base\Object;
|
|
|
|
/**
|
|
* Represents API documentation information for a [[FunctionDoc|function]] or [[MethodDoc|method]] `param`.
|
|
*
|
|
* @author Carsten Brandt <mail@cebe.cc>
|
|
* @since 2.0
|
|
*/
|
|
class ParamDoc extends Object
|
|
{
|
|
public $name;
|
|
public $typeHint;
|
|
public $isOptional;
|
|
public $defaultValue;
|
|
public $isPassedByReference;
|
|
// will be set by creating class
|
|
public $description;
|
|
public $type;
|
|
public $types;
|
|
public $sourceFile;
|
|
|
|
|
|
/**
|
|
* @param \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $reflector
|
|
* @param Context $context
|
|
* @param array $config
|
|
*/
|
|
public function __construct($reflector = null, $context = null, $config = [])
|
|
{
|
|
parent::__construct($config);
|
|
|
|
if ($reflector === null) {
|
|
return;
|
|
}
|
|
|
|
$this->name = $reflector->getName();
|
|
$this->typeHint = $reflector->getType();
|
|
$this->isOptional = $reflector->getDefault() !== null;
|
|
|
|
// bypass $reflector->getDefault() for short array syntax
|
|
if ($reflector->getNode()->default) {
|
|
$this->defaultValue = PrettyPrinter::getRepresentationOfValue($reflector->getNode()->default);
|
|
}
|
|
$this->isPassedByReference = $reflector->isByRef();
|
|
}
|
|
}
|