BlockUser   A
last analyzed

Complexity

Total Complexity 5

Size/Duplication

Total Lines 68
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Importance

Changes 1
Bugs 0 Features 1
Metric Value
wmc 5
lcom 1
cbo 1
dl 0
loc 68
rs 10
c 1
b 0
f 1

5 Methods

Rating   Name   Duplication   Size   Complexity  
A toString() 0 13 1
A getJabberID() 0 4 1
A setJabberID() 0 5 1
A getFrom() 0 4 1
A setFrom() 0 5 1
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 BlockUser implements ProtocolImplementationInterface
47
{
48
    protected $from;
49
50
    // the jid of the user to block
51
    protected $accountjid;
52
53
    /**
54
     * {@inheritDoc}
55
     */
56
    public function toString()
57
    {
58
        return XML::quoteMessage(
59
            '<iq from="%s" type="set" id="%s">
60
                <block xmlns="urn:xmpp:blocking">
61
                  <item jid="%s"/>
62
                </block>
63
            </iq>',
64
            $this->getFrom(),
65
            XML::generateId(),
66
            $this->getJabberID()
67
        );
68
    }
69
70
    /**
71
     * Get JabberID.
72
     *
73
     * @return string
74
     */
75
    public function getJabberID()
76
    {
77
        return $this->accountjid;
78
    }
79
80
    /**
81
     * Set abberID.
82
     *
83
     * @param string $accountjid
84
     * @return $this
85
     */
86
    public function setJabberID($accountjid)
87
    {
88
        $this->accountjid = (string) $accountjid;
89
        return $this;
90
    }
91
92
    /**
93
     * Get JabberID.
94
     *
95
     * @return string
96
     */
97
    public function getFrom()
98
    {
99
        return $this->from;
100
    }
101
102
    /**
103
     * Set abberID.
104
     *
105
     * @param string $nickname
0 ignored issues
show
Bug introduced by
There is no parameter named $nickname. 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...
106
     * @return $this
107
     */
108
    public function setFrom($from)
109
    {
110
        $this->from = (string) $from;
111
        return $this;
112
    }
113
}
114