PulseBoard::addSubscriber() - Code Metrics - Inspection of "Add subscriber functions to boards" - allejo/PhpPulse - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b699ea...a3fc91 )

by Vladimir

created 2016-01-10 06:39 UTC

PulseBoard::addSubscriber() A

↳ Parent: PulseBoard

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	15
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	15
loc	15
rs	9.4286
cc	2
eloc	8
nc	2
nop	2

<?php

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

namespace allejo\DaPulse;

use allejo\DaPulse\Exceptions\ArgumentMismatchException;
use allejo\DaPulse\Exceptions\InvalidArraySizeException;
use allejo\DaPulse\Objects\ApiObject;
use allejo\DaPulse\Utilities\ArrayUtilities;

/**
 * This class contains all of the respective functionality for working a board on DaPulse
 *
 * @api
 * @package allejo\DaPulse
 * @since   0.1.0
 */
class PulseBoard extends ApiObject

{
    /**
     * The suffix that is appended to the URL to access functionality for certain objects
     *
     * @internal
     */
    const API_PREFIX = "boards";

    // ================================================================================================================
    //   Instance Variables
    // ================================================================================================================

    /**
     * The resource's URL.
     *
     * @var string
     */
    protected $url;

    /**
     * The board's unique identifier.
     *
     * @var int
     */
    protected $id;

    /**
     * The board's name.
     *
     * @var string
     */
    protected $name;

    /**
     * The board's description.
     *
     * @var string
     */
    protected $description;

    /**
     * The board's visible columns.
     *
     * @var array
     */
    protected $columns;

    /**
     * The board's visible groups.
     *
     * @var array
     */
    protected $groups;

    /**
     * Creation time.
     *
     * @var \DateTime
     */
    protected $created_at;

    /**
     * Last update time.
     *
     * @var \DateTime
     */
    protected $updated_at;

    /**
     * Whether or not groups have been fetched. Group data comes from both a unique API call and from the initial call
     * of getting the board data, so this data is merged; this boolean is to avoid fetching this data twice.
     *
     * @var bool
     */
    private $groupsFetched = false;

    // ================================================================================================================
    //   Getter functions
    // ================================================================================================================

    /**
     * The resource's URL.
     *
     * @api
     * @since  0.1.0
     * @return string
     */
    public function getUrl()
    {
        return $this->url;
    }

    /**
     * The board's unique identifier.
     *
     * @api
     * @since  0.1.0
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * The board's name.
     *
     * @api
     * @since  0.1.0
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * The board's description.
     *
     * @api
     * @since  0.1.0
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * The board's visible columns.
     *
     * @api
     * @since  0.1.0
     * @return PulseColumn[]
     */
    public function getColumns()
    {
        self::lazyInject($this->columns, array(
            "board_id" => $this->getId()
        ));
        self::lazyArray($this->columns, "PulseColumn");

        return $this->columns;
    }

    /**
     * Creation time.
     *
     * @api
     * @since  0.1.0
     * @return \DateTime
     */
    public function getCreatedAt()
    {
        self::lazyLoad($this->created_at, "DateTime");

        return $this->created_at;
    }

    /**
     * Last update time.
     *
     * @api
     * @since  0.1.0
     * @return \DateTime
     */
    public function getUpdatedAt()
    {
        self::lazyLoad($this->updated_at, "DateTime");

        return $this->updated_at;
    }

    // ================================================================================================================
    //   Subscriber functions
    // ================================================================================================================

    /**
     * Get the users who are subscribed to this board
     *
     * @param  array $params
     *
     * @return PulseUser[]
     */
    public function getSubscribers ($params = array())
    {
        $url = sprintf("%s/%d/subscribers.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        return parent::fetchJsonArrayToObjectArray($url, "PulseUser", $params);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Subscriber a user to a board
     *
     * @param int|PulseUser $user_id  The user that will be subscribed to the board
     * @param bool|null     $as_admin Set to true if the user will be an admin of the board
     */
    public function addSubscriber ($user_id, $as_admin = NULL)

    {
        if ($user_id instanceof PulseUser)
        {
            $user_id = $user_id->getId();
        }

        $url = sprintf("%s/%d/subscribers.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $params = array(
            "user_id" => $user_id
        );

        parent::setIfNotNullOrEmpty($params, "as_admin", $as_admin);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        parent::sendPut($url, $params);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Unsubscribe a user from this board
     *
     * @param int|PulseUser $user_id The user that will be unsubscribed from the board
     */
    public function removeSubscriber ($user_id)

    {
        if ($user_id instanceof PulseUser)
        {
            $user_id = $user_id->getId();
        }

        $url = sprintf("%s/%d/subscribers/%d.json", parent::apiEndpoint(), $this->getId(), $user_id);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        parent::sendDelete($url);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    // ================================================================================================================
    //   Columns functions
    // ================================================================================================================

    /**
     * Create a new column for the current board.
     *
     * If you are creating a status column, use the constants available in the **PulseColumnColorValue** class to match the
     * colors. Keep in mind this array cannot have a key higher than 11 nor can it be an associative array. Here's an
     * example of how to match statuses with specific colors.
     *
     * ```php
     * $labels = array(
     *     PulseColumnColorValue::Orange  => "Working on it",
     *     PulseColumnColorValue::L_Green => "Done",
     *     PulseColumnColorValue::Red     => "Delayed"
     * );
     * ```
     *
     * @api
     *
     * @param string $title  The title of the column. This title will automatically be "slugified" and become the ID
     *                       of the column.
     * @param string $type   The type of value that this column will use. Either use the available constants in the
     *                       PulseColumn class or use the following strings: "date", "person", "status", "text".
     * @param array  $labels If the column type will be "status," then this array will be the values for each of the
     *                       colors.
     *
     * @see PulseColumn::Date   PulseColumn::Date
     * @see PulseColumn::Person PulseColumn::Person
     * @see PulseColumn::Status PulseColumn::Status
     * @see PulseColumn::Text   PulseColumn::Text
     * @see PulseColumnColorValue::Orange  PulseColumnColorValue::Orange
     * @see PulseColumnColorValue::L_Green PulseColumnColorValue::L_Green
     * @see PulseColumnColorValue::Red     PulseColumnColorValue::Red
     * @see PulseColumnColorValue::Blue    PulseColumnColorValue::Blue
     * @see PulseColumnColorValue::Purple  PulseColumnColorValue::Purple
     * @see PulseColumnColorValue::Grey    PulseColumnColorValue::Grey
     * @see PulseColumnColorValue::Green   PulseColumnColorValue::Green
     * @see PulseColumnColorValue::L_Blue  PulseColumnColorValue::L_Blue
     * @see PulseColumnColorValue::Gold    PulseColumnColorValue::Gold
     * @see PulseColumnColorValue::Yellow  PulseColumnColorValue::Yellow
     * @see PulseColumnColorValue::Black   PulseColumnColorValue::Black
     *
     * @since 0.1.0
     *
     * @throws ArgumentMismatchException Status definitions were defined yet the type of the column was not a status
     *                                   type column
     * @throws InvalidArraySizeException The array containing the value of statuses has a key larger than the
     *                                   supported 10 indices
     *
     * @return $this This instance will be updated to have updated information to reflect the new column that was
     *               created
     */
    public function createColumn ($title, $type, $labels = array())
    {
        if ($type !== PulseColumn::Status && !empty($labels))
        {
            throw new ArgumentMismatchException("No color definitions are required for a non-color column.");
        }

        if ($type === PulseColumn::Status && count($labels) > 0 && max(array_keys($labels)) > 10)
        {
            throw new InvalidArraySizeException("The range of status can only be from 0-10.");
        }

        $url        = sprintf("%s/%d/columns.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $postParams = array(
            "title" => $title,
            "type"  => $type
        );

        self::setIfNotNullOrEmpty($postParams, "labels", $labels);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->jsonResponse = self::sendPost($url, $postParams);

        $this->assignResults();

        return $this;
    }

    // ================================================================================================================
    //   Group functions
    // ================================================================================================================

    /**
     * Get all of the groups belonging to a board.
     *
     * A group is defined as the colorful headers that split up pulses into categories.
     *
     * @api
     *
     * @param bool $showArchived Set to true if you would like to get archived groups in a board as well
     *
     * @since 0.1.0
     *
     * @return PulseGroup[]
     */
    public function getGroups ($showArchived = false)
    {
        if (!$this->groupsFetched)
        {
            $fetchedGroups = $this->fetchGroups($showArchived);

            $this->groups = ArrayUtilities::array_merge_recursive_distinct($this->groups, $fetchedGroups);
            $this->groupsFetched = true;
        }

        self::lazyArray($this->groups, "PulseGroup");

        return $this->groups;
    }

    public function createGroup ($title)
    {
        $url        = sprintf("%s/%s/groups.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $postParams = array("title" => $title);

        // The API doesn't return the board ID, so since we have access to it here: set it manually
        $groupResult             = self::sendPost($url, $postParams);
        $groupResult["board_id"] = $this->getId();

        return (new PulseGroup($groupResult));
    }

    private function fetchGroups ($showArchived)
    {
        $url = sprintf("%s/%s/groups.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        $this->groupsFetched = true;

        return self::sendGet($url, array("show_archived" => $showArchived));
    }

    // ================================================================================================================
    //   Pulse functions
    // ================================================================================================================

    /**
     * @return Pulse[]
     */
    public function getPulses ()
    {
        $url = sprintf("%s/%d/pulses.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $data = self::sendGet($url);
        $pulses = array();

        foreach ($data as $entry)
        {
            $this->pulseInjection($entry);

            $pulses[] = new Pulse($entry["pulse"]);
        }

        return $pulses;
    }

    public function createPulse ($name, $owner, $group_id = null)

    {
        $url = sprintf("%s/%d/pulses.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $postParams = array(
            "user_id" => $owner,
            "pulse" => array(
                "name" => $name
            )
        );

        self::setIfNotNullOrEmpty($postParams, "group_id", $group_id);

        $result = self::sendPost($url, $postParams);
        $this->pulseInjection($result);

        return (new Pulse($result["pulse"]));
    }

    private function pulseInjection (&$result)

    {
        // Inject some information so a Pulse object can survive on its own
        $result["pulse"]["group_id"] = $result["board_meta"]["group_id"];
        $result["pulse"]["column_structure"] = $this->getColumns();
        $result["pulse"]["raw_column_values"] = $result["column_values"];
    }

    // ================================================================================================================
    //   Board functions
    // ================================================================================================================

    public function archiveBoard ()

    {
        $this->checkInvalid();

        $url = sprintf("%s/%s.json", parent::apiEndpoint(), $this->getId());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        self::sendDelete($url);

        $this->deletedObject = true;
    }

    public static function createBoard ($name, $user_id, $description = NULL)

    {
        $url        = sprintf("%s.json", parent::apiEndpoint());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $postParams = array(
            "user_id" => $user_id,
            "name"    => $name
        );

        self::setIfNotNullOrEmpty($postParams, "description", $description);

        $boardResult = self::sendPost($url, $postParams);

        return (new PulseBoard($boardResult));
    }

    public static function getBoards ($params = array())
    {
        $url = sprintf("%s.json", parent::apiEndpoint());
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        return parent::fetchJsonArrayToObjectArray($url, "PulseBoard", $params);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }
}

1			<?php
2
3			/**
4			* This file contains the PulseBoard class
5			*
6			* @copyright 2015 Vladimir Jimenez
7			* @license https://github.com/allejo/PhpPulse/blob/master/LICENSE.md MIT
8			*/
9
10			namespace allejo\DaPulse;
11
12			use allejo\DaPulse\Exceptions\ArgumentMismatchException;
13			use allejo\DaPulse\Exceptions\InvalidArraySizeException;
14			use allejo\DaPulse\Objects\ApiObject;
15			use allejo\DaPulse\Utilities\ArrayUtilities;
16
17			/**
18			* This class contains all of the respective functionality for working a board on DaPulse
19			*
20			* @api
21			* @package allejo\DaPulse
22			* @since 0.1.0
23			*/
24			class PulseBoard extends ApiObject
			0 ignored issues – show Coding Style introduced 2015-11-24 07:30 UTC by Report Bug Copy Issue Report The property $created_at is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2015-11-24 07:30 UTC by Report Bug Copy Issue Report The property $updated_at is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
25			{
26			/**
27			* The suffix that is appended to the URL to access functionality for certain objects
28			*
29			* @internal
30			*/
31			const API_PREFIX = "boards";
32
33			// ================================================================================================================
34			// Instance Variables
35			// ================================================================================================================
36
37			/**
38			* The resource's URL.
39			*

allejo / PhpPulse

Push — master ( b699ea...a3fc91 )

PulseBoard::addSubscriber() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like