Presence::getNickname() - Code Metrics - Inspection of "Support for password-protected chatrooms" - fabiang/xmpp - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( a34e32...ac06e1 )

by Fabian

created 2017-05-23 10:47 UTC

Presence::getNickname() A

↳ Parent: Presence

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

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

/**
 * Copyright 2014 Fabian Grutschus. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the copyright holders.
 *
 * @author    Fabian Grutschus <[email protected]>
 * @copyright 2014 Fabian Grutschus. All rights reserved.
 * @license   BSD
 * @link      http://github.com/fabiang/xmpp
 */

namespace Fabiang\Xmpp\Protocol;

use Fabiang\Xmpp\Util\XML;

/**
 * Protocol setting for Xmpp.
 *
 * @package Xmpp\Protocol
 */
class Presence implements ProtocolImplementationInterface
{
    /**
     * Signals that the entity is available for communication.
     */

    const TYPE_AVAILABLE = 'available';

    /**
     * Signals that the entity is no longer available for communication.
     */
    const TYPE_UNAVAILABLE = 'unavailable';

    /**
     * The sender wishes to subscribe to the recipient's presence.
     */
    const TYPE_SUBSCRIBE = 'subscribe';

    /**
     * The sender has allowed the recipient to receive their presence.
     */
    const TYPE_SUBSCRIBED = 'subscribed';

    /**
     * The sender is unsubscribing from another entity's presence.
     */
    const TYPE_UNSUBSCRIBE = 'unsubscribe';

    /**
     * The subscription request has been denied or a previously-granted subscription has been cancelled.
     */
    const TYPE_UNSUBSCRIBED = 'unsubscribed';

    /**
     * A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
     */
    const TYPE_PROBE = 'probe';

    /**
     * An error has occurred regarding processing or delivery of a previously-sent presence stanza.
     */
    const TYPE_ERROR = 'error';

    /**
     * The entity or resource is available.
     */
    const SHOW_AVAILABLE = 'available';

    /**
     * The entity or resource is temporarily away.
     */
    const SHOW_AWAY = 'away';

    /**
     * The entity or resource is actively interested in chatting.
     */
    const SHOW_CHAT = 'chat';

    /**
     * The entity or resource is busy (dnd = "Do Not Disturb").
     */
    const SHOW_DND = 'dnd';

    /**
     * The entity or resource is away for an extended period (xa = "eXtended Away").
     */
    const SHOW_XA = 'xa';

    /**
     * Presence to.
     *
     * @var string|null
     */
    protected $to;

    /**
     * Priority.
     *
     * @var integer
     */
    protected $priority = 1;

    /**
     * Nickname for presence.
     *
     * @var string
     */
    protected $nickname;

    /**
     * Channel password.
     *
     * @var string
     */
    protected $password;

    /**
     * Constructor.
     *
     * @param integer $priority
     * @param string $to
     * @param string $nickname
     */
    public function __construct($priority = 1, $to = null, $nickname = null)
    {
        $this->setPriority($priority)->setTo($to)->setNickname($nickname);
    }

    /**
     * {@inheritDoc}
     */
    public function toString()
    {
        $presence = '<presence';

        if (null !== $this->getTo()) {
            $presence .= ' to="' . XML::quote($this->getTo()) . '/' . XML::quote($this->getNickname()) . '"';
        }

        $presence .= '><priority>' . $this->getPriority() . '</priority>';

        if (null !== $this->getPassword()) {
            $presence .= "<x xmlns='http://jabber.org/protocol/muc'><password>" . $this->getPassword() . "</password></x>";
        }

        $presence .= '</presence>';
        return $presence;
    }

    /**
     * Get nickname.
     *
     * @return string
     */
    public function getNickname()
    {
        return $this->nickname;
    }

    /**
     * Set nickname.
     *
     * @param string $nickname
     * @return $this
     */
    public function setNickname($nickname)
    {
        $this->nickname = (string) $nickname;
        return $this;
    }

    /**
     * Get to.
     *
     * @return string¦null
     */
    public function getTo()
    {
        return $this->to;
    }

    /**
     * Set to.
     *
     * @param string|null $to
     * @return $this
     */
    public function setTo($to = null)
    {
        $this->to = $to;
        return $this;
    }

    /**
     * Get priority.
     *
     * @return integer
     */
    public function getPriority()
    {
        return $this->priority;
    }

    /**
     * Set priority.
     *
     * @param integer $priority
     * @return $this
     */
    public function setPriority($priority)
    {
        $this->priority = (int) $priority;
        return $this;
    }

    /**
     * Get channel password.
     *
     * @return string¦null
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * Set channel password.
     *
     * @param string|null $to
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return $this
     */
    public function setPassword($password = null)
    {
        $this->password = $password;
        return $this;
    }
}


1		<?php
2
3		/**
4		* Copyright 2014 Fabian Grutschus. All rights reserved.
5		*
6		* Redistribution and use in source and binary forms, with or without modification,
7		* are permitted provided that the following conditions are met:
8		*
9		* 1. Redistributions of source code must retain the above copyright notice, this
10		* list of conditions and the following disclaimer.
11		*
12		* 2. Redistributions in binary form must reproduce the above copyright notice,
13		* this list of conditions and the following disclaimer in the documentation
14		* and/or other materials provided with the distribution.
15		*
16		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18		* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19		* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20		* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21		* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23		* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25		* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26		*
27		* The views and conclusions contained in the software and documentation are those
28		* of the authors and should not be interpreted as representing official policies,
29		* either expressed or implied, of the copyright holders.
30		*
31		* @author Fabian Grutschus <[email protected]>
32		* @copyright 2014 Fabian Grutschus. All rights reserved.
33		* @license BSD
34		* @link http://github.com/fabiang/xmpp
35		*/
36
37		namespace Fabiang\Xmpp\Protocol;
38
39		use Fabiang\Xmpp\Util\XML;
40
41		/**
42		* Protocol setting for Xmpp.
43		*
44		* @package Xmpp\Protocol
45		*/
46		class Presence implements ProtocolImplementationInterface
47		{
48		/**
49		* Signals that the entity is available for communication.
50		*/
51
52		const TYPE_AVAILABLE = 'available';
53
54		/**
55		* Signals that the entity is no longer available for communication.
56		*/
57		const TYPE_UNAVAILABLE = 'unavailable';
58
59		/**
60		* The sender wishes to subscribe to the recipient's presence.
61		*/
62		const TYPE_SUBSCRIBE = 'subscribe';
63
64		/**
65		* The sender has allowed the recipient to receive their presence.
66		*/
67		const TYPE_SUBSCRIBED = 'subscribed';
68
69		/**
70		* The sender is unsubscribing from another entity's presence.
71		*/
72		const TYPE_UNSUBSCRIBE = 'unsubscribe';
73
74		/**
75		* The subscription request has been denied or a previously-granted subscription has been cancelled.
76		*/
77		const TYPE_UNSUBSCRIBED = 'unsubscribed';
78
79		/**
80		* A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
81		*/
82		const TYPE_PROBE = 'probe';
83
84		/**
85		* An error has occurred regarding processing or delivery of a previously-sent presence stanza.
86		*/
87		const TYPE_ERROR = 'error';
88
89		/**
90		* The entity or resource is available.
91		*/
92		const SHOW_AVAILABLE = 'available';
93
94		/**
95		* The entity or resource is temporarily away.
96		*/
97		const SHOW_AWAY = 'away';
98
99		/**
100		* The entity or resource is actively interested in chatting.
101		*/
102		const SHOW_CHAT = 'chat';
103
104		/**
105		* The entity or resource is busy (dnd = "Do Not Disturb").
106		*/
107		const SHOW_DND = 'dnd';
108
109		/**
110		* The entity or resource is away for an extended period (xa = "eXtended Away").
111		*/
112		const SHOW_XA = 'xa';
113
114		/**
115		* Presence to.
116		*
117		* @var string\|null
118		*/
119		protected $to;
120
121		/**
122		* Priority.
123		*
124		* @var integer
125		*/
126		protected $priority = 1;
127
128		/**
129		* Nickname for presence.
130		*
131		* @var string
132		*/
133		protected $nickname;
134
135		/**
136		* Channel password.
137		*
138		* @var string
139		*/
140		protected $password;
141
142		/**
143		* Constructor.
144		*
145		* @param integer $priority
146		* @param string $to
147		* @param string $nickname
148		*/
149	3	public function __construct($priority = 1, $to = null, $nickname = null)
150		{
151	3	$this->setPriority($priority)->setTo($to)->setNickname($nickname);
152	3	}
153
154		/**
155		* {@inheritDoc}
156		*/
157		public function toString()
158		{
159		$presence = '<presence';
160
161		if (null !== $this->getTo()) {
162		$presence .= ' to="' . XML::quote($this->getTo()) . '/' . XML::quote($this->getNickname()) . '"';
163		}
164
165		$presence .= '><priority>' . $this->getPriority() . '</priority>';
166
167		if (null !== $this->getPassword()) {
168		$presence .= "<x xmlns='http://jabber.org/protocol/muc'><password>" . $this->getPassword() . "</password></x>";
169		}
170
171		$presence .= '</presence>';
172		return $presence;
173		}
174
175		/**
176		* Get nickname.
177		*
178		* @return string
179		*/
180	3	public function getNickname()
181		{
182	3	return $this->nickname;
183		}
184
185		/**
186		* Set nickname.
187		*
188		* @param string $nickname
189		* @return $this
190		*/
191	3	public function setNickname($nickname)
192		{
193	3	$this->nickname = (string) $nickname;
194	3	return $this;
195		}
196
197		/**
198		* Get to.
199		*
200		* @return string¦null
201		*/
202	3	public function getTo()
203		{
204	3	return $this->to;
205		}
206
207		/**
208		* Set to.
209		*
210		* @param string\|null $to
211		* @return $this
212		*/
213	3	public function setTo($to = null)
214		{
215	3	$this->to = $to;
216	3	return $this;
217		}
218
219		/**
220		* Get priority.
221		*
222		* @return integer
223		*/
224	3	public function getPriority()
225		{
226	3	return $this->priority;
227		}
228
229		/**
230		* Set priority.
231		*
232		* @param integer $priority
233		* @return $this
234		*/
235	3	public function setPriority($priority)
236		{
237	3	$this->priority = (int) $priority;
238	3	return $this;
239		}
240
241		/**
242		* Get channel password.
243		*
244		* @return string¦null
245		*/
246		public function getPassword()
247		{
248		return $this->password;
249		}
250
251		/**
252		* Set channel password.
253		*
254		* @param string\|null $to
		0 ignored issues – show Bug introduced 2016-12-16 22:39 UTC by Report Bug Copy Issue Report There is no parameter named `$to`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
255		* @return $this
256		*/
257		public function setPassword($password = null)
258		{
259		$this->password = $password;
260		return $this;
261		}
262		}
263

fabiang / xmpp

Push — develop ( a34e32...ac06e1 )

Presence::getNickname() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like