Signifly\Shopify\REST\Resources\ApiResource

Complexity

Total Complexity

16

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__get()	0	7	2
A	except()	0	3	2
A	only()	0	3	2
A	__construct()	0	4	1
A	__isset()	0	3	1
A	getAttributes()	0	3	1
A	offsetSet()	0	4	1
A	offsetExists()	0	4	1
A	getAttribute()	0	3	1
A	offsetUnset()	0	4	1
A	setAttribute()	0	5	1
A	offsetGet()	0	4	1
A	toArray()	0	3	1

<?php

namespace Signifly\Shopify\REST\Resources;

use ArrayAccess;
use Exception;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Arr;
use Illuminate\Support\Traits\Macroable;
use Signifly\Shopify\Shopify;

class ApiResource implements ArrayAccess, Arrayable
{
    use Macroable;

The trait Illuminate\Support\Traits\Macroable requires the property $name which is not provided by Signifly\Shopify\REST\Resources\ApiResource.

    protected array $attributes = [];

    protected Shopify $shopify;

    public function __construct(array $attributes, Shopify $shopify)
    {
        $this->attributes = $attributes;
        $this->shopify = $shopify;
    }

    /**
     * Get all of the attributes except for a specified array of keys.
     *
     * @param  array|string $keys
     * @return array
     */
    public function except($keys): array
    {
        return Arr::except($this->getAttributes(), is_array($keys) ? $keys : func_get_args());
    }

    /**
     * Get a subset of the attributes.
     *
     * @param  array|string $keys
     * @return array
     */
    public function only($keys): array
    {
        return Arr::only($this->getAttributes(), is_array($keys) ? $keys : func_get_args());
    }

    /**
     * @param  string $key
     * @return mixed
     */
    public function __get($key)
    {
        if (array_key_exists($key, $this->attributes)) {
            return $this->getAttribute($key);
        }

        throw new Exception('Property '.$key.' does not exist on '.get_called_class());
    }

    /**
     * @param  string $key
     * @return bool
     */
    public function __isset($key): bool
    {
        return array_key_exists($key, $this->attributes);
    }

    /**
     * Determine if the given attribute exists.
     *
     * @param  mixed  $offset
     * @return bool
     */
    #[\ReturnTypeWillChange]
    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->attributes);
    }

    /**
     * Get the value for a given offset.
     *
     * @param  mixed  $offset
     * @return mixed
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($offset)
    {
        return $this->getAttribute($offset);
    }

    /**
     * Set the value for a given offset.
     *
     * @param  mixed  $offset
     * @param  mixed  $value
     * @return void
     */
    #[\ReturnTypeWillChange]
    public function offsetSet($offset, $value)
    {
        return $this->setAttribute($offset, $value);
    }

    /**
     * Unset the value for a given offset.
     *
     * @param  mixed  $offset
     * @return void
     */
    #[\ReturnTypeWillChange]
    public function offsetUnset($offset)
    {
        unset($this->attributes[$offset]);
    }

    /**
     * Get an attribute.
     *
     * @param  string $key
     * @return mixed
     */
    protected function getAttribute($key)
    {
        return $this->attributes[$key];
    }

    /**
     * Set an attribute.
     *
     * @param string $key
     * @param mixed $value
     */
    protected function setAttribute($key, $value)
    {
        $this->attributes[$key] = $value;

        return $this;
    }

    /**
     * Get attributes for the resource.
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    public function toArray()
    {
        return $this->getAttributes();
    }
}