TextField::getTip() - Code Metrics - Inspection of "Merge pull request #9281 from creative-commoners/p..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 4 ( e6ea10...17f4cc )

by Garion

created 2019-10-23 03:50 UTC

TextField::getTip() A

↳ Parent: TextField

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

namespace SilverStripe\Forms;

use SilverStripe\Dev\Deprecation;

/**
 * Text input field.
 */
class TextField extends FormField implements TippableFieldInterface
{
    /**
     * @var int
     */
    protected $maxLength;

    protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TEXT;

    /**
     * @var Tip|null A tip to render beside the input
     */
    private $tip;

    /**
     * Returns an input field.
     *
     * @param string $name
     * @param null|string $title
     * @param string $value
     * @param null|int $maxLength Max characters to allow for this field. If this value is stored
     * against a DB field with a fixed size it's recommended to set an appropriate max length
     * matching this size.
     * @param null|Form $form
     */
    public function __construct($name, $title = null, $value = '', $maxLength = null, $form = null)
    {
        if ($maxLength) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $this->setMaxLength($maxLength);
        }

        if ($form) {
            $this->setForm($form);
        }

        parent::__construct($name, $title, $value);
    }

    /**
     * @param int $maxLength
     * @return $this
     */
    public function setMaxLength($maxLength)
    {
        $this->maxLength = $maxLength;

        return $this;
    }

    /**
     * @return null|int
     */
    public function getMaxLength()
    {
        return $this->maxLength;
    }

    /**
     * @return Tip|null
     */
    public function getTip(): ?Tip
    {
        return $this->tip;
    }

    /**
     * Applies a Tip to the field, which shows a popover on the right side of
     * the input to place additional context or explanation of the field's
     * purpose in. Currently only supported in React-based forms.
     *
     * @param Tip|null $tip The Tip to apply, or null to remove an existing one
     * @return $this
     */
    public function setTip(?Tip $tip = null): self
    {
        $this->tip = $tip;

        return $this;
    }

    /**
     * @return array
     */
    public function getAttributes()
    {
        $maxLength = $this->getMaxLength();

        $attributes = array();

        if ($maxLength) {
            $attributes['maxLength'] = $maxLength;
            $attributes['size'] = min($maxLength, 30);
        }

        return array_merge(
            parent::getAttributes(),
            $attributes
        );
    }

    public function getSchemaDataDefaults()
    {
        $data = parent::getSchemaDataDefaults();
        $data['data']['maxlength'] =  $this->getMaxLength();

        if ($this->getTip() instanceof Tip) {
            $data['tip'] = $this->getTip()->getTipSchema();
        }

        return $data;
    }

    /**
     * @return string
     */
    public function InternallyLabelledField()
    {
        Deprecation::notice('4.0', 'Please use ->setValue() instead');

        if (!$this->value) {
            $this->value = $this->Title();
        }

        return $this->Field();
    }

    /**
     * Validate this field
     *
     * @param Validator $validator
     * @return bool
     */
    public function validate($validator)
    {
        if (!is_null($this->maxLength) && mb_strlen($this->value) > $this->maxLength) {

            $validator->validationError(
                $this->name,
                _t(
                    'SilverStripe\\Forms\\TextField.VALIDATEMAXLENGTH',
                    'The value for {name} must not exceed {maxLength} characters in length',
                    array('name' => $this->getName(), 'maxLength' => $this->maxLength)
                ),
                "validation"
            );
            return false;
        }
        return true;
    }

    public function getSchemaValidation()
    {
        $rules = parent::getSchemaValidation();
        if ($this->getMaxLength()) {
            $rules['max'] = [
                'length' => $this->getMaxLength(),
            ];
        }
        return $rules;
    }
}


1			<?php
2
3			namespace SilverStripe\Forms;
4
5			use SilverStripe\Dev\Deprecation;
6
7			/**
8			* Text input field.
9			*/
10			class TextField extends FormField implements TippableFieldInterface
11			{
12			/**
13			* @var int
14			*/
15			protected $maxLength;
16
17			protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TEXT;
18
19			/**
20			* @var Tip\|null A tip to render beside the input
21			*/
22			private $tip;
23
24			/**
25			* Returns an input field.
26			*
27			* @param string $name
28			* @param null\|string $title
29			* @param string $value
30			* @param null\|int $maxLength Max characters to allow for this field. If this value is stored
31			* against a DB field with a fixed size it's recommended to set an appropriate max length
32			* matching this size.
33			* @param null\|Form $form
34			*/
35			public function __construct($name, $title = null, $value = '', $maxLength = null, $form = null)
36			{
37			if ($maxLength) {
			0 ignored issues – show Bug Best Practice introduced 2018-10-19 16:08 UTC by Report Bug Copy Issue Report The expression `$maxLength` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
38			$this->setMaxLength($maxLength);
39			}
40
41			if ($form) {
42			$this->setForm($form);
43			}
44
45			parent::__construct($name, $title, $value);
46			}
47
48			/**
49			* @param int $maxLength
50			* @return $this
51			*/
52			public function setMaxLength($maxLength)
53			{
54			$this->maxLength = $maxLength;
55
56			return $this;
57			}
58
59			/**
60			* @return null\|int
61			*/
62			public function getMaxLength()
63			{
64			return $this->maxLength;
65			}
66
67			/**
68			* @return Tip\|null
69			*/
70			public function getTip(): ?Tip
71			{
72			return $this->tip;
73			}
74
75			/**
76			* Applies a Tip to the field, which shows a popover on the right side of
77			* the input to place additional context or explanation of the field's
78			* purpose in. Currently only supported in React-based forms.
79			*
80			* @param Tip\|null $tip The Tip to apply, or null to remove an existing one
81			* @return $this
82			*/
83			public function setTip(?Tip $tip = null): self
84			{
85			$this->tip = $tip;
86
87			return $this;
88			}
89
90			/**
91			* @return array
92			*/
93			public function getAttributes()
94			{
95			$maxLength = $this->getMaxLength();
96
97			$attributes = array();
98
99			if ($maxLength) {
100			$attributes['maxLength'] = $maxLength;
101			$attributes['size'] = min($maxLength, 30);
102			}
103
104			return array_merge(
105			parent::getAttributes(),
106			$attributes
107			);
108			}
109
110			public function getSchemaDataDefaults()
111			{
112			$data = parent::getSchemaDataDefaults();
113			$data['data']['maxlength'] = $this->getMaxLength();
114
115			if ($this->getTip() instanceof Tip) {
116			$data['tip'] = $this->getTip()->getTipSchema();
117			}
118
119			return $data;
120			}
121
122			/**
123			* @return string
124			*/
125			public function InternallyLabelledField()
126			{
127			Deprecation::notice('4.0', 'Please use ->setValue() instead');
128
129			if (!$this->value) {
130			$this->value = $this->Title();
131			}
132
133			return $this->Field();
134			}
135
136			/**
137			* Validate this field
138			*
139			* @param Validator $validator
140			* @return bool
141			*/
142			public function validate($validator)
143			{
144			if (!is_null($this->maxLength) && mb_strlen($this->value) > $this->maxLength) {
			0 ignored issues – show introduced 2018-10-19 16:08 UTC by Report Bug Copy Issue Report The condition `is_null($this->maxLength)` is always `false`. Loading history...
145			$validator->validationError(
146			$this->name,
147			_t(
148			'SilverStripe\\Forms\\TextField.VALIDATEMAXLENGTH',
149			'The value for {name} must not exceed {maxLength} characters in length',
150			array('name' => $this->getName(), 'maxLength' => $this->maxLength)
151			),
152			"validation"
153			);
154			return false;
155			}
156			return true;
157			}
158
159			public function getSchemaValidation()
160			{
161			$rules = parent::getSchemaValidation();
162			if ($this->getMaxLength()) {
163			$rules['max'] = [
164			'length' => $this->getMaxLength(),
165			];
166			}
167			return $rules;
168			}
169			}
170

silverstripe / silverstripe-framework

Push — 4 ( e6ea10...17f4cc )

TextField::getTip() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like