Completed
Push — master ( fa98ea...c23364 )
by Luca
02:32
created

SystemPropertyPayload::getProperty()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
/**
3
 * OpenFireRestAPI is based entirely on official documentation of the REST API
4
 * Plugin and you can extend it by following the directives of the documentation
5
 *
6
 * For the full copyright and license information, please read the LICENSE
7
 * file that was distributed with this source code. For the full list of
8
 * contributors, visit https://github.com/gnello/PHPOpenFireRestAPI/contributors
9
 *
10
 * @author Luca Agnello <[email protected]>
11
 * @link https://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html
12
 */
13
14
namespace Gnello\OpenFireRestAPI\Payloads;
15
16
/**
17
 * Payload of SystemProperty related REST Endpoint
18
 * Class SystemPropertyPayload
19
 * @package Gnello\OpenFireRestAPI\Payloads
20
 * @link http://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html#system-property
21
 */
22
class SystemPropertyPayload extends AbstractPayload
23
{
24
    /**
25
     * The name of the system property
26
     * Optional No
27
     * @var string
28
     */
29
    //private $key;
30
31
    /**
32
     * The value of the system property
33
     * Optional Yes
34
     * @var string
35
     */
36
    //private $value;
37
38
    /**
39
     * The value of the system property
40
     * Optional Yes
41
     * @var string
42
     */
43
    private $property;
44
45
    /**
46
     * SystemPropertyPayload constructor.
47
     * @param $property
48
     */
49
    public function __construct($property)
50
    {
51
        $prop['property'][$property['propertyName']] = $property['propertyValue'];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$prop was never initialized. Although not strictly required by PHP, it is generally a good practice to add $prop = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
52
        parent::__construct($prop);
53
    }
54
55
    /**
56
     * @param array $properties
57
     */
58 View Code Duplication
    public function setProperty(array $properties) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
59
        foreach ($properties as $key => $value) {
60
            $property['@key'] = $key;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$property was never initialized. Although not strictly required by PHP, it is generally a good practice to add $property = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
61
            $property['@value'] = $value;
62
            $this->property = $property;
0 ignored issues
show
Documentation Bug introduced by
It seems like $property of type array<string,?,{"@value":"?"}> is incompatible with the declared type string of property $property.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
63
        }
64
    }
65
66
    /**
67
     * @return array
68
     */
69
    public function getProperty() {
70
        return $this->property;
71
    }
72
}