allejo\DaPulse\Objects\PulseColumnValue

Complexity

Total Complexity

18

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

95.35%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
	setValue()	0	1	?
C	_createColumnType()	0	26	8
A	isNullValue()	0	4	2
A	getValue()	0	16	3
B	lazyLoad()	0	23	4

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/PhpPulse/blob/master/LICENSE.md MIT
 */

namespace allejo\DaPulse\Objects;

use allejo\DaPulse\Exceptions\ColumnNotFoundException;
use allejo\DaPulse\Exceptions\HttpException;
use allejo\DaPulse\Exceptions\InvalidObjectException;
use allejo\DaPulse\PulseColumn;

/**
 * The base class used for column values belonging to a specified class
 *
 * @internal
 * @package allejo\DaPulse\Objects
 * @since   0.1.0
 */
abstract class PulseColumnValue extends ApiObject
{
    const API_PREFIX = "boards";

    /**
     * The default return value for getValue()
     *
     * @internal
     */
    const DEFAULT_VALUE = null;

    /**
     * The ID of the parent board that this column's Pulse belongs to.
     *
     * @var int
     */
    protected $board_id;

    /**
     * The ID of the current column. This is a unique identifier when accessing columns through the API.
     *
     * @var string
     */
    protected $column_id;

    /**
     * The ID of the Pulse this column value belongs to
     *
     * @var int
     */
    protected $pulse_id;

    /**
     * The value that this column has. The data type can be an integer, string, or DateTime depending on the column type
     *
     * @var mixed
     */
    protected $column_value;

    /**
     * This constructor only accepts an array of the data regarding a specific column
     *
     * @internal
     *
     * @param array $array An associative array containing information regarding a column's value
     *
     * @since 0.1.0
     *
     * @throws \InvalidArgumentException An ID is given when an instance of this object can only be created from an
     *                                   array of existing data
     */
    public function __construct ($array)
    {
        $this->arrayConstructionOnly = true;

        parent::__construct($array);
    }

    /**
     * This function must be overloaded by child classes solely calling this function to allow each implementation to
     * have its own phpDocs.
     */
    public function getValue ()
    {
        $this->lazyLoad();

        if ($this->isNullValue())
        {
            return static::DEFAULT_VALUE;
        }

        if (!isset($this->column_value))
        {
            $this->setValue($this->jsonResponse);
        }

        return $this->column_value;
    }

    /**
     * Create the appropriate object based on the type of column
     *
     * @internal
     *
     * @param string $type The type of column as specified by DaPulse's API; i.e. 'text', 'date', 'status', 'person'
     * @param array  $data An associative array containing data regarding the column
     *
     * @since 0.1.0
     *
     * @todo  Fix the hardcoded "color" case statement. See: https://github.com/allejo/PhpPulse/issues/5

Comment refers to a TODO task

     *
     * @throws InvalidObjectException
     *
     * @return PulseColumnStatusValue|PulseColumnDateValue|PulseColumnNumericValue|PulseColumnPersonValue|PulseColumnTextValue|PulseColumnTimelineValue
     */
    public static function _createColumnType ($type, $data)
    {
        switch ($type)
        {
            case PulseColumn::Text:
                return (new PulseColumnTextValue($data));

            case "color":
            case PulseColumn::Status:
                return (new PulseColumnStatusValue($data));

            case PulseColumn::Numeric:
                return (new PulseColumnNumericValue($data));

            case PulseColumn::Person:
                return (new PulseColumnPersonValue($data));

            case PulseColumn::Date:
                return (new PulseColumnDateValue($data));

            case PulseColumn::Timeline:
                return (new PulseColumnTimelineValue($data));
        }

        throw new InvalidObjectException("'$type' is an unsupported column type to modify.");
    }

    /**
     * Check whether to return null because a column's value does not exist.
     *
     * @return bool True if the column does not have a value
     */
    protected function isNullValue ()
    {
        return (!isset($this->column_value) && is_null($this->jsonResponse["value"]));
    }

    protected function lazyLoad ()
    {
        if (!array_key_exists('value', $this->jsonResponse) && is_null($this->column_value))
        {
            $url    = sprintf("%s/%d/columns/%s/value.json", self::apiEndpoint("boards"), $this->board_id, $this->column_id);
            $params = [
                "pulse_id" => $this->pulse_id
            ];

            try
            {
                $results = self::sendGet($url, $params);
            }
            catch (HttpException $e)
            {
                throw new ColumnNotFoundException("The '$this->column_id' column could not be found");
            }

            // Store our value inside of jsonResponse so all of the respective objects can treat the data the same
            // as when accessed through a PulseBoard
            $this->jsonResponse['value'] = $results['value'];
        }
    }

    /**
     * Cast and set the appropriate value for this column
     *
     * @param $response
     */
    abstract protected function setValue ($response);
}