BuiltInFunctionsExtension::getName() - Code Metrics - Inspection of "Removed getName() method from TableBundleExtension..." - netdudes/DataSourceryBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

unknown

created 2016-01-08 11:58 UTC

BuiltInFunctionsExtension::getName() A

↳ Parent: BuiltInFunctionsExtension::getFunctions()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Netdudes\DataSourceryBundle\Extension;

use Netdudes\DataSourceryBundle\Extension\Type\UqlFunction;
use Netdudes\DataSourceryBundle\Util\CurrentDateTimeProvider;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

class BuiltInFunctionsExtension implements UqlExtensionInterface
{
    /**
     * @var TokenStorageInterface
     */
    private $tokenStorage;

    /**
     * @var CurrentDateTimeProvider
     */
    private $dateTimeProvider;

    /**
     * @param TokenStorageInterface   $tokenStorage
     * @param CurrentDateTimeProvider $dateTimeProvider
     */
    public function __construct(TokenStorageInterface $tokenStorage, CurrentDateTimeProvider $dateTimeProvider)
    {
        $this->tokenStorage = $tokenStorage;
        $this->dateTimeProvider = $dateTimeProvider;
    }

    /**
     * {@inheritdoc}
     */
    public function getFunctions()
    {
        return [
            new UqlFunction('now', $this, 'now'),
            new UqlFunction('startOfDay', $this, 'startOfDay'),
            new UqlFunction('startOfWeek', $this, 'startOfWeek'),
            new UqlFunction('startOfMonth', $this, 'startOfMonth'),
            new UqlFunction('startOfYear', $this, 'startOfYear'),
            new UqlFunction('currentUser', $this, 'currentUser'),
            new UqlFunction('random', $this, 'random')
        ];
    }

    /**
     * Gets the current timestamp, with an offset string
     *
     * @param string $offset
     *
     * @return string
     * @throws \Exception
     */
    public function now($offset = null)
    {
        $now = clone $this->dateTimeProvider->get();

        if ($offset) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $interval = \DateInterval::createFromDateString($offset);
            $now->add($interval);

            if ($now == $this->dateTimeProvider->get()) {
                // The date didn't change therefore we assume the given offset is not valid
                throw new \Exception($offset . ' is not a valid date/time interval.');
            }
        }

        return $now->format(\DateTime::ISO8601);
    }

    /**
     * Gets a date with the hour 00:00:00
     *
     * @param string $date
     *
     * @return string
     * @throws \Exception
     */
    public function startOfDay($date = null)
    {
        $now = clone $this->dateTimeProvider->get();

        if ($date) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $now = $this->modifyDate($now, $date);
        }

        $now->setTime(0, 0, 0);

        return $now->format(\DateTime::ISO8601);
    }

    /**
     * Gets the Monday of the week for the specified date with the hour 00:00:00
     *
     * @param string $date
     *
     * @return string
     * @throws \Exception
     */
    public function startOfWeek($date = null)

    {
        $now = clone $this->dateTimeProvider->get();

        if ($date) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $now = $this->modifyDate($now, $date);
        }

        $year = $now->format('o'); // o = ISO-8601 year number
        $week = $now->format('W'); // W = ISO-8601 week number of year, weeks starting on Monday

        $startOfWeek = $now->setISODate($year, $week);
        $startOfWeek->setTime(0, 0, 0);

        return $startOfWeek->format(\DateTime::ISO8601);
    }

    /**
     * Gets the first day of the month for the specified date with the hour 00:00:00
     *
     * @param string $date
     *
     * @return string
     * @throws \Exception
     */
    public function startOfMonth($date = null)

    {
        $now = clone $this->dateTimeProvider->get();

        if ($date) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $now = $this->modifyDate($now, $date);
        }

        $year = $now->format('Y');
        $month = $now->format('m');

        $startOfMonth = $now->setDate($year, $month, 1);
        $startOfMonth->setTime(0, 0, 0);

        return $startOfMonth->format(\DateTime::ISO8601);
    }

    /**
     * Gets the first day of the year for the specified date with the hour 00:00:00
     *
     * @param string $date
     *
     * @return string
     * @throws \Exception
     */
    public function startOfYear($date = null)
    {
        $now = clone $this->dateTimeProvider->get();

        if ($date) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $now = $this->modifyDate($now, $date);
        }

        $year = $now->format('Y');

        $startOfYear = $now->setDate($year, 1, 1);
        $startOfYear->setTime(0, 0, 0);

        return $startOfYear->format(\DateTime::ISO8601);
    }

    /**
     * Gets the current users' username
     *
     * @return string
     */
    public function currentUser()
    {
        return $this->tokenStorage->getToken()->getUsername();
    }

    /**
     * Gets a random value between $min and $max
     *
     * @param int $min
     * @param int $max
     *
     * @return int
     */
    public function random($min = 0, $max = 10)
    {
        return rand($min, $max);
    }

    /**
     * @param \DateTime $date
     * @param string    $change
     *
     * @return \DateTime
     * @throws \Exception
     */
    private function modifyDate(\DateTime $date, $change)
    {
        try {
            $date->modify($change);
        } catch (\Exception $e) {
            throw new \Exception($change . ' is not a valid date or date offset.');
        }

        return ($date);
    }
}


1		<?php
2
3		namespace Netdudes\DataSourceryBundle\Extension;
4
5		use Netdudes\DataSourceryBundle\Extension\Type\UqlFunction;
6		use Netdudes\DataSourceryBundle\Util\CurrentDateTimeProvider;
7		use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
8
9		class BuiltInFunctionsExtension implements UqlExtensionInterface
10		{
11		/**
12		* @var TokenStorageInterface
13		*/
14		private $tokenStorage;
15
16		/**
17		* @var CurrentDateTimeProvider
18		*/
19		private $dateTimeProvider;
20
21		/**
22		* @param TokenStorageInterface $tokenStorage
23		* @param CurrentDateTimeProvider $dateTimeProvider
24		*/
25		public function __construct(TokenStorageInterface $tokenStorage, CurrentDateTimeProvider $dateTimeProvider)
26		{
27		$this->tokenStorage = $tokenStorage;
28		$this->dateTimeProvider = $dateTimeProvider;
29		}
30
31		/**
32		* {@inheritdoc}
33		*/
34		public function getFunctions()
35		{
36		return [
37		new UqlFunction('now', $this, 'now'),
38		new UqlFunction('startOfDay', $this, 'startOfDay'),
39		new UqlFunction('startOfWeek', $this, 'startOfWeek'),
40		new UqlFunction('startOfMonth', $this, 'startOfMonth'),
41		new UqlFunction('startOfYear', $this, 'startOfYear'),
42		new UqlFunction('currentUser', $this, 'currentUser'),
43		new UqlFunction('random', $this, 'random')
44		];
45		}
46
47		/**
48		* Gets the current timestamp, with an offset string
49		*
50		* @param string $offset
51		*
52		* @return string
53		* @throws \Exception
54		*/
55		public function now($offset = null)
56		{
57		$now = clone $this->dateTimeProvider->get();
58
59		if ($offset) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-10 16:34 UTC by Report Bug Copy Issue Report The expression `$offset` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
60		$interval = \DateInterval::createFromDateString($offset);
61		$now->add($interval);
62
63		if ($now == $this->dateTimeProvider->get()) {
64		// The date didn't change therefore we assume the given offset is not valid
65		throw new \Exception($offset . ' is not a valid date/time interval.');
66		}
67		}
68
69		return $now->format(\DateTime::ISO8601);
70		}
71
72		/**
73		* Gets a date with the hour 00:00:00
74		*
75		* @param string $date
76		*
77		* @return string
78		* @throws \Exception
79		*/
80		public function startOfDay($date = null)
81		{
82		$now = clone $this->dateTimeProvider->get();
83
84		if ($date) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-08 09:07 UTC by Report Bug Copy Issue Report The expression `$date` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
85		$now = $this->modifyDate($now, $date);
86		}
87
88		$now->setTime(0, 0, 0);
89
90		return $now->format(\DateTime::ISO8601);
91		}
92
93		/**
94		* Gets the Monday of the week for the specified date with the hour 00:00:00
95		*
96		* @param string $date
97		*
98		* @return string
99		* @throws \Exception
100		*/
101	View Code Duplication	public function startOfWeek($date = null)
		0 ignored issues – show Duplication introduced 2015-12-11 16:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
102		{
103		$now = clone $this->dateTimeProvider->get();
104
105		if ($date) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-08 09:07 UTC by Report Bug Copy Issue Report The expression `$date` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
106		$now = $this->modifyDate($now, $date);
107		}
108
109		$year = $now->format('o'); // o = ISO-8601 year number
110		$week = $now->format('W'); // W = ISO-8601 week number of year, weeks starting on Monday
111
112		$startOfWeek = $now->setISODate($year, $week);
113		$startOfWeek->setTime(0, 0, 0);
114
115		return $startOfWeek->format(\DateTime::ISO8601);
116		}
117
118		/**
119		* Gets the first day of the month for the specified date with the hour 00:00:00
120		*
121		* @param string $date
122		*
123		* @return string
124		* @throws \Exception
125		*/
126	View Code Duplication	public function startOfMonth($date = null)
		0 ignored issues – show Duplication introduced 2015-12-11 16:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
127		{
128		$now = clone $this->dateTimeProvider->get();
129
130		if ($date) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-08 09:07 UTC by Report Bug Copy Issue Report The expression `$date` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
131		$now = $this->modifyDate($now, $date);
132		}
133
134		$year = $now->format('Y');
135		$month = $now->format('m');
136
137		$startOfMonth = $now->setDate($year, $month, 1);
138		$startOfMonth->setTime(0, 0, 0);
139
140		return $startOfMonth->format(\DateTime::ISO8601);
141		}
142
143		/**
144		* Gets the first day of the year for the specified date with the hour 00:00:00
145		*
146		* @param string $date
147		*
148		* @return string
149		* @throws \Exception
150		*/
151		public function startOfYear($date = null)
152		{
153		$now = clone $this->dateTimeProvider->get();
154
155		if ($date) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-08 09:07 UTC by Report Bug Copy Issue Report The expression `$date` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
156		$now = $this->modifyDate($now, $date);
157		}
158
159		$year = $now->format('Y');
160
161		$startOfYear = $now->setDate($year, 1, 1);
162		$startOfYear->setTime(0, 0, 0);
163
164		return $startOfYear->format(\DateTime::ISO8601);
165		}
166
167		/**
168		* Gets the current users' username
169		*
170		* @return string
171		*/
172		public function currentUser()
173		{
174		return $this->tokenStorage->getToken()->getUsername();
175		}
176
177		/**
178		* Gets a random value between $min and $max
179		*
180		* @param int $min
181		* @param int $max
182		*
183		* @return int
184		*/
185		public function random($min = 0, $max = 10)
186		{
187		return rand($min, $max);
188		}
189
190		/**
191		* @param \DateTime $date
192		* @param string $change
193		*
194		* @return \DateTime
195		* @throws \Exception
196		*/
197		private function modifyDate(\DateTime $date, $change)
198		{
199		try {
200		$date->modify($change);
201		} catch (\Exception $e) {
202		throw new \Exception($change . ' is not a valid date or date offset.');
203		}
204
205		return ($date);
206		}
207		}
208

netdudes / DataSourceryBundle

Pull Request — master (#10)

BuiltInFunctionsExtension::getName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like