UserData::setDependencies() - Code Metrics - Inspection of "Upgrade to charcoal-translator" - locomotivemtl/charcoal-object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fe5f87...054e54 )

by Mathieu

created 2017-02-07 23:02 UTC

UserData::setDependencies() A

↳ Parent: UserData

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Charcoal\Object;

use DateTime;
use DateTimeInterface;
use Exception;
use InvalidArgumentException;

// From `pimple/pimple`
use Pimple\Container;

// From `charcoal-core`
use Charcoal\Model\AbstractModel;

// From `charcoal-translation`
use Charcoal\Translator\TranslatorAwareTrait;

// Local namespace (`charcoal-object`) dependency

use Charcoal\Object\UserDataInterface;

/**
 * User Data is a base model for objects typically submitted by the end-user of the application.
 */
class UserData extends AbstractModel implements
    UserDataInterface
{
    use TranslatorAwareTrait;

    /**
     * Client IP address of the end-user.
     *
     * @var integer|null
     */
    private $ip;

    /**
     * Language of the end-user or source URI.
     *
     * @var string|null
     */
    private $lang;

    /**
     * Source URL or identifier of end-user submission.
     *
     * @var string|null
     */
    private $origin;

    /**
     * Creation timestamp of submission.
     *
     * @var DateTimeInterface|null
     */
    private $ts;

    /**
     * Dependencies
     * @param Container $container DI Container.
     * @return void
     */
    public function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        $this->setTranslator($container['translator']);
    }


    /**
     * Set the client IP address.
     *
     * @param  integer|null $ip The remote IP at object creation.
     * @return UserDataInterface Chainable
     */
    public function setIp($ip)
    {
        if ($ip === null) {
            $this->ip = null;
            return $this;
        }

        if (is_string($ip)) {
            $ip = ip2long($ip);
        } elseif (is_numeric($ip)) {
            $ip = (int)$ip;
        } else {
            $ip = 0;
        }

        $this->ip = $ip;

        return $this;
    }

    /**
     * Retrieve the client IP address.
     *
     * @return integer|null
     */
    public function ip()
    {
        return $this->ip;
    }

    /**
     * Set the origin language.
     *
     * @param  string $lang The language code.
     * @throws InvalidArgumentException If the argument is not a string.
     * @return UserDataInterface Chainable
     */
    public function setLang($lang)

    {
        if ($lang !== null) {
            if (!is_string($lang)) {
                throw new InvalidArgumentException(
                    'Language must be a string'
                );
            }
        }

        $this->lang = $lang;

        return $this;
    }

    /**
     * Retrieve the language.
     *
     * @return string
     */
    public function lang()
    {
        return $this->lang;
    }

    /**
     * Set the origin of the object submission.
     *
     * @param  string $origin The source URL or identifier of the submission.
     * @throws InvalidArgumentException If the argument is not a string.
     * @return UserDataInterface Chainable
     */
    public function setOrigin($origin)

    {
        if ($origin !== null) {
            if (!is_string($origin)) {
                throw new InvalidArgumentException(
                    'Origin must be a string.'
                );
            }
        }

        $this->origin = $origin;

        return $this;
    }

    /**
     * Resolve the origin of the user data.
     *
     * @return string
     */
    public function resolveOrigin()
    {
        $host = getenv('HTTP_HOST');
        $uri  = '';
        if ($host) {
            $uri = 'http';

            if (getenv('HTTPS') === 'on') {
                $uri .= 's';
            }

            $uri .= '://'.$host;
        }
        $uri .= getenv('REQUEST_URI');

        return $uri;
    }

    /**
     * Retrieve the origin of the object submission.
     *
     * @return string
     */
    public function origin()
    {
        return $this->origin;
    }

    /**
     * Set when the object was created.
     *
     * @param  DateTime|string|null $timestamp The timestamp at object's creation.
     *     NULL is accepted and instances of DateTimeInterface are recommended;
     *     any other value will be converted (if possible) into one.
     * @throws InvalidArgumentException If the timestamp is invalid.
     * @return UserDataInterface Chainable
     */
    public function setTs($timestamp)

    {
        if ($timestamp === null) {
            $this->ts = null;
            return $this;
        }

        if (is_string($timestamp)) {
            try {
                $timestamp = new DateTime($timestamp);
            } catch (Exception $e) {
                throw new InvalidArgumentException(sprintf(
                    'Invalid timestamp: %s',
                    $e->getMessage()
                ), 0, $e);
            }
        }

        if (!$timestamp instanceof DateTimeInterface) {
            throw new InvalidArgumentException(
                'Invalid timestamp value. Must be a date/time string or a DateTime object.'
            );
        }

        $this->ts = $timestamp;

        return $this;
    }

    /**
     * Retrieve the creation timestamp.
     *
     * @return DateTime|null
     */
    public function ts()
    {
        return $this->ts;
    }

    /**
     * Event called before _creating_ the object.
     *
     * @see    Charcoal\Source\StorableTrait::preSave() For the "create" Event.
     * @return boolean
     */
    public function preSave()
    {
        $result = parent::preSave();

        $this->setTs('now');

        if (getenv('REMOTE_ADDR')) {
            $this->setIp(getenv('REMOTE_ADDR'));
        }

        if (!isset($this->origin)) {
            $this->setOrigin($this->resolveOrigin());
        }

        return $result;
    }
}


1		<?php
2
3		namespace Charcoal\Object;
4
5		use DateTime;
6		use DateTimeInterface;
7		use Exception;
8		use InvalidArgumentException;
9
10		// From `pimple/pimple`
11		use Pimple\Container;
12
13		// From `charcoal-core`
14		use Charcoal\Model\AbstractModel;
15
16		// From `charcoal-translation`
17		use Charcoal\Translator\TranslatorAwareTrait;
18
19		// Local namespace (`charcoal-object`) dependency
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-26 04:18 UTC by Report Bug Copy Issue Report `42%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
20		use Charcoal\Object\UserDataInterface;
21
22		/**
23		* User Data is a base model for objects typically submitted by the end-user of the application.
24		*/
25		class UserData extends AbstractModel implements
26		UserDataInterface
27		{
28		use TranslatorAwareTrait;
29
30		/**
31		* Client IP address of the end-user.
32		*
33		* @var integer\|null
34		*/
35		private $ip;
36
37		/**
38		* Language of the end-user or source URI.
39		*
40		* @var string\|null
41		*/
42		private $lang;
43
44		/**
45		* Source URL or identifier of end-user submission.
46		*
47		* @var string\|null
48		*/
49		private $origin;
50
51		/**
52		* Creation timestamp of submission.
53		*
54		* @var DateTimeInterface\|null
55		*/
56		private $ts;
57
58		/**
59		* Dependencies
60		* @param Container $container DI Container.
61		* @return void
62		*/
63		public function setDependencies(Container $container)
64		{
65		parent::setDependencies($container);
66
67		$this->setTranslator($container['translator']);
68		}
69
70
71		/**
72		* Set the client IP address.
73		*
74		* @param integer\|null $ip The remote IP at object creation.
75		* @return UserDataInterface Chainable
76		*/
77		public function setIp($ip)
78		{
79		if ($ip === null) {
80		$this->ip = null;
81		return $this;
82		}
83
84		if (is_string($ip)) {
85		$ip = ip2long($ip);
86		} elseif (is_numeric($ip)) {
87		$ip = (int)$ip;
88		} else {
89		$ip = 0;
90		}
91
92		$this->ip = $ip;
93
94		return $this;
95		}
96
97		/**
98		* Retrieve the client IP address.
99		*
100		* @return integer\|null
101		*/
102		public function ip()
103		{
104		return $this->ip;
105		}
106
107		/**
108		* Set the origin language.
109		*
110		* @param string $lang The language code.
111		* @throws InvalidArgumentException If the argument is not a string.
112		* @return UserDataInterface Chainable
113		*/
114	View Code Duplication	public function setLang($lang)
		0 ignored issues – show Duplication introduced 2017-01-26 04:18 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...
115		{
116		if ($lang !== null) {
117		if (!is_string($lang)) {
118		throw new InvalidArgumentException(
119		'Language must be a string'
120		);
121		}
122		}
123
124		$this->lang = $lang;
125
126		return $this;
127		}
128
129		/**
130		* Retrieve the language.
131		*
132		* @return string
133		*/
134		public function lang()
135		{
136		return $this->lang;
137		}
138
139		/**
140		* Set the origin of the object submission.
141		*
142		* @param string $origin The source URL or identifier of the submission.
143		* @throws InvalidArgumentException If the argument is not a string.
144		* @return UserDataInterface Chainable
145		*/
146	View Code Duplication	public function setOrigin($origin)
		0 ignored issues – show Duplication introduced 2017-01-26 04:18 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...
147		{
148		if ($origin !== null) {
149		if (!is_string($origin)) {
150		throw new InvalidArgumentException(
151		'Origin must be a string.'
152		);
153		}
154		}
155
156		$this->origin = $origin;
157
158		return $this;
159		}
160
161		/**
162		* Resolve the origin of the user data.
163		*
164		* @return string
165		*/
166		public function resolveOrigin()
167		{
168		$host = getenv('HTTP_HOST');
169		$uri = '';
170		if ($host) {
171		$uri = 'http';
172
173		if (getenv('HTTPS') === 'on') {
174		$uri .= 's';
175		}
176
177		$uri .= '://'.$host;
178		}
179		$uri .= getenv('REQUEST_URI');
180
181		return $uri;
182		}
183
184		/**
185		* Retrieve the origin of the object submission.
186		*
187		* @return string
188		*/
189		public function origin()
190		{
191		return $this->origin;
192		}
193
194		/**
195		* Set when the object was created.
196		*
197		* @param DateTime\|string\|null $timestamp The timestamp at object's creation.
198		* NULL is accepted and instances of DateTimeInterface are recommended;
199		* any other value will be converted (if possible) into one.
200		* @throws InvalidArgumentException If the timestamp is invalid.
201		* @return UserDataInterface Chainable
202		*/
203	View Code Duplication	public function setTs($timestamp)
		0 ignored issues – show Duplication introduced 2017-01-26 04:18 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...
204		{
205		if ($timestamp === null) {
206		$this->ts = null;
207		return $this;
208		}
209
210		if (is_string($timestamp)) {
211		try {
212		$timestamp = new DateTime($timestamp);
213		} catch (Exception $e) {
214		throw new InvalidArgumentException(sprintf(
215		'Invalid timestamp: %s',
216		$e->getMessage()
217		), 0, $e);
218		}
219		}
220
221		if (!$timestamp instanceof DateTimeInterface) {
222		throw new InvalidArgumentException(
223		'Invalid timestamp value. Must be a date/time string or a DateTime object.'
224		);
225		}
226
227		$this->ts = $timestamp;
228
229		return $this;
230		}
231
232		/**
233		* Retrieve the creation timestamp.
234		*
235		* @return DateTime\|null
236		*/
237		public function ts()
238		{
239		return $this->ts;
240		}
241
242		/**
243		* Event called before _creating_ the object.
244		*
245		* @see Charcoal\Source\StorableTrait::preSave() For the "create" Event.
246		* @return boolean
247		*/
248		public function preSave()
249		{
250		$result = parent::preSave();
251
252		$this->setTs('now');
253
254		if (getenv('REMOTE_ADDR')) {
255		$this->setIp(getenv('REMOTE_ADDR'));
256		}
257
258		if (!isset($this->origin)) {
259		$this->setOrigin($this->resolveOrigin());
260		}
261
262		return $result;
263		}
264		}
265

locomotivemtl / charcoal-object

Push — master ( fe5f87...054e54 )

UserData::setDependencies() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like