Rule::getTestConfig() - Code Metrics - Inspection of "Adding Rules endpoint to the SDK" - acquia/lift-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Nick

created 2016-10-27 08:12 UTC

Rule::getTestConfig() B

↳ Parent: Rule

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	14
nc	4
nop	0

<?php

namespace Acquia\LiftClient\Entity;

use Acquia\LiftClient\Exception\LiftSdkException;
use DateTime;

class Rule extends \ArrayObject
{
    use EntityTrait;

    /**
     * @param array $array
     */
    public function __construct(array $array = [])
    {
        parent::__construct($array);
    }

    /**
     * Sets the 'id' parameter.
     *
     * @param string $id
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setId($id)
    {
        if (!is_string($id)) {
            throw new LiftSdkException('Argument must be an instance of string.');
        }
        $this['id'] = $id;

        return $this;
    }

    /**
     * Gets the 'id' parameter.
     *
     * @return string The Identifier of the Rule
     */
    public function getId()
    {
        return $this->getEntityValue('id', '');
    }

    /**
     * Sets the 'label' parameter.
     *
     * @param string $label
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setLabel($label)
    {
        if (!is_string($label)) {
            throw new LiftSdkException('Argument must be an instance of string.');
        }
        $this['label'] = $label;

        return $this;
    }

    /**
     * Gets the 'label' parameter.
     *
     * @return string
     */
    public function getLabel()
    {
        return $this->getEntityValue('label', '');
    }

    /**
     * Sets the 'description' parameter.
     *
     * @param string $description
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setDescription($description)
    {
        if (!is_string($description)) {
            throw new LiftSdkException('Argument must be an instance of string.');
        }
        $this['description'] = $description;

        return $this;
    }

    /**
     * Gets the 'description' parameter.
     *
     * @return string The Description of the Rule
     */
    public function getDescription()
    {
        return $this->getEntityValue('description', '');
    }

    /**
     * Sets the 'slot_id' parameter.
     *
     * @param string $slotId
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setSlotId($slotId)
    {
        if (!is_string($slotId)) {
            throw new LiftSdkException('Argument must be an instance of string.');
        }
        $this['slot_id'] = $slotId;

        return $this;
    }

    /**
     * Gets the 'description' parameter.
     *
     * @return string The Description of the Rule
     */
    public function getSlotId()
    {
        return $this->getEntityValue('slot_id', '');
    }

    /**
     * Sets the 'weight' parameter.
     *
     * @param int $weight
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setWeight($weight)
    {
        if (!is_integer($weight)) {
            throw new LiftSdkException('Argument must be an instance of integer.');
        }
        $this['weight'] = $weight;

        return $this;
    }

    /**
     * Gets the 'description' parameter.
     *
     * @return int The Description of the Rule
     */
    public function getWeight()
    {
        return $this->getEntityValue('weight', 0);
    }

    /**
     * Sets the 'content' parameter.
     *
     * @param Content[] $contentList
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setContent(array $contentList)
    {
        $this['content'] = [];
        foreach ($contentList as $content) {
            // We need to 'normalize' the data.
            $this['content'][] = $content->getArrayCopy();
        }

        return $this;
    }

    /**
     * Gets the 'content' parameter.
     *
     * @return Content[] The list of content this rule applies to
     */
    public function getContent()
    {
        $contentList = $this->getEntityValue('content', '');
        $ret = [];
        foreach ($contentList as $content) {
            $ret[] = new Content($content);
        }

        return $ret;
    }

    /**
     * Sets the 'segment' parameter.
     *
     * @param string $segment
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setSegment($segment)
    {
        if (!is_string($segment)) {
            throw new LiftSdkException('Argument must be an instance of integer.');
        }
        $this['segment'] = $segment;

        return $this;
    }

    /**
     * Gets the 'segment' parameter.
     *
     * @return string
     */
    public function getSegment()
    {
        return $this->getEntityValue('segment', '');
    }

    /**
     * Sets the 'status' parameter.
     *
     * @param string $status
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setStatus($status)
    {
        if (!is_string($status)) {
            throw new LiftSdkException('Argument must be an instance of integer.');
        }
        if ($status !== 'published' && $status !== 'unpublished' && $status !== 'archived') {
            throw new LiftSdkException('Status much be either published, unpublished or archived');
        }
        $this['status'] = $status;

        return $this;
    }

    /**
     * Gets the 'status' parameter.
     *
     * @return string
     */
    public function getStatus()
    {
        return $this->getEntityValue('status', '');
    }

    /**
     * Gets the 'created' parameter.
     *
     * @return DateTime
     */
    public function getCreated()
    {
        $date = $this->getEntityValue('created', '');
        $datetime = DateTime::createFromFormat(DateTime::ISO8601, $date);


        return $datetime;
    }

    /**
     * Gets the 'updated' parameter.
     *
     * @return DateTime
     */
    public function getUpdated()
    {
        $date = $this->getEntityValue('updated', '');
        $datetime = DateTime::createFromFormat(DateTime::ISO8601, $date);


        return $datetime;
    }

    /**
     * Sets the Rule test_config property.
     *
     * @param \Acquia\LiftClient\Entity\TestConfigInterface $testConfig
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setTestConfig(TestConfigInterface $testConfig)
    {
        // To facilitate TypeHinting in PHPStorm we redefine what $testConfig is
        // here. We know it inherits from the TestConfigInterface and is a child
        // of TestConfigBase.
        /** @var \Acquia\LiftClient\Entity\TestConfigBase $testConfig */

        // Get class of the testConfig object.
        $type = get_class($testConfig);

        // Only allow one test type at a time.
        $this['testconfig'] = [];
        switch ($type) {
            case 'Acquia\LiftClient\Entity\TestConfigAb':
                $this['testconfig']['ab'] = $testConfig->getArrayCopy();
                break;
            case 'Acquia\LiftClient\Entity\TestConfigMab':
                $this['testconfig']['mab'] = $testConfig->getArrayCopy();
                break;
            case 'Acquia\LiftClient\Entity\TestConfigTarget':
                $this['testconfig']['target'] = $testConfig->getArrayCopy();
                break;
        }

        return $this;
    }

    /**
     * Gets the 'test_config' parameter.
     *
     * @return \Acquia\LiftClient\Entity\TestConfigInterface|null $testConfig
     */
    public function getTestConfig()
    {
        $testConfig = $this->getEntityValue('testconfig', []);
        // We know the array only has one possible set of options.
        // Get its key and value.
        reset($testConfig);
        $key = key($testConfig);

        // Based on the config, we load the different objects.
        switch ($key) {
            case 'ab':
                return new TestConfigAb($testConfig);
            case 'mab':
                return new TestConfigMab($testConfig);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'target':
                return new TestConfigTarget($testConfig);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }

        return null;
    }
}


1			<?php
2
3			namespace Acquia\LiftClient\Entity;
4
5			use Acquia\LiftClient\Exception\LiftSdkException;
6			use DateTime;
7
8			class Rule extends \ArrayObject
9			{
10			use EntityTrait;
11
12			/**
13			* @param array $array
14			*/
15			public function __construct(array $array = [])
16			{
17			parent::__construct($array);
18			}
19
20			/**
21			* Sets the 'id' parameter.
22			*
23			* @param string $id
24			*
25			* @throws \Acquia\LiftClient\Exception\LiftSdkException
26			*
27			* @return \Acquia\LiftClient\Entity\Rule
28			*/
29			public function setId($id)
30			{
31			if (!is_string($id)) {
32			throw new LiftSdkException('Argument must be an instance of string.');
33			}
34			$this['id'] = $id;
35
36			return $this;
37			}
38
39			/**
40			* Gets the 'id' parameter.
41			*
42			* @return string The Identifier of the Rule
43			*/
44			public function getId()
45			{
46			return $this->getEntityValue('id', '');
47			}
48
49			/**
50			* Sets the 'label' parameter.
51			*
52			* @param string $label
53			*
54			* @throws \Acquia\LiftClient\Exception\LiftSdkException
55			*
56			* @return \Acquia\LiftClient\Entity\Rule
57			*/
58			public function setLabel($label)
59			{
60			if (!is_string($label)) {
61			throw new LiftSdkException('Argument must be an instance of string.');
62			}
63			$this['label'] = $label;
64
65			return $this;
66			}
67
68			/**
69			* Gets the 'label' parameter.
70			*
71			* @return string
72			*/
73			public function getLabel()
74			{
75			return $this->getEntityValue('label', '');
76			}
77
78			/**
79			* Sets the 'description' parameter.
80			*
81			* @param string $description
82			*
83			* @throws \Acquia\LiftClient\Exception\LiftSdkException
84			*
85			* @return \Acquia\LiftClient\Entity\Rule
86			*/
87			public function setDescription($description)
88			{
89			if (!is_string($description)) {
90			throw new LiftSdkException('Argument must be an instance of string.');
91			}
92			$this['description'] = $description;
93
94			return $this;
95			}
96
97			/**
98			* Gets the 'description' parameter.
99			*
100			* @return string The Description of the Rule
101			*/
102			public function getDescription()
103			{
104			return $this->getEntityValue('description', '');
105			}
106
107			/**
108			* Sets the 'slot_id' parameter.
109			*
110			* @param string $slotId
111			*
112			* @throws \Acquia\LiftClient\Exception\LiftSdkException
113			*
114			* @return \Acquia\LiftClient\Entity\Rule
115			*/
116			public function setSlotId($slotId)
117			{
118			if (!is_string($slotId)) {
119			throw new LiftSdkException('Argument must be an instance of string.');
120			}
121			$this['slot_id'] = $slotId;
122
123			return $this;
124			}
125
126			/**
127			* Gets the 'description' parameter.
128			*
129			* @return string The Description of the Rule
130			*/
131			public function getSlotId()
132			{
133			return $this->getEntityValue('slot_id', '');
134			}
135
136			/**
137			* Sets the 'weight' parameter.
138			*
139			* @param int $weight
140			*
141			* @throws \Acquia\LiftClient\Exception\LiftSdkException
142			*
143			* @return \Acquia\LiftClient\Entity\Rule
144			*/
145			public function setWeight($weight)
146			{
147			if (!is_integer($weight)) {
148			throw new LiftSdkException('Argument must be an instance of integer.');
149			}
150			$this['weight'] = $weight;
151
152			return $this;
153			}
154
155			/**
156			* Gets the 'description' parameter.
157			*
158			* @return int The Description of the Rule
159			*/
160			public function getWeight()
161			{
162			return $this->getEntityValue('weight', 0);
163			}
164
165			/**
166			* Sets the 'content' parameter.
167			*
168			* @param Content[] $contentList
169			*
170			* @throws \Acquia\LiftClient\Exception\LiftSdkException
171			*
172			* @return \Acquia\LiftClient\Entity\Rule
173			*/
174			public function setContent(array $contentList)
175			{
176			$this['content'] = [];
177			foreach ($contentList as $content) {
178			// We need to 'normalize' the data.
179			$this['content'][] = $content->getArrayCopy();
180			}
181
182			return $this;
183			}
184
185			/**
186			* Gets the 'content' parameter.
187			*
188			* @return Content[] The list of content this rule applies to
189			*/
190			public function getContent()
191			{
192			$contentList = $this->getEntityValue('content', '');
193			$ret = [];
194			foreach ($contentList as $content) {
195			$ret[] = new Content($content);
196			}
197
198			return $ret;
199			}
200
201			/**
202			* Sets the 'segment' parameter.
203			*
204			* @param string $segment
205			*
206			* @throws \Acquia\LiftClient\Exception\LiftSdkException
207			*
208			* @return \Acquia\LiftClient\Entity\Rule
209			*/
210			public function setSegment($segment)
211			{
212			if (!is_string($segment)) {
213			throw new LiftSdkException('Argument must be an instance of integer.');
214			}
215			$this['segment'] = $segment;
216
217			return $this;
218			}
219
220			/**
221			* Gets the 'segment' parameter.
222			*
223			* @return string
224			*/
225			public function getSegment()
226			{
227			return $this->getEntityValue('segment', '');
228			}
229
230			/**
231			* Sets the 'status' parameter.
232			*
233			* @param string $status
234			*
235			* @throws \Acquia\LiftClient\Exception\LiftSdkException
236			*
237			* @return \Acquia\LiftClient\Entity\Rule
238			*/
239			public function setStatus($status)
240			{
241			if (!is_string($status)) {
242			throw new LiftSdkException('Argument must be an instance of integer.');
243			}
244			if ($status !== 'published' && $status !== 'unpublished' && $status !== 'archived') {
245			throw new LiftSdkException('Status much be either published, unpublished or archived');
246			}
247			$this['status'] = $status;
248
249			return $this;
250			}
251
252			/**
253			* Gets the 'status' parameter.
254			*
255			* @return string
256			*/
257			public function getStatus()
258			{
259			return $this->getEntityValue('status', '');
260			}
261
262			/**
263			* Gets the 'created' parameter.
264			*
265			* @return DateTime
266			*/
267			public function getCreated()
268			{
269			$date = $this->getEntityValue('created', '');
270			$datetime = DateTime::createFromFormat(DateTime::ISO8601, $date);
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-10-26 14:07 UTC by Report Bug Copy Issue Report The expression `\DateTime::createFromFor...eTime::ISO8601, $date);` of type `DateTime\|false` adds `false` to the return on line 272 which is incompatible with the return type documented by `Acquia\LiftClient\Entity\Rule::getCreated` of type `DateTime`. It seems like you forgot to handle an error condition. Loading history...
271
272			return $datetime;
273			}
274
275			/**
276			* Gets the 'updated' parameter.
277			*
278			* @return DateTime
279			*/
280			public function getUpdated()
281			{
282			$date = $this->getEntityValue('updated', '');
283			$datetime = DateTime::createFromFormat(DateTime::ISO8601, $date);
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-10-26 14:07 UTC by Report Bug Copy Issue Report The expression `\DateTime::createFromFor...eTime::ISO8601, $date);` of type `DateTime\|false` adds `false` to the return on line 285 which is incompatible with the return type documented by `Acquia\LiftClient\Entity\Rule::getUpdated` of type `DateTime`. It seems like you forgot to handle an error condition. Loading history...
284
285			return $datetime;
286			}
287
288			/**
289			* Sets the Rule test_config property.
290			*
291			* @param \Acquia\LiftClient\Entity\TestConfigInterface $testConfig
292			*
293			* @return \Acquia\LiftClient\Entity\Rule
294			*/
295			public function setTestConfig(TestConfigInterface $testConfig)
296			{
297			// To facilitate TypeHinting in PHPStorm we redefine what $testConfig is
298			// here. We know it inherits from the TestConfigInterface and is a child
299			// of TestConfigBase.
300			/** @var \Acquia\LiftClient\Entity\TestConfigBase $testConfig */
301
302			// Get class of the testConfig object.
303			$type = get_class($testConfig);
304
305			// Only allow one test type at a time.
306			$this['testconfig'] = [];
307			switch ($type) {
308			case 'Acquia\LiftClient\Entity\TestConfigAb':
309			$this['testconfig']['ab'] = $testConfig->getArrayCopy();
310			break;
311			case 'Acquia\LiftClient\Entity\TestConfigMab':
312			$this['testconfig']['mab'] = $testConfig->getArrayCopy();
313			break;
314			case 'Acquia\LiftClient\Entity\TestConfigTarget':
315			$this['testconfig']['target'] = $testConfig->getArrayCopy();
316			break;
317			}
318
319			return $this;
320			}
321
322			/**
323			* Gets the 'test_config' parameter.
324			*
325			* @return \Acquia\LiftClient\Entity\TestConfigInterface\|null $testConfig
326			*/
327			public function getTestConfig()
328			{
329			$testConfig = $this->getEntityValue('testconfig', []);
330			// We know the array only has one possible set of options.
331			// Get its key and value.
332			reset($testConfig);
333			$key = key($testConfig);
334
335			// Based on the config, we load the different objects.
336			switch ($key) {
337			case 'ab':
338			return new TestConfigAb($testConfig);
339			case 'mab':
340			return new TestConfigMab($testConfig);
341			break;
			0 ignored issues – show Unused Code introduced 2016-10-26 14:07 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
342			case 'target':
343			return new TestConfigTarget($testConfig);
344			break;
			0 ignored issues – show Unused Code introduced 2016-10-26 14:07 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
345			}
346
347			return null;
348			}
349			}
350

acquia / lift-sdk-php

Pull Request — master (#6)

Rule::getTestConfig() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like