Completed
Push — master ( 7ff1b8...399f52 )
by Jean-Christophe
03:04
created

HtmlIconGroups::getIcon()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
namespace Ajax\semantic\html\elements;
4
5
use Ajax\semantic\html\base\HtmlSemCollection;
6
use Ajax\service\JArray;
7
use Ajax\JsUtils;
8
9
/**
10
 * Semantic Icons group component
11
 * @see http://semantic-ui.com/elements/icon.html#/definition
12
 * @author jc
13
 * @version 1.001
14
 */
15
class HtmlIconGroups extends HtmlSemCollection {
16
17
	public function __construct($identifier, $icons=array(), $size="") {
18
		parent::__construct($identifier, "i", "icons");
19
		$this->addItems($icons);
20
		$this->setSize($size);
21
	}
22
23
	protected function createItem($value) {
24
		$icon=$value;
25
		if (\is_array($value)) {
26
			$icon=JArray::getValue($value, "icon", 0);
27
			$size=JArray::getValue($value, "size", 1);
28
		}
29
		$iconO=new HtmlIcon("icon-" . $this->identifier, $icon);
30
		if (isset($size)) {
31
			$iconO->setSize($size);
32
		}
33
		return $iconO;
34
	}
35
36
	protected function createCondition($value) {
37
		return ($value instanceof HtmlIcon) === false;
38
	}
39
40
	public function getIcon($index) {
41
		return $this->content[$index];
42
	}
43
44
	public function run(JsUtils $js){
45
		$result= parent::run($js);
46
		return $result->setItemSelector("i");
47
	}
48
49
	public function toCorner($index=1) {
50
		$this->getItem($index)->toCorner();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Ajax\common\html\HtmlDoubleElement as the method toCorner() does only exist in the following sub-classes of Ajax\common\html\HtmlDoubleElement: Ajax\semantic\html\elements\HtmlIcon, Ajax\semantic\html\elements\HtmlIconGroups, Ajax\semantic\html\elements\HtmlLabel. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
51
		return $this;
52
	}
53
}