Issues in Options.php (master) - Issues in master - unyx/console - Measure and Improve Code Quality continuously with Scrutinizer

Issues (32)

Security Analysis no request data

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

input/parameter/definitions/Options.php (5 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php namespace nyx\console\input\parameter\definitions;

// External dependencies
use nyx\core;

// Internal dependencies
use nyx\console\input;

/**
 * Input Option Definitions
 *
 * @version     0.1.0
 * @author      Michal Chojnacki <[email protected]>
 * @copyright   2012-2017 Nyx Dev Team
 * @link        https://github.com/unyx/nyx
 */
class Options extends input\parameter\Definitions
{
    /**
     * @var input\Option[]  A map of Option names to their Definitions.
     */
    protected $items = [];

    /**
     * @var input\Option[]  A map of Option shortcuts to their Definitions.
     */
    protected $shortcuts = [];

    /**
     * {@inheritdoc}
     */
    public function __construct($options = null)
    {
        $this->setCollectedType(input\Option::class);

        parent::__construct($options);
    }

    /**
     * {@inheritdoc}
     */
    public function replace($items) : core\collections\interfaces\Collection
    {
        $this->items     = [];
        $this->shortcuts = [];

        foreach ($this->extractItems($items) as $item) {
            $this->add(is_array($item) ? $this->unpack($item) : $item);
        }

        return $this;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function add(core\interfaces\Named $option) : core\collections\interfaces\NamedObjectSet
    {
        parent::add($option);

        // If the Option has a shortcut...
        /* @var input\Option $option */
        if ($shortcut = $option->getShortcut()) {
            if (isset($this->shortcuts[$shortcut])) {
                throw new core\collections\exceptions\KeyAlreadyExists($this, $shortcut, $option, "An option with this shortcut [$shortcut] has already been defined.");
            }

            $this->shortcuts[$shortcut] = $option;
        }

        return $this;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function remove(string $name): core\collections\interfaces\NamedObjectSet
    {
        if (!isset($this->items[$name])) {
            return $this;
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());
}
        }

        if ($shortcut = $this->items[$name]->getShortcut()) {
            unset($this->shortcuts[$shortcut]);
        }

        return parent::remove($name);
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());
}
    }

    /**
     * Returns the map of Option shortcuts to their Definitions.
     *
     * @return  input\Option[]
     */
    public function getShortcuts() : array
    {
        return $this->shortcuts;
    }

    /**
     * Returns the Option matching a given shortcut name.
     *
     * @param   string          $shortcut                   The name of the shortcut.
     * @return  input\Option                                The Option matching the shortcut name.
     * @throws  core\collections\exceptions\KeyNotExists    When the given shortcut is not defined.
     */
    public function getByShortcut(string $shortcut) : input\Option
    {
        if (!isset($this->shortcuts[$shortcut])) {
            throw new core\collections\exceptions\KeyNotExists($this, $shortcut, "The short option [$shortcut] is not defined.");
        }

        return $this->shortcuts[$shortcut];
    }

    /**
     * Unpacks a sequence of Option constructor arguments into an Option instance.
     *
     * @see     \nyx\console\input\Option::__construct()
     *
     * @param   array           $definition     The arguments to unpack. The order must match the constructor's signature.
     * @return  input\Option
     */
    protected function unpack(array $definition) : input\Option
    {
        // If the 4th argument is an integer, we are going to assume it's one of the input\Value
        // class constants defining the mode and attempt to instantiate a input\Value with such.
        if (isset($definition[3]) && is_int($definition[3])) {
            $definition[3] = new input\Value($definition[3]);
        }

        return new input\Option(...$definition);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1			<?php namespace nyx\console\input\parameter\definitions;
2
3			// External dependencies
4			use nyx\core;
5
6			// Internal dependencies
7			use nyx\console\input;
8
9			/**
10			* Input Option Definitions
11			*
12			* @version 0.1.0
13			* @author Michal Chojnacki <[email protected]>
14			* @copyright 2012-2017 Nyx Dev Team
15			* @link https://github.com/unyx/nyx
16			*/
17			class Options extends input\parameter\Definitions
18			{
19			/**
20			* @var input\Option[] A map of Option names to their Definitions.
21			*/
22			protected $items = [];
23
24			/**
25			* @var input\Option[] A map of Option shortcuts to their Definitions.
26			*/
27			protected $shortcuts = [];
28
29			/**
30			* {@inheritdoc}
31			*/
32			public function __construct($options = null)
33			{
34			$this->setCollectedType(input\Option::class);
35
36			parent::__construct($options);
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function replace($items) : core\collections\interfaces\Collection
43			{
44			$this->items = [];
45			$this->shortcuts = [];
46
47			foreach ($this->extractItems($items) as $item) {
48			$this->add(is_array($item) ? $this->unpack($item) : $item);
49			}
50
51			return $this;
			0 ignored issues – show Bug Best Practice introduced 2017-02-06 17:55 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $this;` (`nyx\console\input\parameter\definitions\Options`) is incompatible with the return type of the parent method `nyx\core\collections\NamedObjectSet::replace` of type `nyx\core\collections\traits\NamedObjectSet`. 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...
52			}
53
54			/**
55			* {@inheritdoc}
56			*/
57			public function add(core\interfaces\Named $option) : core\collections\interfaces\NamedObjectSet
58			{
59			parent::add($option);
60
61			// If the Option has a shortcut...
62			/* @var input\Option $option */
63			if ($shortcut = $option->getShortcut()) {
64			if (isset($this->shortcuts[$shortcut])) {
65			throw new core\collections\exceptions\KeyAlreadyExists($this, $shortcut, $option, "An option with this shortcut [$shortcut] has already been defined.");
66			}
67
68			$this->shortcuts[$shortcut] = $option;
69			}
70
71			return $this;
			0 ignored issues – show Bug Best Practice introduced 2017-02-06 17:55 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $this;` (`nyx\console\input\parameter\definitions\Options`) is incompatible with the return type of the parent method `nyx\core\collections\NamedObjectSet::add` of type `nyx\core\collections\traits\NamedObjectSet`. 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...
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77			public function remove(string $name): core\collections\interfaces\NamedObjectSet
78			{
79			if (!isset($this->items[$name])) {
80			return $this;
			0 ignored issues – show Bug Best Practice introduced 2017-02-09 12:42 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $this;` (`nyx\console\input\parameter\definitions\Options`) is incompatible with the return type of the parent method `nyx\core\collections\NamedObjectSet::remove` of type `nyx\core\collections\traits\NamedObjectSet`. 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...
81			}
82
83			if ($shortcut = $this->items[$name]->getShortcut()) {
84			unset($this->shortcuts[$shortcut]);
85			}
86
87			return parent::remove($name);
			0 ignored issues – show Bug Best Practice introduced 2017-02-09 12:42 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return parent::remove($name);` (`nyx\console\input\parameter\definitions\Options`) is incompatible with the return type of the parent method `nyx\core\collections\NamedObjectSet::remove` of type `nyx\core\collections\traits\NamedObjectSet`. 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...
88			}
89
90			/**
91			* Returns the map of Option shortcuts to their Definitions.
92			*
93			* @return input\Option[]
94			*/
95			public function getShortcuts() : array
96			{
97			return $this->shortcuts;
98			}
99
100			/**
101			* Returns the Option matching a given shortcut name.
102			*
103			* @param string $shortcut The name of the shortcut.
104			* @return input\Option The Option matching the shortcut name.
105			* @throws core\collections\exceptions\KeyNotExists When the given shortcut is not defined.
106			*/
107			public function getByShortcut(string $shortcut) : input\Option
108			{
109			if (!isset($this->shortcuts[$shortcut])) {
110			throw new core\collections\exceptions\KeyNotExists($this, $shortcut, "The short option [$shortcut] is not defined.");
111			}
112
113			return $this->shortcuts[$shortcut];
114			}
115
116			/**
117			* Unpacks a sequence of Option constructor arguments into an Option instance.
118			*
119			* @see \nyx\console\input\Option::__construct()
120			*
121			* @param array $definition The arguments to unpack. The order must match the constructor's signature.
122			* @return input\Option
123			*/
124			protected function unpack(array $definition) : input\Option
125			{
126			// If the 4th argument is an integer, we are going to assume it's one of the input\Value
127			// class constants defining the mode and attempt to instantiate a input\Value with such.
128			if (isset($definition[3]) && is_int($definition[3])) {
129			$definition[3] = new input\Value($definition[3]);
130			}
131
132			return new input\Option(...$definition);
			0 ignored issues – show Documentation introduced 2017-02-08 14:38 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$definition` is of type `array<integer,?,{"3":"?"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
133			}
134			}
135

unyx / console

Issues (32)

Security Analysis no request data

input/parameter/definitions/Options.php (5 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like