allejo\DaPulse\PulseColumn

Complexity

Total Complexity

18

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getId()	0	4	1
A	getTitle()	0	6	1
A	getType()	0	12	2
A	getEmptyText()	0	6	1
A	getLabels()	0	12	2
A	getBoardId()	0	6	1
A	editTitle()	0	4	1
A	editLabels()	0	4	1
A	deleteColumn()	0	8	1
A	editField()	0	12	1
A	getColumnsUrl()	0	4	1
A	sanitizeLabels()	0	14	4

<?php

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

namespace allejo\DaPulse;

use allejo\DaPulse\Exceptions\InvalidColumnException;
use allejo\DaPulse\Objects\ApiObject;
use allejo\DaPulse\Objects\PulseColumnStatusValue as StatusColumn;

/**
 * Class PulseColumn
 *
 * @api
 * @package allejo\DaPulse
 * @since   0.1.0
 */
class PulseColumn extends ApiObject
{
    const API_PREFIX = "boards";

    const Date     = "date";

This class constant is not uppercase (expected DATE).

    const Numeric  = "numeric";

This class constant is not uppercase (expected NUMERIC).

    const Person   = "person";

This class constant is not uppercase (expected PERSON).

    const Status   = "status";

This class constant is not uppercase (expected STATUS).

    const Text     = "text";

This class constant is not uppercase (expected TEXT).

    const Timeline = "timerange";

This class constant is not uppercase (expected TIMELINE).

    protected $title;
    protected $type;
    protected $empty_text;
    protected $labels;
    protected $board_id;

    private $labelsSanityCheck;

    public function __construct ($idOrArray)
    {
        $this->arrayConstructionOnly = true;
        $this->labelsSanityCheck = false;

        parent::__construct($idOrArray);
    }

    public function getId ()
    {
        return $this->id;
    }

    public function getTitle ()
    {
        $this->lazyLoad();

        return $this->title;
    }

    public function getType ()
    {
        $this->lazyLoad();

        // @todo Workaround due to a bug in DaPulse's API see: https://github.com/allejo/PhpPulse/issues/5

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

        if ($this->type === "color")
        {
            $this->type = self::Status;
        }

        return $this->type;
    }

    /**
     * @api
     * @todo Remove at 0.4.0 or next breaking release

Comment refers to a TODO task

     * @deprecated 0.3.0 This information is only set on the "Last Update" column and therefore shall be removed. This
     *                   value is still available by getting the JSON equivalent of the object if it's needed.
     * @since  0.1.0
     * @return string|null
     */
    public function getEmptyText ()
    {
        $this->lazyLoad();

        return $this->empty_text;
    }

    /**
     * Get the labels for a Status column type
     *
     * @throws InvalidColumnException if the column is not a Status column
     *
     * @since  0.3.0 An InvalidColumnException is thrown when the given column is not a status column
     * @since  0.1.0
     *
     * @return string[]
     */
    public function getLabels ()
    {
        if ($this->getType() != PulseColumn::Status)
        {
            throw new InvalidColumnException('This column type does not contain labels');
        }

        $this->lazyLoad();
        $this->sanitizeLabels();

        return $this->labels;
    }

    public function getBoardId ()
    {
        $this->lazyLoad();

        return $this->board_id;
    }

    public function editTitle ($title)
    {
        $this->editField("title", $title);
    }

    public function editLabels ($labels)
    {
        $this->editField("labels", $labels);
    }

    public function deleteColumn ()
    {
        $this->checkInvalid();

        self::sendDelete($this->getColumnsUrl());

        $this->deletedObject = true;
    }

    private function editField ($field, $value)
    {
        $this->checkInvalid();

        $postParams = [
            $field => $value
        ];

        self::sendPut($this->getColumnsUrl(), $postParams);

        $this->$field = $value;
    }

    private function getColumnsUrl ()
    {
        return sprintf("%s/%d/columns/%s.json", parent::apiEndpoint(), $this->getBoardId(), $this->getId());

It seems like you call parent on a different method (apiEndpoint() instead of getColumnsUrl()). Are you sure this is correct? If so, you might want to change this to $this->apiEndpoint().

    }

    /**
     * DaPulse will only set labels if it has content
     */
    private function sanitizeLabels ()
    {
        if ($this->labelsSanityCheck)
        {
            return;
        }

        for ($i = StatusColumn::MIN_VALUE; $i <= StatusColumn::MAX_VALUE; $i++)
        {
            !isset($this->labels[$i]) && $this->labels[$i] = '';
        }

        $this->labelsSanityCheck = true;
    }
}