Guillermoandrae\Highrise\Resources\AbstractResource

Complexity

Total Complexity

15

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	update()	0	6	1
A	search()	0	13	3
A	find()	0	5	1
A	getName()	0	3	1
A	findAll()	0	5	1
A	create()	0	6	1
A	__construct()	0	6	2
A	hydrate()	0	14	4
A	delete()	0	4	1

<?php

namespace Guillermoandrae\Highrise\Resources;

use Guillermoandrae\Common\Collection;
use Guillermoandrae\Common\CollectionInterface;
use Guillermoandrae\Highrise\Entities\EntityFactory;
use Guillermoandrae\Highrise\Entities\EntityInterface;
use Guillermoandrae\Highrise\Helpers\Xml;
use Guillermoandrae\Highrise\Http\AdapterAwareTrait;
use Guillermoandrae\Highrise\Http\AdapterInterface;
use ICanBoogie\Inflector;

abstract class AbstractResource implements ResourceInterface
{
    use AdapterAwareTrait;

    /**
     * The name to be used in the resource endpoint.
     *
     * @var string
     */
    protected $name;

    /**
     * Builds the resource object.
     *
     * @param AdapterInterface $adapter  The HTTP adapter.
     */
    public function __construct(AdapterInterface $adapter)
    {
        $this->setAdapter($adapter);
        if (!$this->name) {
            $this->name = strtolower(
                str_replace(__NAMESPACE__ . '\\', '', get_class($this))
            );
        }
    }

    public function find($id): EntityInterface
    {
        $uri = sprintf('/%s/%s.xml', $this->getName(), $id);
        $results = $this->getAdapter()->request('GET', $uri);
        return $this->hydrate($results);

The expression return $this->hydrate($results) also could return the type Guillermoandrae\Common\Collection|array which is incompatible with the return type mandated by Guillermoandrae\Highrise\Resources\ResourceInterface::find() of Guillermoandrae\Highrise\Entities\EntityInterface.

    }

    public function findAll(array $filters = []): CollectionInterface
    {
        $uri = sprintf('/%s.xml', $this->getName());
        $results = $this->getAdapter()->request('GET', $uri, ['query' => $filters]);
        return $this->hydrate($results);

The expression return $this->hydrate($results) could return the type array which is incompatible with the type-hinted return Guillermoandrae\Common\CollectionInterface. Consider adding an additional type-check to rule them out.

    }

    public function search(array $criteria = []): CollectionInterface
    {
        $uri = sprintf('/%s/search.xml', $this->getName());
        $query = [];
        if (isset($criteria['term'])) {
            $query['term'] = $criteria['term'];
        } else {
            foreach ($criteria as $key => $value) {
                $query[sprintf('criteria[%s]', $key)] = $value;
            }
        }
        $results = $this->getAdapter()->request('GET', $uri, ['query' => $query]);
        return $this->hydrate($results);

The expression return $this->hydrate($results) could return the type array which is incompatible with the type-hinted return Guillermoandrae\Common\CollectionInterface. Consider adding an additional type-check to rule them out.

    }

    public function create(array $data): EntityInterface
    {
        $uri = sprintf('/%s.xml', $this->getName());
        $body = Xml::toXml(Inflector::get()->singularize($this->getName()), $data);
        $results = $this->getAdapter()->request('POST', $uri, ['body' => $body]);
        return $this->hydrate($results);

The expression return $this->hydrate($results) also could return the type Guillermoandrae\Common\Collection|array which is incompatible with the return type mandated by Guillermoandrae\Highrise\Resources\ResourceInterface::create() of Guillermoandrae\Highrise\Entities\EntityInterface.

    }

    public function update($id, array $data): EntityInterface
    {
        $uri = sprintf('/%s/%s.xml?reload=true', $this->getName(), $id);
        $body = Xml::toXml(Inflector::get()->singularize($this->getName()), $data);
        $results = $this->getAdapter()->request('PUT', $uri, ['body' => $body]);
        return $this->hydrate($results);

The expression return $this->hydrate($results) also could return the type Guillermoandrae\Common\Collection|array which is incompatible with the return type mandated by Guillermoandrae\Highrise\Resources\ResourceInterface::update() of Guillermoandrae\Highrise\Entities\EntityInterface.

    }

    public function delete($id): bool
    {
        $uri = sprintf('/%s/%s.xml', $this->getName(), $id);
        return $this->getAdapter()->request('DELETE', $uri);
    }

    public function getName(): string
    {
        return $this->name;
    }

    protected function hydrate(string $xml)
    {
        libxml_use_internal_errors(true);
        if (!$obj = simplexml_load_string($xml)) {
            return [];
        }
        if ($obj->attributes()) {
            $items = [];
            foreach ($obj->children() as $child) {
                $items[] = $this->hydrate($child);
            }
            return Collection::make($items);
        }
        return EntityFactory::factory($this->getName(), $xml);
    }
}