UserPayload::getUsername() - Code Metrics - Inspection of "Merge branch 'develop'" - gnello/php-openfire-restapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5d5473...3f41e3 )

by Luca

created 2016-09-30 18:56 UTC

UserPayload::getUsername() A

↳ Parent: UserPayload

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * OpenFireRestAPI is based entirely on official documentation of the REST API
 * Plugin and you can extend it by following the directives of the documentation
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code. For the full list of
 * contributors, visit https://github.com/gnello/PHPOpenFireRestAPI/contributors
 *
 * @author Luca Agnello <[email protected]>
 * @link https://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html
 */

namespace Gnello\OpenFireRestAPI\Payloads;

/**
 * Payload of User related REST Endpoint
 * Class UserPayload
 * @package Gnello\OpenFireRestAPI\Payloads
 * @link http://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html#user
 */
class UserPayload extends AbstractPayload
{
    /**
     * The username of the user
     * Optional No
     * @var string
     */
    private $username;

    /**
     * The name of the user
     * Optional Yes
     * @var string
     */
    private $name;

    /**
     * The email of the user
     * Optional Yes
     * @var string
     */
    private $email;

    /**
     * The password of the user
     * Optional No
     * @var string
     */
    private $password;

    /**
     * List of properties. Property is a key/value object. The key must to be per user unique
     * Optional Yes
     * @var array
     */
    private $properties;

    /**
     * @param $username
     */
    public function setUsername($username) {
        $this->username = $username;
    }

    /**
     * @param $name
     */
    public function setName($name) {
        $this->name = $name;
    }

    /**
     * @param $email
     */
    public function setEmail($email) {
        $this->email = $email;
    }

    /**
     * @param $password
     */
    public function setPassword($password) {
        $this->password = $password;
    }

    /**
     * @param array $properties
     */
    public function setProperties(array $properties) {
        foreach ($properties as $key => $value) {
            $property['@key'] = $key;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
            $property['@value'] = $value;
            $this->properties['property'][] = $property;
        }
    }

    /**
     * @return string
     */
    public function getUsername() {
        return $this->username;
    }

    /**
     * @return string
     */
    public function getName() {
        return $this->name;
    }

    /**
     * @return string
     */
    public function getEmail() {
        return $this->email;
    }

    /**
     * @return string
     */
    public function getPassword() {
        return $this->password;
    }

    /**
     * @return array
     */
    public function getProperties() {
        return $this->properties;
    }
}

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 User related REST Endpoint
18			* Class UserPayload
19			* @package Gnello\OpenFireRestAPI\Payloads
20			* @link http://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html#user
21			*/
22			class UserPayload extends AbstractPayload
23			{
24			/**
25			* The username of the user
26			* Optional No
27			* @var string
28			*/
29			private $username;
30
31			/**
32			* The name of the user
33			* Optional Yes
34			* @var string
35			*/
36			private $name;
37
38			/**
39			* The email of the user
40			* Optional Yes
41			* @var string
42			*/
43			private $email;
44
45			/**
46			* The password of the user
47			* Optional No
48			* @var string
49			*/
50			private $password;
51
52			/**
53			* List of properties. Property is a key/value object. The key must to be per user unique
54			* Optional Yes
55			* @var array
56			*/
57			private $properties;
58
59			/**
60			* @param $username
61			*/
62			public function setUsername($username) {
63			$this->username = $username;
64			}
65
66			/**
67			* @param $name
68			*/
69			public function setName($name) {
70			$this->name = $name;
71			}
72
73			/**
74			* @param $email
75			*/
76			public function setEmail($email) {
77			$this->email = $email;
78			}
79
80			/**
81			* @param $password
82			*/
83			public function setPassword($password) {
84			$this->password = $password;
85			}
86
87			/**
88			* @param array $properties
89			*/
90			public function setProperties(array $properties) {
91			foreach ($properties as $key => $value) {
92			$property['@key'] = $key;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-07-16 15:48 UTC by Report Bug Copy Issue Report `$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...
93			$property['@value'] = $value;
94			$this->properties['property'][] = $property;
95			}
96			}
97
98			/**
99			* @return string
100			*/
101			public function getUsername() {
102			return $this->username;
103			}
104
105			/**
106			* @return string
107			*/
108			public function getName() {
109			return $this->name;
110			}
111
112			/**
113			* @return string
114			*/
115			public function getEmail() {
116			return $this->email;
117			}
118
119			/**
120			* @return string
121			*/
122			public function getPassword() {
123			return $this->password;
124			}
125
126			/**
127			* @return array
128			*/
129			public function getProperties() {
130			return $this->properties;
131			}
132			}

gnello / php-openfire-restapi

Push — master ( 5d5473...3f41e3 )

UserPayload::getUsername() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like