Radio::getOutputForEditMode() - Code Metrics - fwolf/fwlib - Measure and Improve Code Quality continuously with Scrutinizer

Radio::getOutputForEditMode() A
last analyzed 2019-05-09 15:53 UTC

↳ Parent: Radio

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	0
dl	0
loc	37
rs	9.328
c	0
b	0
f	0

<?php
namespace Fwlib\Html\Generator\Element;

use Fwlib\Html\Generator\AbstractElement;
use Fwlib\Html\Generator\ElementMode;

/**
 * Radio input
 *
 * @copyright   Copyright 2014-2015 Fwolf
 * @license     http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
 */
class Radio extends AbstractElement
{
    /**
     * @var string
     */
    protected $unknownValueTitle = 'Invalid Data';


    /**
     * {@inheritdoc}
     *
     * Configs
     * - items: Value => title pair, value should not include whitespace.
     */
    protected function getDefaultConfigs()
    {
        $configs = parent::getDefaultConfigs();

        return array_merge($configs, [
class Author {
    private $name;

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

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

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

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'items' => [],
        ]);
    }


    /**
     * @return  array
     */
    protected function getItems()
    {
        return $this->getConfig('items');
    }


    /**
     * {@inheritdoc}
     *
     * @see http://html.cita.illinois.edu/nav/form/radio/
     */
    protected function getOutputForEditMode()
    {
        $items = $this->getItems();

        $radioValue = $this->getValue();

        $output = '';
        $rawAttributes = $this->getRawAttributes();

        foreach ($items as $value => $title) {
            $checked = ($radioValue == $value) ? " checked='checked'" : '';
            $valueId = $this->getId("--$value");
            $titleClass = $this->getTitleClass();
            $titleId = $this->getTitleId($value);

            $nameHtml = trim($this->getNameHtml());

            $output .= <<<TAG
  <input type='radio'{$this->getClassHtml()}{$this->getIdHtml($valueId)}
    {$nameHtml} value='{$value}'{$checked}{$rawAttributes} />
  <label{$this->getClassHtml($titleClass)}{$this->getIdHtml($titleId)}
    for='{$valueId}'>{$title}</label>

TAG;
        }

        $containerClass = $this->getClass('__container');
        $containerId = $this->getId('__container');
        $output = trim($output);
        $output = <<<TAG
<fieldset{$this->getClassHtml($containerClass)}{$this->getIdHtml($containerId)}>
  $output
</fieldset>
TAG;

        return $output;
    }


    /**
     * {@inheritdoc}
     */
    protected function getOutputForShowMode()
    {
        $items = $this->getItems();
        $radioValue = $this->getValue();

        $title = array_key_exists($radioValue, $items)
            ? $items[$radioValue]
            : $this->unknownValueTitle;

        $output = "<input type='hidden'" .
            $this->getIdHtml() .
            $this->getNameHtml() .
            $this->getValueHtml(ElementMode::EDIT) .
            $this->getRawAttributes() .
            " />\n" .
            "<span" .
            $this->getClassHtml($this->getTitleClass()) .
            $this->getIdHtml($this->getTitleId($radioValue)) .
            ">" .
            $title .
            "</span>";

        return $output;
    }


    /**
     * @return string
     */
    protected function getTitleClass()
    {
        $class = $this->getClass();

        $class = empty($class) ? '' : $class . '__title';

        return $class;
    }


    /**
     * @param   string $value
     * @return string
     */
    protected function getTitleId($value)
    {
        $idStr = $this->getId();

        $idStr = empty($idStr) ? '' : $idStr . "__title--$value";

        return $idStr;
    }
}


1			<?php
2			namespace Fwlib\Html\Generator\Element;
3
4			use Fwlib\Html\Generator\AbstractElement;
5			use Fwlib\Html\Generator\ElementMode;
6
7			/**
8			* Radio input
9			*
10			* @copyright Copyright 2014-2015 Fwolf
11			* @license http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
12			*/
13			class Radio extends AbstractElement
14			{
15			/**
16			* @var string
17			*/
18			protected $unknownValueTitle = 'Invalid Data';
19
20
21			/**
22			* {@inheritdoc}
23			*
24			* Configs
25			* - items: Value => title pair, value should not include whitespace.
26			*/
27			protected function getDefaultConfigs()
28			{
29			$configs = parent::getDefaultConfigs();
30
31			return array_merge($configs, [
			0 ignored issues – show Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report The expression `return array_merge($conf...y('items' => array()));` seems to be an `array`, but some of its elements' types (`array`) are incompatible with the return type of the parent method `Fwlib\Html\Generator\Abs...ment::getDefaultConfigs` of type `array<string,null\|string>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
32			'items' => [],
33			]);
34			}
35
36
37			/**
38			* @return array
39			*/
40			protected function getItems()
41			{
42			return $this->getConfig('items');
43			}
44
45
46			/**
47			* {@inheritdoc}
48			*
49			* @see http://html.cita.illinois.edu/nav/form/radio/
50			*/
51			protected function getOutputForEditMode()
52			{
53			$items = $this->getItems();
54
55			$radioValue = $this->getValue();
56
57			$output = '';
58			$rawAttributes = $this->getRawAttributes();
59
60			foreach ($items as $value => $title) {
61			$checked = ($radioValue == $value) ? " checked='checked'" : '';
62			$valueId = $this->getId("--$value");
63			$titleClass = $this->getTitleClass();
64			$titleId = $this->getTitleId($value);
65
66			$nameHtml = trim($this->getNameHtml());
67
68			$output .= <<<TAG
69			<input type='radio'{$this->getClassHtml()}{$this->getIdHtml($valueId)}
70			{$nameHtml} value='{$value}'{$checked}{$rawAttributes} />
71			<label{$this->getClassHtml($titleClass)}{$this->getIdHtml($titleId)}
72			for='{$valueId}'>{$title}</label>
73
74			TAG;
75			}
76
77			$containerClass = $this->getClass('__container');
78			$containerId = $this->getId('__container');
79			$output = trim($output);
80			$output = <<<TAG
81			<fieldset{$this->getClassHtml($containerClass)}{$this->getIdHtml($containerId)}>
82			$output
83			</fieldset>
84			TAG;
85
86			return $output;
87			}
88
89
90			/**
91			* {@inheritdoc}
92			*/
93			protected function getOutputForShowMode()
94			{
95			$items = $this->getItems();
96			$radioValue = $this->getValue();
97
98			$title = array_key_exists($radioValue, $items)
99			? $items[$radioValue]
100			: $this->unknownValueTitle;
101
102			$output = "<input type='hidden'" .
103			$this->getIdHtml() .
104			$this->getNameHtml() .
105			$this->getValueHtml(ElementMode::EDIT) .
106			$this->getRawAttributes() .
107			" />\n" .
108			"<span" .
109			$this->getClassHtml($this->getTitleClass()) .
110			$this->getIdHtml($this->getTitleId($radioValue)) .
111			">" .
112			$title .
113			"</span>";
114
115			return $output;
116			}
117
118
119			/**
120			* @return string
121			*/
122			protected function getTitleClass()
123			{
124			$class = $this->getClass();
125
126			$class = empty($class) ? '' : $class . '__title';
127
128			return $class;
129			}
130
131
132			/**
133			* @param string $value
134			* @return string
135			*/
136			protected function getTitleId($value)
137			{
138			$idStr = $this->getId();
139
140			$idStr = empty($idStr) ? '' : $idStr . "__title--$value";
141
142			return $idStr;
143			}
144			}
145

fwolf / fwlib

Radio::getOutputForEditMode() A last analyzed 2019-05-09 15:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Radio::getOutputForEditMode() A
last analyzed 2019-05-09 15:53 UTC