allejo\DaPulse\Objects\PulseColumnValue

Complexity

Total Complexity

6

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	6

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	_createColumnType()	0	19	5
	getValue()	0	1	?
	updateValue()	0	1	?

<?php

/**
 * This file contains the PulseColumnValue class
 *
 * @copyright 2015 Vladimir Jimenez
 * @license   https://github.com/allejo/PhpPulse/blob/master/LICENSE.md MIT
 */

namespace allejo\DaPulse\Objects;

use allejo\DaPulse\Exceptions\InvalidObjectException;

/**
 * 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

The property $board_id is not named in camelCase.

The property $column_id is not named in camelCase.

The property $pulse_id is not named in camelCase.

The property $column_value is not named in camelCase.

{
    const API_PREFIX = "boards";

    /**
     * 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
     *
     * @throw \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);
    }

    /**
     * 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', 'color', 'person'
     * @param array  $data An associative array containing data regarding the column
     *
     * @since 0.1.0
     *
     * @throws \allejo\DaPulse\Exceptions\InvalidObjectException
     *
     * @return PulseColumnColorValue|PulseColumnDateValue|PulseColumnPersonValue|PulseColumnTextValue
     */
    public static function _createColumnType ($type, $data)
    {
        switch ($type)
        {
            case "text":
                return (new PulseColumnTextValue($data));

            case "color":
                return (new PulseColumnColorValue($data));

            case "person":
                return (new PulseColumnPersonValue($data));

            case "date":
                return (new PulseColumnDateValue($data));
        }

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

    abstract public function getValue();
    abstract public function updateValue($updateValue);
}