Arcanedev\Stripe\StripeObject

Complexity

Total Complexity

82

Size/Duplication

Total Lines	674
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

94.57%

Importance

Changes

0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
B	init()	0	31	1
A	setId()	0	8	2
A	setIdIfArray()	0	9	2
A	getRetrieveParams()	0	4	1
A	__get()	0	11	2
A	__set()	0	7	1
B	setValue()	0	20	5
A	getLastResponse()	0	4	1
A	setLastResponse()	0	6	1
A	__isset()	0	4	1
A	__unset()	0	7	1
A	__toString()	0	4	1
A	jsonSerialize()	0	4	1
A	toArray()	0	6	2
A	toJson()	0	7	3
A	keys()	0	4	2
A	offsetSet()	0	4	1
A	offsetExists()	0	4	1
A	offsetUnset()	0	4	1
A	offsetGet()	0	6	2
A	scopedConstructFrom()	0	7	2
B	refreshFrom()	0	16	5
A	cleanObject()	0	16	4
A	constructValue()	0	6	3
A	lsb()	0	7	1
A	scopedLsb()	0	7	1
A	checkIdIsInArray()	0	5	2
A	hasRetrieveParams()	0	4	1
A	checkIfAttributeDeletion()	0	10	3
A	checkMetadataAttribute()	0	10	4
A	checkPermanentAttributes()	0	5	2
A	checkUnsavedAttributes()	0	9	3
A	checkNotFoundAttributesException()	0	7	2
A	serializeParameters()	0	9	1
A	serializeUnsavedValues()	0	6	3
B	serializeNestedUpdatableAttributes()	0	12	5
A	showUndefinedPropertyMsg()	0	13	4
A	showUndefinedPropertyMsgAttributes()	0	6	2

<?php namespace Arcanedev\Stripe;

use Arcanedev\Stripe\Contracts\StripeObject as StripObjectContract;
use Arcanedev\Stripe\Contracts\Utilities\Arrayable;
use Arcanedev\Stripe\Contracts\Utilities\Jsonable;
use Arcanedev\Stripe\Exceptions\ApiException;
use Arcanedev\Stripe\Exceptions\InvalidArgumentException;
use Arcanedev\Stripe\Http\RequestOptions;
use Arcanedev\Stripe\Http\Response;
use Arcanedev\Stripe\Utilities\Util;
use Arcanedev\Stripe\Utilities\UtilSet;
use ArrayAccess;
use JsonSerializable;

/**
 * Class     StripeObject
 *
 * @package  Arcanedev\Stripe
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  string  id
 * @property  string  object
 */
class StripeObject implements StripObjectContract, ArrayAccess, JsonSerializable, Arrayable, Jsonable
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * @var \Arcanedev\Stripe\Http\RequestOptions|string|array
     */
    protected $opts;

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

    /**
     * Unsaved Values.
     *
     * @var \Arcanedev\Stripe\Utilities\UtilSet
     */
    protected $unsavedValues;

    /**
     * Transient (Deleted) Values.
     *
     * @var \Arcanedev\Stripe\Utilities\UtilSet
     */
    protected $transientValues;

    /**
     * Retrieve parameters used to query the object.
     *
     * @var array
     */
    protected $retrieveParameters;

    /**
     * Attributes that should not be sent to the API because
     * they're not updatable (e.g. API key, ID).
     *
     * @var \Arcanedev\Stripe\Utilities\UtilSet
     */
    public static $permanentAttributes;

    /**
     * Attributes that are nested but still updatable from the
     * parent class's URL (e.g. metadata).
     *
     * @var \Arcanedev\Stripe\Utilities\UtilSet
     */
    public static $nestedUpdatableAttributes;

    /**
     * Allow to check attributes while setting.
     *
     * @var bool
     */
    protected $checkUnsavedAttributes = false;

    /**
     * The last response.
     *
     * @var  \Arcanedev\Stripe\Http\Response
     */
    protected $lastResponse;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Make a Stripe object instance.
     *
     * @param  string|null        $id
     * @param  string|array|null  $options
     */
    public function __construct($id = null, $options = null)
    {
        $this->init();
        $this->opts = $options ? $options : new RequestOptions;
        $this->setId($id);
    }

    /**
     * Init the stripe object.
     */
    private function init()
    {
        $this->values                    = [];
        self::$permanentAttributes       = new UtilSet(['opts', 'id']);
        self::$nestedUpdatableAttributes = new UtilSet([
            // Numbers are in place for indexes in an `additional_owners` array.
            // There's a maximum allowed additional owners of 3, but leave the 4th so errors work properly.
            0, 1, 2, 3, 4,
            'additional_owners',
            'address',
            'address_kana',
            'address_kanji',
            'dob',
            'inventory',
            'legal_entity',
            'metadata',
            'owner',
            'payout_schedule',
            'personal_address',
            'personal_address_kana',
            'personal_address_kanji',
            'shipping',
            'tos_acceptance',
            'transfer_schedule',
            'verification',
        ]);

        $this->unsavedValues             = new UtilSet;
        $this->transientValues           = new UtilSet;
        $this->retrieveParameters        = [];
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters (+Magics)
     | -----------------------------------------------------------------
     */

    /**
     * Set the Id.
     *
     * @param  array|string|null  $id
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return self
     */
    private function setId($id)
    {
        $this->setIdIfArray($id);

        if ( ! is_null($id)) $this->id = $id;

        return $this;
    }

    /**
     * Set the Id from Array.
     *
     * @param  array|string|null  $id
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private function setIdIfArray(&$id)
    {
        if ( ! is_array($id)) return;

        $this->checkIdIsInArray($id);
        $this->retrieveParameters = array_diff_key($id, array_flip(['id']));

        $id = $id['id'];
    }

    /**
     * Get Retrieve Parameters.
     *
     * @return array
     */
    protected function getRetrieveParams()
    {
        return $this->retrieveParameters;
    }

    /**
     * Standard get accessor.
     *
     * @param  string|int  $key
     *
     * @return mixed|null
     */
    public function &__get($key)
    {
        $nullVal = null;

        if (in_array($key, $this->keys()))
            return $this->values[$key];

        $this->showUndefinedPropertyMsg(get_class($this), $key);

        return $nullVal;
    }

    /**
     * Standard set accessor.
     *
     * @param  string  $key
     * @param  mixed   $value
     */
    public function __set($key, $value)
    {
        $supportedAttributes = $this->keys();

        $this->setValue($key, $value);
        $this->checkUnsavedAttributes($supportedAttributes);
    }

    /**
     * Set value.
     *
     * @param  string  $key
     * @param  mixed   $value
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private function setValue($key, $value)
    {
        $this->checkIfAttributeDeletion($key, $value);
        $this->checkMetadataAttribute($key, $value);

        if (
            self::$nestedUpdatableAttributes->includes($key) &&
            isset($this->$key) &&
            $this->$key instanceof AttachedObject &&
            is_array($value)
        ) {
            $this->$key->replaceWith($value);
        }
        else {
            // TODO: may want to clear from $transientValues (Won't be user-visible).
            $this->values[$key] = $value;
        }

        $this->checkPermanentAttributes($key);
    }

    /**
     * Get the last response from the Stripe API.
     *
     * @return \Arcanedev\Stripe\Http\Response
     */
    public function getLastResponse()
    {
        return $this->lastResponse;
    }

    /**
     * Set the last response from the Stripe API.
     *
     * @param  \Arcanedev\Stripe\Http\Response  $response
     *
     * @return static
     */
    public function setLastResponse(Response $response)
    {
        $this->lastResponse = $response;

        return $this;
    }

    /**
     * Check has a value by key.
     *
     * @param  string  $key
     *
     * @return bool
     */
    public function __isset($key)
    {
        return isset($this->values[$key]);
    }

    /**
     * Unset element from values.
     *
     * @param  string  $key
     */
    public function __unset($key)
    {
        unset($this->values[$key]);

        $this->transientValues->add($key);
        $this->unsavedValues->discard($key);
    }

    /**
     * Convert StripeObject to string.
     *
     * @return string
     */
    public function __toString()
    {
        return get_class($this).' JSON: '.$this->toJson();
    }

    /**
     * Json serialize.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray(true);
    }

    /**
     * Convert StripeObject to array.
     *
     * @param  bool  $recursive
     *
     * @return array
     */
    public function toArray($recursive = false)
    {
        return $recursive
            ? Util::convertStripeObjectToArray($this->values)
            : $this->values;
    }

    /**
     * Convert StripeObject to JSON.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        if ($options === 0 && defined('JSON_PRETTY_PRINT'))
            $options = JSON_PRETTY_PRINT;

        return json_encode($this->toArray(true), $options);
    }

    /**
     * Get only value keys.
     *
     * @return array
     */
    public function keys()
    {
        return empty($this->values) ? [] : array_keys($this->values);
    }

    /* -----------------------------------------------------------------
     |  ArrayAccess methods
     | -----------------------------------------------------------------
     */

    public function offsetSet($key, $value)
    {
        $this->$key = $value;
    }

    public function offsetExists($key)
    {
        return array_key_exists($key, $this->values);
    }

    public function offsetUnset($key)
    {
        unset($this->$key);
    }

    public function offsetGet($key)
    {
        return array_key_exists($key, $this->values)
            ? $this->values[$key]
            : null;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * This unfortunately needs to be public to be used in Util.php
     * Return The object constructed from the given values.
     *
     * @param  array                                                    $values
     * @param  \Arcanedev\Stripe\Http\RequestOptions|array|string|null  $options
     *
     * @return static
     */
    public static function scopedConstructFrom($values, $options)
    {
        $obj = new static(isset($values['id']) ? $values['id'] : null);
        $obj->refreshFrom($values, $options);

        return $obj;
    }

    /**
     * Refreshes this object using the provided values.
     *
     * @param  array                                                    $values
     * @param  \Arcanedev\Stripe\Http\RequestOptions|array|string|null  $options
     * @param  bool                                                     $partial
     */
    public function refreshFrom($values, $options, $partial = false)
    {
        $this->opts = is_array($options) ? RequestOptions::parse($options) : $options;

        $this->cleanObject($values, $partial);

        foreach ($values as $key => $value) {
            if (self::$permanentAttributes->includes($key) && isset($this[$key]))
                continue;

            $this->values[$key] = $this->constructValue($key, $value, $this->opts);

            $this->transientValues->discard($key);
            $this->unsavedValues->discard($key);
        }
    }

    /**
     * Clean refreshed StripeObject.
     *
     * @param  array       $values
     * @param  bool|false  $partial
     */
    private function cleanObject($values, $partial)
    {
        // Wipe old state before setting new.
        // This is useful for e.g. updating a customer, where there is no persistent card parameter.
        // Mark those values which don't persist as transient
        $removed = ! $partial
            ? array_diff($this->keys(), array_keys($values))
            : new UtilSet;

        foreach ($removed as $key) {
            if (self::$permanentAttributes->includes($key))
                continue;

            unset($this->$key);
        }
    }

    /**
     * Construct Value.
     *
     * @param  string                                                   $key
     * @param  mixed                                                    $value
     * @param  \Arcanedev\Stripe\Http\RequestOptions|array|string|null  $options
     *
     * @return static|\Arcanedev\Stripe\StripeResource|\Arcanedev\Stripe\Collection|array
     */
    private function constructValue($key, $value, $options)
    {
        return (self::$nestedUpdatableAttributes->includes($key) && is_array($value))
            ? AttachedObject::scopedConstructFrom($value, $options)
            : Util::convertToStripeObject($value, $options);
    }

    /**
     * Pretend to have late static bindings.
     *
     * @param  string  $method
     *
     * @return mixed
     */
    protected function lsb($method)
    {
        return call_user_func_array(
            [get_class($this), $method],
            array_slice(func_get_args(), 1)
        );
    }

    /**
     * Scoped Late Static Bindings.
     *
     * @param  string  $class
     * @param  string  $method
     *
     * @return mixed
     */
    protected static function scopedLsb($class, $method)
    {
        return call_user_func_array(
            [$class, $method],
            array_slice(func_get_args(), 2)
        );
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if array has id.
     *
     * @param  array  $array
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private function checkIdIsInArray($array)
    {
        if ( ! array_key_exists('id', $array))
            throw new ApiException('The attribute id must be included.');
    }

    /**
     * Check if object has retrieve parameters.
     *
     * @return bool
     */
    public function hasRetrieveParams()
    {
        return (bool) count($this->getRetrieveParams());
    }

    /**
     * Check if attribute deletion.
     *
     * @param  string      $key
     * @param  mixed|null  $value
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private function checkIfAttributeDeletion($key, $value)
    {
        // Don't use empty($value) instead of ($value === '')
        if ( ! is_null($value) && $value === '')
            throw new InvalidArgumentException(
                "You cannot set '{$key}' to an empty string. "
                . 'We interpret empty strings as \'null\' in requests. '
                . "You may set obj->{$key} = null to delete the property"
            );
    }

    /**
     * Check metadata attribute.
     *
     * @param  string      $key
     * @param  mixed|null  $value
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private function checkMetadataAttribute($key, $value)
    {
        if (
            $key === 'metadata' &&
            ( ! is_array($value) && ! is_null($value))
        )
            throw new InvalidArgumentException(
                'The metadata value must be an array or null, '.gettype($value).' is given'
            );
    }

    /**
     * Check permanent attributes.
     *
     * @param  string  $key
     */
    private function checkPermanentAttributes($key)
    {
        if ( ! self::$permanentAttributes->includes($key))
            $this->unsavedValues->add($key);
    }

    /**
     * Check unsaved attributes.
     *
     * @param  array  $supported
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private function checkUnsavedAttributes($supported)
    {
        if ($this->checkUnsavedAttributes === false || count($supported) === 0)
            return;

        $this->checkNotFoundAttributesException(
            $this->unsavedValues->diffKeys($supported)
        );
    }

    /**
     * Check not found attributes exception.
     *
     * @param  array  $notFound
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private function checkNotFoundAttributesException($notFound)
    {
        if (count($notFound))
            throw new InvalidArgumentException(
                'The attributes ['.implode(', ', $notFound).'] are not supported.'
            );
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * A recursive mapping of attributes to values for this object,
     * including the proper value for deleted attributes.
     *
     * @return array
     */
    protected function serializeParameters()
    {
        $params = [];

        $this->serializeUnsavedValues($params);
        $this->serializeNestedUpdatableAttributes($params);

        return $params;
    }

    /**
     * Serialize unsaved values.
     *
     * @param  array  $params
     */
    private function serializeUnsavedValues(&$params)
    {
        foreach ($this->unsavedValues->toArray() as $key) {
            $params[$key] = ! is_null($value = $this->$key) ? $value : '';
        }
    }

    /**
     * Serialize nested updatable attributes.
     *
     * @param  array  $params
     */
    private function serializeNestedUpdatableAttributes(&$params)
    {
        foreach (self::$nestedUpdatableAttributes->toArray() as $property) {
            if (
                isset($this->$property) &&
                $this->$property instanceof self &&
                $serialized = $this->$property->serializeParameters()
            ) {
                $params[$property] = $serialized;
            }
        }
    }

    /**
     * Show undefined property warning message.
     *
     * @param  string  $class
     * @param  string  $key
     */
    private function showUndefinedPropertyMsg($class, $key)
    {
        $message = "Stripe Notice: Undefined property of {$class} instance: {$key}.";

        if ( ! $this->transientValues->isEmpty() && $this->transientValues->includes($key)) {
            $message .= " HINT: The [{$key}] attribute was set in the past, however. " .
                'It was then wiped when refreshing the object with the result returned by Stripe\'s API, ' .
                'probably as a result of a save().'.$this->showUndefinedPropertyMsgAttributes();
        }

        if ( ! is_testing())
            Stripe::getLogger()->error($message);
    }

    /**
     * Show available attributes for undefined property warning message.
     *
     * @return string
     */
    private function showUndefinedPropertyMsgAttributes()
    {
        return count($attributes = $this->keys())
            ? ' The attributes currently available on this object are: '.implode(', ', $attributes)
            : '';
    }
}