Trello\Model\AbstractObject

Complexity

Total Complexity

24

Size/Duplication

Total Lines	235
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	getId()	0	4	1
A	refresh()	0	8	1
A	save()	0	16	4
A	remove()	0	15	2
A	getData()	0	4	1
A	setData()	0	6	1
A	update()	0	8	1
A	create()	0	9	1
A	preSave()	0	3	1
A	postSave()	0	3	1
A	preCreate()	0	3	1
A	postCreate()	0	3	1
A	preUpdate()	0	3	1
A	postUpdate()	0	3	1
A	preRefresh()	0	3	1
A	postRefresh()	0	3	1
A	preRemove()	0	3	1
A	postRemove()	0	3	1

<?php

namespace Trello\Model;

use Trello\ClientInterface;
use Trello\Api\ApiInterface;
use Trello\Exception\BadMethodCallException;

/**
 * @codeCoverageIgnore
 */
abstract class AbstractObject
{
    /**
     * @var ClientInterface
     */
    protected $client;

    /**
     * @var string
     */
    protected $apiName;

    /**
     * @var ApiInterface
     */
    protected $api;

    /**
     * @var array
     */
    protected $fields;

    /**
     * Default load params, should be overwritten
     * in child classes
     *
     * @var array
     */
    protected $loadParams = array('fields' => 'all');

    /**
     * @var string
     */
    protected $id;

    /**
     * @var array
     */
    protected $data;

    /**
     * Constructor.
     *
     * @param ClientInterface $client the Trello client
     * @param string          $id     the id of the object
     */
    public function __construct(ClientInterface $client, $id = null)
    {
        $this->client = $client;
        $this->api    = $client->api($this->apiName);

        $this->fields = $this->api->getFields();

        if ($id) {

The expression $id of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $this->id = $id;
            $this->refresh();
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * {@inheritdoc}
     */
    public function refresh()
    {
        $this->preRefresh();
        $this->data = $this->api->show($this->id, $this->loadParams);

It seems like you code against a concrete implementation and not the interface Trello\Api\ApiInterface as the method show() does only exist in the following implementations of said interface: Trello\Api\Action, Trello\Api\Board, Trello\Api\Board\Cards, Trello\Api\Board\Labels, Trello\Api\Card, Trello\Api\Card\Attachments, Trello\Api\Card\Stickers, Trello\Api\Cardlist, Trello\Api\Checklist, Trello\Api\Member, Trello\Api\Notification, Trello\Api\Organization, Trello\Api\Token, Trello\Api\Token\Webhooks, Trello\Api\Webhook.

        $this->postRefresh();

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function save()
    {
        try {
            $this->preSave();
            $this->id ? $this->update() : $this->create();
            $this->postSave();
        } catch (BadMethodCallException $e) {
            throw new BadMethodCallException(sprintf(
                "You can't %s %s objects.",
                $this->id ? 'update' : 'create',
                get_called_class()
            ));
        }

        return $this->refresh();
    }

    /**
     * {@inheritdoc}
     */
    public function remove()
    {
        try {
            $this->preRemove();
            $this->api->remove($this->id);

It seems like you code against a concrete implementation and not the interface Trello\Api\ApiInterface as the method remove() does only exist in the following implementations of said interface: Trello\Api\Action, Trello\Api\Board\Members, Trello\Api\Card\Attachments, Trello\Api\Card\Checklists, Trello\Api\Card\Labels, Trello\Api\Card\Members, Trello\Api\Card\Stickers, Trello\Api\Checklist, Trello\Api\Checklist\Items, Trello\Api\Token, Trello\Api\Token\Webhooks, Trello\Api\Webhook.

            $this->postRemove();
        } catch (BadMethodCallException $e) {
            throw new BadMethodCallException(sprintf(
                "You can't remove %s objects.",
                get_called_class()
            ));
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * {@inheritdoc}
     */
    public function setData(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Update the object through API
     *
     * @return AbstractObject
     */
    protected function update()
    {
        $this->preUpdate();
        $this->data = $this->api->update($this->id, $this->data);

It seems like you code against a concrete implementation and not the interface Trello\Api\ApiInterface as the method update() does only exist in the following implementations of said interface: Trello\Api\Action, Trello\Api\Board, Trello\Api\Card, Trello\Api\Card\Stickers, Trello\Api\Cardlist, Trello\Api\Checklist, Trello\Api\Checklist\Items, Trello\Api\Member, Trello\Api\Notification, Trello\Api\Token\Webhooks, Trello\Api\Webhook.

        $this->postUpdate();

        return $this;
    }

    /**
     * Create the object through API
     *
     * @return AbstractObject
     */
    protected function create()
    {
        $this->preCreate();
        $this->data = $this->api->create($this->data);

It seems like you code against a concrete implementation and not the interface Trello\Api\ApiInterface as the method create() does only exist in the following implementations of said interface: Trello\Api\Board, Trello\Api\Board\Cardlists, Trello\Api\Board\Checklists, Trello\Api\Card, Trello\Api\Card\Attachments, Trello\Api\Card\Checklists, Trello\Api\Card\Stickers, Trello\Api\Cardlist, Trello\Api\Cardlist\Cards, Trello\Api\Checklist, Trello\Api\Checklist\Items, Trello\Api\Token\Webhooks, Trello\Api\Webhook.

        $this->id   = $this->data['id'];
        $this->postCreate();

        return $this;
    }

    /**
     * Called before saving (creating or updating) an entity
     */
    protected function preSave()
    {
    }

    /**
     * Called after saving (creating or updating) an entity
     */
    protected function postSave()
    {
    }

    /**
     * Called before creating an entity
     */
    protected function preCreate()
    {
    }

    /**
     * Called after creating an entity
     */
    protected function postCreate()
    {
    }

    /**
     * Called before updating an entity
     */
    protected function preUpdate()
    {
    }

    /**
     * Called after updating an entity
     */
    protected function postUpdate()
    {
    }

    /**
     * Called before refreshing an entity
     */
    protected function preRefresh()
    {
    }

    /**
     * Called after refreshing an entity
     */
    protected function postRefresh()
    {
    }

    /**
     * Called before removing an entity
     */
    protected function preRemove()
    {
    }

    /**
     * Called after removing an entity
     */
    protected function postRemove()
    {
    }
}