DateTimeField::parseInput() - Code Metrics - mindplay-dk/kissform - Measure and Improve Code Quality continuously with Scrutinizer

DateTimeField::parseInput() A
last analyzed 2018-03-20 08:07 UTC

↳ Parent: DateTimeField

Complexity

Conditions	3
Paths	4

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
ccs	5
cts	5
cp	1
rs	9.4285
cc	3
eloc	5
nc	4
nop	1
crap	3

<?php

namespace mindplay\kissform\Fields;

use DateTime;
use InvalidArgumentException;
use mindplay\kissform\Facets\ParserInterface;
use mindplay\kissform\Fields\Base\TimeZoneAwareField;
use mindplay\kissform\InputModel;
use mindplay\kissform\InputRenderer;
use mindplay\kissform\Validators\CheckParser;
use UnexpectedValueException;

/**
 * Date/time field-type for string-based input.
 */
class DateTimeField extends TimeZoneAwareField implements ParserInterface
{
    /**
     * @var string input date/time format string
     */
    public $format;

    /**
     * @var string[] map of HTML attributes to apply
     */
    public $attrs;

    /**
     * @param string $name     field name
     * @param string $timezone timezone name
     * @param string $format   date/time format compatible with the date() function
     * @param array  $attrs    map of HTML attribtues to apply
     *
     * @see date()
     */
    public function __construct($name, $timezone, $format, $attrs = [])
    {
        parent::__construct($name);

        $this->setTimeZone($timezone);

        $this->format = $format;
        $this->attrs = $attrs;
    }

    /**
     * @param string $input
     *
     * @return int|null
     */
    public function parseInput($input)
    {
        $time = @date_create_from_format($this->format, $input, $this->timezone);

        return $time && ($time->format($this->format) == $input)
            ? $time->getTimestamp()
            : null;
    }

    /**
     * @param InputModel $model
     *
     * @return int|null timestamp
     *
     * @throws UnexpectedValueException if unable to parse the input
     */
    public function getValue(InputModel $model)
    {
        $input = $model->getInput($this);

        if (empty($input)) {
            return null;
        } else {
            $value = $this->parseInput($input);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

            if ($value === null) {
                throw new UnexpectedValueException("invalid input");
            }

            return $value;
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 InputModel $model
     * @param int|null   $value timestamp
     *
     * @return void
     *
     * @throws InvalidArgumentException if the given value is unacceptable.
     */
    public function setValue(InputModel $model, $value)
    {
        if ($value === null) {
            $model->setInput($this, null);
        } elseif (is_int($value)) {
            $date = new DateTime();
            $date->setTimestamp($value);
            $date->setTimezone($this->timezone);

            $model->setInput($this, $date->format($this->format));
        } else {
            throw new InvalidArgumentException("integer timestamp expected");
        }
    }

    /**
     * {@inheritdoc}
     */
    public function renderInput(InputRenderer $renderer, InputModel $model, array $attr)
    {
        return $renderer->inputFor($this, 'text', $attr + $this->attrs);
    }

    /**
     * {@inheritdoc}
     */
    public function createValidators()
    {
        $validators = parent::createValidators();

        $validators[] = new CheckParser($this, "datetime");
        
        return $validators;
    }
}


1		<?php
2
3		namespace mindplay\kissform\Fields;
4
5		use DateTime;
6		use InvalidArgumentException;
7		use mindplay\kissform\Facets\ParserInterface;
8		use mindplay\kissform\Fields\Base\TimeZoneAwareField;
9		use mindplay\kissform\InputModel;
10		use mindplay\kissform\InputRenderer;
11		use mindplay\kissform\Validators\CheckParser;
12		use UnexpectedValueException;
13
14		/**
15		* Date/time field-type for string-based input.
16		*/
17		class DateTimeField extends TimeZoneAwareField implements ParserInterface
18		{
19		/**
20		* @var string input date/time format string
21		*/
22		public $format;
23
24		/**
25		* @var string[] map of HTML attributes to apply
26		*/
27		public $attrs;
28
29		/**
30		* @param string $name field name
31		* @param string $timezone timezone name
32		* @param string $format date/time format compatible with the date() function
33		* @param array $attrs map of HTML attribtues to apply
34		*
35		* @see date()
36		*/
37	5	public function __construct($name, $timezone, $format, $attrs = [])
38		{
39	5	parent::__construct($name);
40
41	5	$this->setTimeZone($timezone);
42
43	5	$this->format = $format;
44	5	$this->attrs = $attrs;
45	5	}
46
47		/**
48		* @param string $input
49		*
50		* @return int\|null
51		*/
52	2	public function parseInput($input)
53		{
54	2	$time = @date_create_from_format($this->format, $input, $this->timezone);
55
56	2	return $time && ($time->format($this->format) == $input)
57	2	? $time->getTimestamp()
58	2	: null;
59		}
60
61		/**
62		* @param InputModel $model
63		*
64		* @return int\|null timestamp
65		*
66		* @throws UnexpectedValueException if unable to parse the input
67		*/
68	1	public function getValue(InputModel $model)
69		{
70	1	$input = $model->getInput($this);
71
72	1	if (empty($input)) {
73	1	return null;
74		} else {
75	1	$value = $this->parseInput($input);
		0 ignored issues – show Bug introduced 2016-04-15 12:37 UTC by Report Bug Copy Issue Report It seems like `$input` defined by `$model->getInput($this)` on line `70` can also be of type `array`; however, `mindplay\kissform\Fields...TimeField::parseInput()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
76
77	1	if ($value === null) {
78		throw new UnexpectedValueException("invalid input");
79		}
80
81	1	return $value;
		0 ignored issues – show Bug Best Practice introduced 2016-04-15 12:37 UTC by Report Bug Copy Issue Report The return type of `return $value;` (`integer`) is incompatible with the return type of the parent method `mindplay\kissform\Field::getValue` of type `string\|array\|null`. 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...
82		}
83		}
84
85		/**
86		* @param InputModel $model
87		* @param int\|null $value timestamp
88		*
89		* @return void
90		*
91		* @throws InvalidArgumentException if the given value is unacceptable.
92		*/
93	3	public function setValue(InputModel $model, $value)
94		{
95	3	if ($value === null) {
96	1	$model->setInput($this, null);
97	3	} elseif (is_int($value)) {
98	3	$date = new DateTime();
99	3	$date->setTimestamp($value);
100	3	$date->setTimezone($this->timezone);
101
102	3	$model->setInput($this, $date->format($this->format));
103		} else {
104	1	throw new InvalidArgumentException("integer timestamp expected");
105		}
106	3	}
107
108		/**
109		* {@inheritdoc}
110		*/
111	2	public function renderInput(InputRenderer $renderer, InputModel $model, array $attr)
112		{
113	2	return $renderer->inputFor($this, 'text', $attr + $this->attrs);
114		}
115
116		/**
117		* {@inheritdoc}
118		*/
119	1	public function createValidators()
120		{
121	1	$validators = parent::createValidators();
122
123	1	$validators[] = new CheckParser($this, "datetime");
124
125	1	return $validators;
126		}
127		}
128

mindplay-dk / kissform

DateTimeField::parseInput() A last analyzed 2018-03-20 08:07 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DateTimeField::parseInput() A
last analyzed 2018-03-20 08:07 UTC