BuiltInFunctionsExtension::currentUser() - Code Metrics - Inspection of "Replace the today() function in UQL with startOfDa..." - netdudes/DataSourceryBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

unknown

created 2015-12-10 16:29 UTC

BuiltInFunctionsExtension::currentUser() A

↳ Parent: BuiltInFunctionsExtension

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\TableBundleFunctionExtension;
use Netdudes\DataSourceryBundle\Util\CurrentDateTimeProvider;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\SecurityContextInterface;

class BuiltInFunctionsExtension extends AbstractTableBundleExtension
{
    /**
     * @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 getName()
    {
        return 'table_bundle_extension_built_in';
    }

    /**
     * {@inheritdoc}
     */
    public function getFunctions()
    {
        return [
            new TableBundleFunctionExtension('now', $this, 'now'),
            new TableBundleFunctionExtension('startOfDay', $this, 'startOfDay'),
            new TableBundleFunctionExtension('endOfDay', $this, 'endOfDay'),
            new TableBundleFunctionExtension('currentUser', $this, 'currentUser'),
            new TableBundleFunctionExtension('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 a date with the hour 23:59:59
     *
     * @param string $date
     *
     * @return string
     * @throws \Exception
     */
    public function endOfDay($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(23, 59, 59);

        return $now->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\TableBundleFunctionExtension;
6		use Netdudes\DataSourceryBundle\Util\CurrentDateTimeProvider;
7		use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
8		use Symfony\Component\Security\Core\SecurityContextInterface;
9
10		class BuiltInFunctionsExtension extends AbstractTableBundleExtension
11		{
12		/**
13		* @var TokenStorageInterface
14		*/
15		private $tokenStorage;
16
17		/**
18		* @var CurrentDateTimeProvider
19		*/
20		private $dateTimeProvider;
21
22		/**
23		* @param TokenStorageInterface $tokenStorage
24		* @param CurrentDateTimeProvider $dateTimeProvider
25		*/
26		public function __construct(TokenStorageInterface $tokenStorage, CurrentDateTimeProvider $dateTimeProvider)
27		{
28		$this->tokenStorage = $tokenStorage;
29		$this->dateTimeProvider = $dateTimeProvider;
30		}
31
32		/**
33		* {@inheritdoc}
34		*/
35		public function getName()
36		{
37		return 'table_bundle_extension_built_in';
38		}
39
40		/**
41		* {@inheritdoc}
42		*/
43		public function getFunctions()
44		{
45		return [
46		new TableBundleFunctionExtension('now', $this, 'now'),
47		new TableBundleFunctionExtension('startOfDay', $this, 'startOfDay'),
48		new TableBundleFunctionExtension('endOfDay', $this, 'endOfDay'),
49		new TableBundleFunctionExtension('currentUser', $this, 'currentUser'),
50		new TableBundleFunctionExtension('random', $this, 'random')
51		];
52		}
53
54		/**
55		* Gets the current timestamp, with an offset string
56		*
57		* @param string $offset
58		*
59		* @return string
60		* @throws \Exception
61		*/
62		public function now($offset = null)
63		{
64		$now = clone $this->dateTimeProvider->get();
65
66		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...
67		$interval = \DateInterval::createFromDateString($offset);
68		$now->add($interval);
69
70		if ($now == $this->dateTimeProvider->get()) {
71		// The date didn't change therefore we assume the given offset is not valid
72		throw new \Exception($offset . ' is not a valid date/time interval.');
73		}
74		}
75
76		return $now->format(\DateTime::ISO8601);
77		}
78
79		/**
80		* Gets a date with the hour 00:00:00
81		*
82		* @param string $date
83		*
84		* @return string
85		* @throws \Exception
86		*/
87	View Code Duplication	public function startOfDay($date = null)
		0 ignored issues – show Duplication introduced 2015-12-10 16:34 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...
88		{
89		$now = clone $this->dateTimeProvider->get();
90
91		if ($date) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-10 16:34 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...
92		$now = $this->modifyDate($now, $date);
93		}
94
95		$now->setTime(0, 0, 0);
96
97		return $now->format(\DateTime::ISO8601);
98		}
99
100		/**
101		* Gets a date with the hour 23:59:59
102		*
103		* @param string $date
104		*
105		* @return string
106		* @throws \Exception
107		*/
108	View Code Duplication	public function endOfDay($date = null)
		0 ignored issues – show Duplication introduced 2015-12-10 16:34 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...
109		{
110		$now = clone $this->dateTimeProvider->get();
111
112		if ($date) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-10 16:34 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...
113		$now = $this->modifyDate($now, $date);
114		}
115
116		$now->setTime(23, 59, 59);
117
118		return $now->format(\DateTime::ISO8601);
119		}
120
121		/**
122		* Gets the current users' username
123		*
124		* @return string
125		*/
126		public function currentUser()
127		{
128		return $this->tokenStorage->getToken()->getUsername();
129		}
130
131		/**
132		* Gets a random value between $min and $max
133		*
134		* @param int $min
135		* @param int $max
136		*
137		* @return int
138		*/
139		public function random($min = 0, $max = 10)
140		{
141		return rand($min, $max);
142		}
143
144		/**
145		* @param \DateTime $date
146		* @param string $change
147		*
148		* @return \DateTime
149		* @throws \Exception
150		*/
151		private function modifyDate(\DateTime $date, $change)
152		{
153		try {
154		$date->modify($change);
155		} catch (\Exception $e) {
156		throw new \Exception($change . ' is not a valid date or date offset.');
157		}
158
159		return ($date);
160		}
161		}
162

netdudes / DataSourceryBundle

Pull Request — master (#6)

BuiltInFunctionsExtension::currentUser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like