Scriptotek\Alma\GhostModel

Complexity

Total Complexity

13

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
	isInitialized()	0	1	?
B	init()	0	21	6
A	fetchData()	0	4	1
A	setData()	0	3	1
A	getData()	0	4	1
A	exists()	0	8	2
	urlBase()	0	1	?
A	url()	0	4	1

<?php

namespace Scriptotek\Alma;

use Psr\Http\Message\UriInterface;
use Scriptotek\Alma\Exception\ResourceNotFound;

abstract class GhostModel extends Model
{
    /**
     * This class is a ghost object that lazy loads the full record only when needed.
     * If $initialized is false, it means we haven't yet loaded the full record.
     * We can still have incomplete data from a search response.
     */
    protected $initialized = false;

    public function __construct(Client $client)
    {
        parent::__construct($client);
    }

    /**
     * Check if we have the full representation of our data object.
     *
     * @param \stdClass $data
     * @return boolean
     */
    abstract protected function isInitialized($data);

    /**
     * Load data onto this object. Chainable method.
     *
     * @param \stdClass $data
     *
     * @return self
     */
    public function init($data = null)
    {
        if ($this->initialized) {
            return $this;
        }

        if (is_null($data)) {
            $data = $this->fetchData();
        }

        if (!is_null($data) && $this->isInitialized($data)) {
            $this->initialized = true;
        }

        $this->data = $data;
        if ($this->initialized) {
            $this->setData($data);
        }

        return $this;
    }

    /**
     * Get the model data.
     */
    protected function fetchData()
    {
        return $this->client->getJSON($this->url());
    }

    /**
     * Store data onto object. Can be overriden.
     *
     * @param \stdClass $data
     */
    protected function setData(\stdClass $data)
    {
    }

    /**
     * Get the raw data object.
     */
    public function getData()
    {
        return $this->init()->data;
    }

    /**
     * Check if the object exists.
     */
    public function exists()
    {
        try {
            $this->init();
        } catch (ResourceNotFound $ex) {}

Consider adding a comment why this CATCH block is empty.

        return $this->initialized;
    }

    /**
     * Generate the base URL for this resource.
     *
     * @return string
     */
    abstract protected function urlBase();

    /**
     * Build a full URL for a resource.
     *
     * @param string $url
     * @param array $query
     * @return UriInterface
     */
    protected function url($url = '', $query = [])
    {
        return $this->client->buildUrl($this->urlBase() . $url, $query);
    }
}