ARCANEDEV / Stripe

src/Collection.php

<?php namespace Arcanedev\Stripe;

use Arcanedev\Stripe\Contracts\CollectionInterface;
use Arcanedev\Stripe\Exceptions\ApiException;
use Arcanedev\Stripe\Utilities\AutoPagingIterator;
use Arcanedev\Stripe\Utilities\Util;

/**
 * Class     Collection
 *
 * @package  Arcanedev\Stripe
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  string  object
 * @property  array   data
 * @property  int     total_count
 * @property  bool    has_more
 * @property  string  url
 */
class Collection extends StripeResource implements CollectionInterface
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /** @var array  */
    protected $requestParams = [];

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Set the request parameters.
     *
     * @param  array  $params
     */
    public function setRequestParams($params)
    {
        $this->requestParams = $params;
    }

    /* ------------------------------------------------------------------------------------------------
     |  CRUD Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * List Function.
     *
     * @param  array              $params
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return self|array
     */
    public function all($params = [], $options = null)
    {
        return $this->requestAndConvertToStripeObject('get', $params, $options);
    }

    /**
     * Create Function.
     *
     * @param  array              $params
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return \Arcanedev\Stripe\StripeObject|\Arcanedev\Stripe\StripeResource|array
     */
    public function create($params = [], $options = null)
    {
        return $this->requestAndConvertToStripeObject('post', $params, $options);
    }

    /**
     * Retrieve Function.
     *
     * @param  string             $id
     * @param  array              $params
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return \Arcanedev\Stripe\StripeObject|\Arcanedev\Stripe\StripeResource|array
     */
    public function retrieve($id, $params = [], $options = null)
    {
        list($url, $params)    = $this->extractPathAndUpdateParams($params);
        $extn                  = urlencode(str_utf8($id));
        list($response, $opts) = $this->request('get', "$url/$extn", $params);

        $this->setRequestParams($params);

        return Util::convertToStripeObject($response, $opts);
    }

    /**
     * Make a request and convert to Stripe object.
     *
     * @param  string             $method
     * @param  array              $params
     * @param  array|string|null  $options
     *
     * @return self|\Arcanedev\Stripe\StripeObject|\Arcanedev\Stripe\StripeResource|array|
     */
    private function requestAndConvertToStripeObject($method, $params, $options)
    {
        list($url, $params)    = $this->extractPathAndUpdateParams($params);
        list($response, $opts) = $this->request($method, $url, $params, $options);

        $this->setRequestParams($params);

        return Util::convertToStripeObject($response, $opts);
    }

    /**
     * Get An iterator that can be used to iterate across all objects across all pages.
     *     As page boundaries are encountered, the next page will be fetched automatically
     *     for continued iteration.
     *
     * @return \Arcanedev\Stripe\Utilities\AutoPagingIterator
     */
    public function autoPagingIterator()
    {
        return AutoPagingIterator::make($this, $this->requestParams);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if Object is list.
     *
     * @return bool
     */
    public function isList()
    {
        return $this->object === 'list';
    }

    /**
     * Check if URL has path.
     *
     * @param  array  $url
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private function checkPath(array $url)
    {
        if ( ! isset($url['path']) || empty($url['path'])) {
            throw new ApiException(
                'Could not parse list url into parts: ' . $this->url
            );
        }
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get items Count.
     *
     * @return int
     */
    public function count()
    {
        return ($this->isList() && isset($this->total_count))
            ? $this->total_count
            : 0;
    }

    /**
     * Extract Path And Update Parameters.
     *
     * @param  array|null $params
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return array
     */
    private function extractPathAndUpdateParams($params)
    {
        $url = parse_url($this->url);

        if ($url === false) {
            $url = [];
        }

        $this->checkPath($url);

        if (isset($url['query'])) {
            // If the URL contains a query param, parse it out into $params so they
            // don't interact weirdly with each other.
            $query  = [];
            parse_str($url['query'], $query);

            $params = array_merge($params ?: [], $query);

Consider using a different name than the parameter $params. This often makes code more readable.

        }

        return [$url['path'], $params];
    }
}