FormFieldDefault::getValueToUse() - Code Metrics - qua-bla/form - Measure and Improve Code Quality continuously with Scrutinizer

FormFieldDefault::getValueToUse() A
last analyzed 2016-10-13 09:50 UTC

↳ Parent: FormFieldDefault

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	3
nop	0

<?php

namespace hemio\form\Abstract_;

use hemio\form as form_;
use hemio\form\exception;
use hemio\html;

/**
 *
 *
 */
abstract class FormFieldDefault extends FormField implements form_\Focusable {


    /**
     *
     * @var string
     */
    public $title = '';

    /**
     *
     * @var boolean
     */
    protected $filled = false;

    /**
     *
     * @var html\Interface_\Submittable
     */
    protected $control;

    /**
     *
     * @var string
     */
    protected $defaultValue = '';

    /**
     *
     * @param mixed $value
     */
    public function setDefaultValue($value) {
        $this->defaultValue = $value;
    }

    /**
     * @return mixed Default value
     */
    public function getValueDefault() {
        return $this->withTransformations($this->defaultValue);
    }

    public function getValueStored() {
        return $this->withTransformations(
                        $this->getForm()->getValueStored($this->getName()));
    }

    public function getValueToUse() {
        if ($this->getValueUser() !== null)
            return $this->getValueUser();
        else if ($this->getValueStored() !== null)
            return $this->getValueStored();
        else
            return $this->getValueDefault();
    }

    /**
     *
     * @return html\Input
     */
    public function getControlElement() {
        return $this->control;
    }

    /**
     *
     * @param string $name
     * @param string $title
     * @param html\Interface_\Submittable $control
     */
    public function init($name, $title, $control, $idSuffix = null) {
        $this->name = $name;
        $this->title = $title;
        $this->control = $control;
        $this->idSuffix = $idSuffix;
        if (strlen($title) > 0)
            $this->setAccessKey(mb_substr($title, 0, 1));
    }

    /**
     *
     * @return TemplateFormField
     * @throws exception\NotLazyEnough
     * @throws exception\AppendageTypeError
     */
    public function getFieldTemplateClone($special = null) {

        $appendageName = form_\FormPost::FORM_FIELD_TEMPLATE . '_' . $special;

        if (!$this->existsInheritableAppendage($appendageName)) {
            $appendageName = form_\FormPost::FORM_FIELD_TEMPLATE;
        }

        $template = $this->getInheritableAppendage($appendageName);

        if ($template instanceof TemplateFormField) {
            return clone $template;
        } elseif ($template === null) {
            throw new exception\NotLazyEnough(
            sprintf(
                    'There is no "%s" available for this Input', $appendageName
            )
            );
        } else {
            throw new exception\AppendageTypeError(
            sprintf(
                    'Not an istance of TemplateFormFieldSingle "%s"', $appendageName
            )
            );
        }
    }

    public function describe() {
        return 'INPUT';
    }

    /**
     *
     * @return string
     */
    public function __toString() {
        if (!$this->filled)
            $this->fill();

        return parent::__toString();
    }

    abstract public function fill();

    public function setForm(Form $form) {
        $this->control->setAttribute('form', $form->getHtmlName());
        $this->addInheritableAppendage('_FORM', $form);
        $form->addLogicalChild($this);
    }

    public function setAccessKey($key) {
        $this->getControlElement()->setAttribute('accesskey', $key);
    }

    public function getHtmlTitle() {
        $accessKey = $this->getControlElement()->getAttribute('accesskey');
        if (strlen($accessKey) !== 1) {
            return new html\Str($this->title);
        } else {
            $matches = [];
            if (preg_match('/^(.*?)(' . $accessKey . ')(.*)$/iu', $this->title, $matches)) {
                $container = new form_\Container;

                $u = new html\U();
                $u->addChild(new html\Str($matches[2]));

                $container->addChild(new html\Str($matches[1]));
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
                $container->addChild($u);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
                $container->addChild(new html\Str($matches[3]));
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

                return $container;
            } else {
                $container = new form_\Container;
                $container->addChild(new html\Str($this->title . ' ('));
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

                $u = new html\U();
                $u->addChild(new html\Str($accessKey));

                $container->addChild($u);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

                $container->addChild(new html\Str(')'));
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

                return $container;
            }
        }
    }

    protected $autofocusLevel = 5;

    /**
     *
     * @param bool $focus
     */
    public function setAutofocus($focus = true, $level = 10) {
        if ($focus)
            $this->autofocusLevel = $level;
        else
            $this->autofocusLevel = 0;
    }

    public function getAutofocusLevel() {
        return $this->autofocusLevel;
    }

    public function engageAutofocus() {
        $this->getControlElement()->setAttribute('autofocus', true);
    }

    /**
     *
     * @param boolean $required
     */
    public function setRequired($required = true) {
        $this->addValidityCheck(new form_\CheckMinLength(1));
        $this->required = $required;
        $this->getControlElement()->setAttribute('required', (boolean) $required);
    }

}


1			<?php
2
3			namespace hemio\form\Abstract_;
4
5			use hemio\form as form_;
6			use hemio\form\exception;
7			use hemio\html;
8
9			/**
10			*
11			*
12			*/
13			abstract class FormFieldDefault extends FormField implements form_\Focusable {
14
15
16			/**
17			*
18			* @var string
19			*/
20			public $title = '';
21
22			/**
23			*
24			* @var boolean
25			*/
26			protected $filled = false;
27
28			/**
29			*
30			* @var html\Interface_\Submittable
31			*/
32			protected $control;
33
34			/**
35			*
36			* @var string
37			*/
38			protected $defaultValue = '';
39
40			/**
41			*
42			* @param mixed $value
43			*/
44			public function setDefaultValue($value) {
45			$this->defaultValue = $value;
46			}
47
48			/**
49			* @return mixed Default value
50			*/
51			public function getValueDefault() {
52			return $this->withTransformations($this->defaultValue);
53			}
54
55			public function getValueStored() {
56			return $this->withTransformations(
57			$this->getForm()->getValueStored($this->getName()));
58			}
59
60			public function getValueToUse() {
61			if ($this->getValueUser() !== null)
62			return $this->getValueUser();
63			else if ($this->getValueStored() !== null)
64			return $this->getValueStored();
65			else
66			return $this->getValueDefault();
67			}
68
69			/**
70			*
71			* @return html\Input
72			*/
73			public function getControlElement() {
74			return $this->control;
75			}
76
77			/**
78			*
79			* @param string $name
80			* @param string $title
81			* @param html\Interface_\Submittable $control
82			*/
83			public function init($name, $title, $control, $idSuffix = null) {
84			$this->name = $name;
85			$this->title = $title;
86			$this->control = $control;
87			$this->idSuffix = $idSuffix;
88			if (strlen($title) > 0)
89			$this->setAccessKey(mb_substr($title, 0, 1));
90			}
91
92			/**
93			*
94			* @return TemplateFormField
95			* @throws exception\NotLazyEnough
96			* @throws exception\AppendageTypeError
97			*/
98			public function getFieldTemplateClone($special = null) {
99
100			$appendageName = form_\FormPost::FORM_FIELD_TEMPLATE . '_' . $special;
101
102			if (!$this->existsInheritableAppendage($appendageName)) {
103			$appendageName = form_\FormPost::FORM_FIELD_TEMPLATE;
104			}
105
106			$template = $this->getInheritableAppendage($appendageName);
107
108			if ($template instanceof TemplateFormField) {
109			return clone $template;
110			} elseif ($template === null) {
111			throw new exception\NotLazyEnough(
112			sprintf(
113			'There is no "%s" available for this Input', $appendageName
114			)
115			);
116			} else {
117			throw new exception\AppendageTypeError(
118			sprintf(
119			'Not an istance of TemplateFormFieldSingle "%s"', $appendageName
120			)
121			);
122			}
123			}
124
125			public function describe() {
126			return 'INPUT';
127			}
128
129			/**
130			*
131			* @return string
132			*/
133			public function __toString() {
134			if (!$this->filled)
135			$this->fill();
136
137			return parent::__toString();
138			}
139
140			abstract public function fill();
141
142			public function setForm(Form $form) {
143			$this->control->setAttribute('form', $form->getHtmlName());
144			$this->addInheritableAppendage('_FORM', $form);
145			$form->addLogicalChild($this);
146			}
147
148			public function setAccessKey($key) {
149			$this->getControlElement()->setAttribute('accesskey', $key);
150			}
151
152			public function getHtmlTitle() {
153			$accessKey = $this->getControlElement()->getAttribute('accesskey');
154			if (strlen($accessKey) !== 1) {
155			return new html\Str($this->title);
156			} else {
157			$matches = [];
158			if (preg_match('/^(.?)(' . $accessKey . ')(.)$/iu', $this->title, $matches)) {
159			$container = new form_\Container;
160
161			$u = new html\U();
162			$u->addChild(new html\Str($matches[2]));
163
164			$container->addChild(new html\Str($matches[1]));
			0 ignored issues – show Unused Code introduced 2016-10-12 14:54 UTC by Report Bug Copy Issue Report The call to the method `hemio\form\Container::addChild()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
165			$container->addChild($u);
			0 ignored issues – show Unused Code introduced 2016-10-12 14:54 UTC by Report Bug Copy Issue Report The call to the method `hemio\form\Container::addChild()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
166			$container->addChild(new html\Str($matches[3]));
			0 ignored issues – show Unused Code introduced 2016-10-12 14:54 UTC by Report Bug Copy Issue Report The call to the method `hemio\form\Container::addChild()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
167
168			return $container;
169			} else {
170			$container = new form_\Container;
171			$container->addChild(new html\Str($this->title . ' ('));
			0 ignored issues – show Unused Code introduced 2016-10-12 14:54 UTC by Report Bug Copy Issue Report The call to the method `hemio\form\Container::addChild()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
172
173			$u = new html\U();
174			$u->addChild(new html\Str($accessKey));
175
176			$container->addChild($u);
			0 ignored issues – show Unused Code introduced 2016-10-12 14:54 UTC by Report Bug Copy Issue Report The call to the method `hemio\form\Container::addChild()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
177
178			$container->addChild(new html\Str(')'));
			0 ignored issues – show Unused Code introduced 2016-10-12 14:54 UTC by Report Bug Copy Issue Report The call to the method `hemio\form\Container::addChild()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
179
180			return $container;
181			}
182			}
183			}
184
185			protected $autofocusLevel = 5;
186
187			/**
188			*
189			* @param bool $focus
190			*/
191			public function setAutofocus($focus = true, $level = 10) {
192			if ($focus)
193			$this->autofocusLevel = $level;
194			else
195			$this->autofocusLevel = 0;
196			}
197
198			public function getAutofocusLevel() {
199			return $this->autofocusLevel;
200			}
201
202			public function engageAutofocus() {
203			$this->getControlElement()->setAttribute('autofocus', true);
204			}
205
206			/**
207			*
208			* @param boolean $required
209			*/
210			public function setRequired($required = true) {
211			$this->addValidityCheck(new form_\CheckMinLength(1));
212			$this->required = $required;
213			$this->getControlElement()->setAttribute('required', (boolean) $required);
214			}
215
216			}
217

qua-bla / form

FormFieldDefault::getValueToUse() A last analyzed 2016-10-13 09:50 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FormFieldDefault::getValueToUse() A
last analyzed 2016-10-13 09:50 UTC