Acquia\LiftClient\Entity\Rule

Complexity

Total Complexity

41

Size/Duplication

Total Lines	372
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

94.95%

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setId()	0	9	2
A	getId()	0	4	1
A	setLabel()	0	9	2
A	getLabel()	0	4	1
A	setDescription()	0	9	2
A	getDescription()	0	4	1
A	setSlotId()	0	9	2
A	getSlotId()	0	4	1
A	setPriority()	0	9	2
A	getPriority()	0	4	1
A	setWeight()	0	4	1
A	getWeight()	0	4	1
A	setContentList()	0	10	2
A	getContentList()	0	10	2
A	setSegmentId()	0	9	2
A	getSegmentId()	0	4	1
A	setStatus()	0	12	5
A	getStatus()	0	4	1
A	getCreated()	0	10	1
A	getUpdated()	0	10	1
A	setTestConfig()	0	26	4
A	getTestConfig()	0	20	4

<?php

namespace Acquia\LiftClient\Entity;

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

class Rule extends Entity
{
    /**
     * @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 'slot_id' parameter.
     *
     * @return string The Description of the Rule
     */
    public function getSlotId()
    {
        return $this->getEntityValue('slot_id', '');
    }

    /**
     * Sets the 'priority' parameter.
     *
     * Higher number means the rule display / apply first.
     *
     * @param int $priority
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setPriority($priority)
    {
        if (!is_integer($priority)) {
            throw new LiftSdkException('Argument must be an instance of integer.');
        }
        $this['priority'] = $priority;

        return $this;
    }

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

    /**
     * Sets the 'weight' parameter.
     *
     * @deprecated use the priority parameter instead.
     * @param int $weight
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setWeight($weight)
    {
        return $this->setPriority($weight);
    }

    /**
     * Gets the 'weight' parameter.
     *
     * @deprecated use the priority parameter instead.
     * @return int The weight of the Rule
     */
    public function getWeight()
    {
        return $this->getPriority();
    }

    /**
     * Sets the 'content' parameter.
     *
     * @param Content[] $contentList
     *
     * @throws \Acquia\LiftClient\Exception\LiftSdkException
     *
     * @return \Acquia\LiftClient\Entity\Rule
     */
    public function setContentList(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 getContentList()
    {
        $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 setSegmentId($segment)
    {
        if (!is_string($segment)) {
            throw new LiftSdkException('Argument must be an instance of string.');
        }
        $this['segment'] = $segment;

        return $this;
    }

    /**
     * Gets the 'segment' parameter.
     *
     * @return string
     */
    public function getSegmentId()
    {
        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 string.');
        }
        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|false
     */
    public function getCreated()
    {
        $date = $this->getEntityValue('created', 0);
        // The ISO8601 DateTime format is not compatible with ISO-8601, but is left this way for backward compatibility
        // reasons. Use DateTime::ATOM or DATE_ATOM for compatibility with ISO-8601 instead.
        // See http://php.net/manual/en/class.datetime.php
        $datetime = DateTime::createFromFormat(DateTime::ATOM, $date);

        return $datetime;
    }

    /**
     * Gets the 'updated' parameter.
     *
     * @return DateTime|false
     */
    public function getUpdated()
    {
        $date = $this->getEntityValue('updated', 0);
        // The ISO8601 DateTime format is not compatible with ISO-8601, but is left this way for backward compatibility
        // reasons. Use DateTime::ATOM or DATE_ATOM for compatibility with ISO-8601 instead.
        // See http://php.net/manual/en/class.datetime.php
        $datetime = DateTime::createFromFormat(DateTime::ATOM, $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[$key]);
            case 'mab':
                return new TestConfigMab($testConfig[$key]);
            case 'target':
                return new TestConfigTarget($testConfig[$key]);
        }

        return null;
    }
}