PropertyDoc.php 2.51 KB
Newer Older
1 2
<?php
/**
3 4 5
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
6 7
 */

8
namespace yii\apidoc\models;
9

10
use phpDocumentor\Reflection\DocBlock\Tag\VarTag;
Carsten Brandt committed
11
use yii\apidoc\helpers\PrettyPrinter;
12

13
/**
14
 * Represents API documentation information for a `property`.
15 16 17 18
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
19 20
class PropertyDoc extends BaseDoc
{
21 22 23 24 25 26 27 28 29 30
    public $visibility;
    public $isStatic;
    public $type;
    public $types;
    public $defaultValue;
    // will be set by creating class
    public $getter;
    public $setter;
    // will be set by creating class
    public $definedBy;
31

32

33 34 35
    /**
     * @return bool if property is read only
     */
36 37 38 39
    public function getIsReadOnly()
    {
        return $this->getter !== null && $this->setter === null;
    }
40

41 42 43
    /**
     * @return bool if property is write only
     */
44 45 46 47
    public function getIsWriteOnly()
    {
        return $this->getter === null && $this->setter !== null;
    }
48

49 50
    /**
     * @param \phpDocumentor\Reflection\ClassReflector\PropertyReflector $reflector
51 52
     * @param Context $context
     * @param array $config
53 54 55 56
     */
    public function __construct($reflector = null, $context = null, $config = [])
    {
        parent::__construct($reflector, $context, $config);
57

58 59 60
        if ($reflector === null) {
            return;
        }
61

62 63
        $this->visibility = $reflector->getVisibility();
        $this->isStatic = $reflector->isStatic();
64

65 66 67 68
        // bypass $reflector->getDefault() for short array syntax
        if ($reflector->getNode()->default) {
            $this->defaultValue = PrettyPrinter::getRepresentationOfValue($reflector->getNode()->default);
        }
69

70
        $hasInheritdoc = false;
71
        foreach ($this->tags as $tag) {
72 73 74
            if ($tag->getName() === 'inheritdoc') {
                $hasInheritdoc = true;
            }
75 76 77 78
            if ($tag instanceof VarTag) {
                $this->type = $tag->getType();
                $this->types = $tag->getTypes();
                $this->description = ucfirst($tag->getDescription());
79
                $this->shortDescription = BaseDoc::extractFirstSentence($this->description);
80 81
            }
        }
82
        if (empty($this->shortDescription) && $context !== null && !$hasInheritdoc) {
83 84 85 86 87 88 89
            $context->errors[] = [
                'line' => $this->startLine,
                'file' => $this->sourceFile,
                'message' => "No short description for element '{$this->name}'",
            ];
        }
    }
AlexGx committed
90
}