Completed
Push — master ( 01abf8...56bab1 )
by Andy
02:13
created

Post::__toString()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 1
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
3
namespace mySociety\EveryPoliticianPopolo\Objects;
4
5
class Post extends PopoloObject
6
{
7
    protected $properties = [
8
        'id',
9
        'label',
10
        'organizationId',
11
        'organization',
12
    ];
13
14 3
    public function __toString()
15
    {
16 3
        return "<Post: ".$this->label.">";
0 ignored issues
show
Documentation introduced by
The property label does not exist on object<mySociety\EveryPo...ianPopolo\Objects\Post>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
17
    }
18
19 18
    protected function getId()
20
    {
21 18
         return $this->arrGet($this->data, 'id');
22
    }
23
24 6
    protected function getLabel()
25
    {
26 6
         return $this->arrGet($this->data, 'label');
27
    }
28
29 6
    protected function getOrganizationId()
30
    {
31 6
        return $this->arrGet($this->data, 'organization_id');
32
    }
33
34 3
    protected function getOrganization()
35
    {
36 3
        return $this->allPopolo->organizations->lookupFromKey[$this->organizationId];
0 ignored issues
show
Documentation introduced by
The property organizationId does not exist on object<mySociety\EveryPo...ianPopolo\Objects\Post>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
37
    }
38
}
39