<?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; /** * @param \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $reflector * @param array $config */ public function __construct($reflector = 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(); } }