UpdateNotifier::execute()   C
last analyzed

Complexity

Conditions 7
Paths 6

Size

Total Lines 33
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 7
eloc 15
nc 6
nop 0
dl 0
loc 33
rs 6.7272
c 0
b 0
f 0
1
<?php
2
/**
3
 * UpdateNotifier Plugin
4
 *
5
 * PHP version 5
6
 *
7
 * @category  PHP
8
 * @package   PSI_Plugin_UpdateNotifier
9
 * @author    Damien ROTH <[email protected]>
10
 * @copyright 2009 phpSysInfo
11
 * @license   http://opensource.org/licenses/gpl-2.0.php GNU General Public License
12
 * @version   SVN: $Id: class.updatenotifier.inc.php 661 2012-08-27 11:26:39Z namiltd $
13
 * @link      http://phpsysinfo.sourceforge.net
14
 */
15
/**
16
 * UpdateNotifier Plugin, which displays update notification from Ubuntu Landscape system
17
 *
18
 * @category  PHP
19
 * @package   PSI_Plugin_UpdateNotifier
20
 * @author    Damien ROTH <[email protected]>
21
 * @copyright 2009 phpSysInfo
22
 * @license   http://opensource.org/licenses/gpl-2.0.php GNU General Public License
23
 * @version   $Id: class.updatenotifier.inc.php 661 2012-08-27 11:26:39Z namiltd $
24
 * @link      http://phpsysinfo.sourceforge.net
25
 */
26
class UpdateNotifier extends PSI_Plugin
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
27
{
28
    /**
29
     * variable, which holds the content of the command
30
     * @var array
31
     */
32
    private $_filecontent = array();
33
34
    /**
35
     * variable, which holds the result before the xml is generated out of this array
36
     * @var array
37
     */
38
    private $_result = array();
39
40
    /**
41
     * read the data into an internal array and also call the parent constructor
42
     *
43
     * @param String $enc encoding
44
     */
45
    public function __construct($enc)
46
    {
47
        parent::__construct(__CLASS__, $enc);
48
49
        CommonFunctions::rfts(PSI_PLUGIN_UPDATENOTIFIER_FILE, $buffer_info);
50
        // Remove blank lines
51
        $this->_filecontent = preg_split("/\n/", $buffer_info, -1, PREG_SPLIT_NO_EMPTY);
52
    }
53
54
    /**
55
     * doing all tasks to get the required informations that the plugin needs
56
     * result is stored in an internal array
57
     *
58
     * @return void
59
     */
60
    public function execute()
61
    {
62
        if (empty($this->_filecontent)) {
63
            return;
64
        }
65
66
        if (PSI_PLUGIN_UPDATENOTIFIER_UBUNTU_LANDSCAPE_FORMAT === true) {
67
            /*
68
             Ubuntu Landscape format:
69
             - line 1: packages to update
70
             - line 2: security packages to update
71
             */
72
            if (count($this->_filecontent) == 2) {
73
                foreach ($this->_filecontent as $line) {
74
                    list($num, $text) = explode(" ", $line, 2);
0 ignored issues
show
Unused Code introduced by
The assignment to $text is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
75
                    $this->_result[] = $num;
76
                }
77
            } else {
78
                $this->global_error->addWarning("Unable to parse UpdateNotifier file");
79
            }
80
        } else {
81
            /*
82
             Universal format: A;B
83
             - A: packages to update
84
             - B: security packages to update
85
             */
86
            if (count($this->_filecontent) == 1 && strpos($this->_filecontent[0], ";") !== false) {
87
                $this->_result = explode(";", $this->_filecontent[0]);
88
            } else {
89
                $this->global_error->addWarning("Unable to parse UpdateNotifier file");
90
            }
91
        }
92
    }
93
94
    /**
95
     * generates the XML content for the plugin
96
     *
97
     * @return SimpleXMLElement entire XML content for the plugin
98
     */
99
    public function xml()
100
    {
101
        if (!empty($this->_result)) {
102
            $xmluu = $this->xml->addChild("UpdateNotifier");
103
            $xmluu->addChild("packages", $this->_result[0]);
104
            $xmluu->addChild("security", $this->_result[1]);
105
        }
106
107
        return $this->xml->getSimpleXmlElement();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->xml->getSimpleXmlElement(); (SimpleXMLElement) is incompatible with the return type declared by the interface PSI_Interface_Plugin::xml of type SimpleXMLObject.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
108
    }
109
}
110