base::is_too_short() - Code Metrics - Inspection of "Field-specific settings/properties" - blitze/phpBB-ext-sitemaker_content - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 6a0b8a...755a17 )

by Daniel

created 2017-06-24 04:36 UTC

base::is_too_short() A

↳ Parent: base

Complexity

Conditions	3
Paths	4

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	3
eloc	2
nc	4
nop	2
crap	12

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\content\services\form\field;

abstract class base implements field_interface
{
	/** @var \phpbb\language\language */
	protected $language;

	/** @var \phpbb\request\request_interface */
	protected $request;

	/** @var \blitze\sitemaker\services\template */
	protected $ptemplate;

	/**
	 * Constructor
	 *
	 * @param \phpbb\language\language                  $language       Language object
	 * @param \phpbb\request\request_interface			$request		Request object
	 * @param \blitze\sitemaker\services\template		$ptemplate		Sitemaker template object
	 */
	public function __construct(\phpbb\language\language $language, \phpbb\request\request_interface $request, \blitze\sitemaker\services\template $ptemplate)
	{
		$this->language = $language;
		$this->request = $request;
		$this->ptemplate = $ptemplate;
	}

	/**
	 * @inheritdoc
	 */
	public function get_default_props()
	{
		return array();
	}

	/**
	 * @inheritdoc
	 */
	public function display_field(array $data)
	{
		return $data['field_value'];
	}

	/**
	 * @inheritdoc
	 */
	public function get_field_value($name, $value, $display = 'form')
	{
		return $this->request->variable($name, $value, true);
	}

	/**
	 * @inheritdoc
	 */
	public function show_form_field($name, array &$data)
	{
		$data['field_name'] = $name;
		$data['field_value'] = $this->get_field_value($name, $data['field_value']);

		$this->ptemplate->assign_vars($data);

		$field = $this->get_name();
		return $this->ptemplate->render_view('blitze/content', "fields/$field.twig", $field . '_field');
	}

	/**
	 * @inheritdoc
	 */
	public function save_field($field, $value)
	{
		return false;
	}

	/**
	 * @inheritdoc
	 */
	public function get_langname()
	{
		return strtoupper('FORM_FIELD_' . $this->get_name());
	}

	/**
	 * @inheritdoc
	 */
	public function validate_field(array $data)
	{
		$options = $this->get_filter_options($data);

		$message = '';
		if (isset($data['validation_filter']) && !filter_var($data['field_value'], $data['validation_filter'], $options))
		{
			$message = $this->get_error_message($data);
		}

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

	/**
	 * @param array $data
	 * @return array|false
	 */
	protected function get_filter_options(array &$data)
	{
		if (isset($data['field_minlength']))
		{
			$data['validation_options'] += array('min_range' => $data['field_minlength']);
		}

		if (isset($data['field_maxlength']))
		{
			$data['validation_options'] += array('max_range' => $data['field_maxlength']);
		}

		return (isset($data['validation_options'])) ? array('options' => $data['validation_options']) : false;
	}

	/**
	 * @param array $data
	 * @return string
	 */
	protected function get_error_message(array $data)
	{
		$length = utf8_strlen($data['field_value']);

		if ($this->is_too_short($data, $length))
		{
			return $this->language->lang('FIELD_TOO_SHORT', $data['field_label'], $data['field_minlength']);
		}
		else if ($this->is_too_long($data, $length))
		{
			return $this->language->lang('FIELD_TOO_LONG', $data['field_label'], $data['field_maxlength']);
		}
		else
		{
			return $this->language->lang('FIELD_INVALID', $data['field_label']);
		}
	}

	/**
	 * @param array $data
	 * @param $length
	 * @return bool
	 */
	protected function is_too_short(array $data, $length)
	{
		return (isset($data['field_minlength']) && $length < $data['field_minlength']) ? true : false;
	}

	/**
	 * @param array $data
	 * @param $length
	 * @return bool
	 */
	protected function is_too_long(array $data, $length)
	{
		return (isset($data['field_maxlength']) && $length > $data['field_maxlength']) ? true : false;
	}
}


1		<?php
2		/**
3		*
4		* @package sitemaker
5		* @copyright (c) 2013 Daniel A. (blitze)
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace blitze\content\services\form\field;
11
12		abstract class base implements field_interface
13		{
14		/** @var \phpbb\language\language */
15		protected $language;
16
17		/** @var \phpbb\request\request_interface */
18		protected $request;
19
20		/** @var \blitze\sitemaker\services\template */
21		protected $ptemplate;
22
23		/**
24		* Constructor
25		*
26		* @param \phpbb\language\language $language Language object
27		* @param \phpbb\request\request_interface $request Request object
28		* @param \blitze\sitemaker\services\template $ptemplate Sitemaker template object
29		*/
30	64	public function __construct(\phpbb\language\language $language, \phpbb\request\request_interface $request, \blitze\sitemaker\services\template $ptemplate)
31		{
32	64	$this->language = $language;
33	64	$this->request = $request;
34	64	$this->ptemplate = $ptemplate;
35	64	}
36
37		/**
38		* @inheritdoc
39		*/
40	4	public function get_default_props()
41		{
42	4	return array();
43		}
44
45		/**
46		* @inheritdoc
47		*/
48	8	public function display_field(array $data)
49		{
50	8	return $data['field_value'];
51		}
52
53		/**
54		* @inheritdoc
55		*/
56	11	public function get_field_value($name, $value, $display = 'form')
57		{
58	11	return $this->request->variable($name, $value, true);
59		}
60
61		/**
62		* @inheritdoc
63		*/
64	17	public function show_form_field($name, array &$data)
65		{
66	17	$data['field_name'] = $name;
67	17	$data['field_value'] = $this->get_field_value($name, $data['field_value']);
68
69	17	$this->ptemplate->assign_vars($data);
70
71	17	$field = $this->get_name();
72	17	return $this->ptemplate->render_view('blitze/content', "fields/$field.twig", $field . '_field');
73		}
74
75		/**
76		* @inheritdoc
77		*/
78		public function save_field($field, $value)
79		{
80		return false;
81		}
82
83		/**
84		* @inheritdoc
85		*/
86	9	public function get_langname()
87		{
88	9	return strtoupper('FORM_FIELD_' . $this->get_name());
89		}
90
91		/**
92		* @inheritdoc
93		*/
94		public function validate_field(array $data)
95		{
96		$options = $this->get_filter_options($data);
97
98		$message = '';
99		if (isset($data['validation_filter']) && !filter_var($data['field_value'], $data['validation_filter'], $options))
100		{
101		$message = $this->get_error_message($data);
102		}
103
104		return $message;
		0 ignored issues – show Bug Best Practice introduced 2017-01-13 20:17 UTC by Report Bug Copy Issue Report The return type of `return $message;` (`string`) is incompatible with the return type declared by the interface `blitze\content\services\...terface::validate_field` of type `boolean`. 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...
105		}
106
107		/**
108		* @param array $data
109		* @return array\|false
110		*/
111		protected function get_filter_options(array &$data)
112		{
113		if (isset($data['field_minlength']))
114		{
115		$data['validation_options'] += array('min_range' => $data['field_minlength']);
116		}
117
118		if (isset($data['field_maxlength']))
119		{
120		$data['validation_options'] += array('max_range' => $data['field_maxlength']);
121		}
122
123		return (isset($data['validation_options'])) ? array('options' => $data['validation_options']) : false;
124		}
125
126		/**
127		* @param array $data
128		* @return string
129		*/
130		protected function get_error_message(array $data)
131		{
132		$length = utf8_strlen($data['field_value']);
133
134		if ($this->is_too_short($data, $length))
135		{
136		return $this->language->lang('FIELD_TOO_SHORT', $data['field_label'], $data['field_minlength']);
137		}
138		else if ($this->is_too_long($data, $length))
139		{
140		return $this->language->lang('FIELD_TOO_LONG', $data['field_label'], $data['field_maxlength']);
141		}
142		else
143		{
144		return $this->language->lang('FIELD_INVALID', $data['field_label']);
145		}
146		}
147
148		/**
149		* @param array $data
150		* @param $length
151		* @return bool
152		*/
153		protected function is_too_short(array $data, $length)
154		{
155		return (isset($data['field_minlength']) && $length < $data['field_minlength']) ? true : false;
156		}
157
158		/**
159		* @param array $data
160		* @param $length
161		* @return bool
162		*/
163		protected function is_too_long(array $data, $length)
164		{
165		return (isset($data['field_maxlength']) && $length > $data['field_maxlength']) ? true : false;
166		}
167		}
168

blitze / phpBB-ext-sitemaker_content

Push — develop ( 6a0b8a...755a17 )

base::is_too_short() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like