<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Vendor\Stripe;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Class Collection.

[5] Fix | Delete

*

[6] Fix | Delete

* @template TStripeObject of StripeObject

[7] Fix | Delete

* @template-implements \IteratorAggregate<TStripeObject>

[8] Fix | Delete

*

[9] Fix | Delete

* @property string $object

[10] Fix | Delete

* @property string $url

[11] Fix | Delete

* @property bool $has_more

[12] Fix | Delete

* @property TStripeObject[] $data

[13] Fix | Delete

*/

[14] Fix | Delete

class Collection extends StripeObject implements \Countable, \IteratorAggregate

[15] Fix | Delete

{

[16] Fix | Delete

const OBJECT_NAME = 'list';

[17] Fix | Delete

use ApiOperations\Request;

[18] Fix | Delete

/** @var array */

[19] Fix | Delete

protected $filters = [];

[20] Fix | Delete

/**

[21] Fix | Delete

* @return string the base URL for the given class

[22] Fix | Delete

*/

[23] Fix | Delete

public static function baseUrl()

[24] Fix | Delete

{

[25] Fix | Delete

return Stripe::$apiBase;

[26] Fix | Delete

}

[27] Fix | Delete

/**

[28] Fix | Delete

* Returns the filters.

[29] Fix | Delete

*

[30] Fix | Delete

* @return array the filters

[31] Fix | Delete

*/

[32] Fix | Delete

public function getFilters()

[33] Fix | Delete

{

[34] Fix | Delete

return $this->filters;

[35] Fix | Delete

}

[36] Fix | Delete

/**

[37] Fix | Delete

* Sets the filters, removing paging options.

[38] Fix | Delete

*

[39] Fix | Delete

* @param array $filters the filters

[40] Fix | Delete

*/

[41] Fix | Delete

public function setFilters($filters)

[42] Fix | Delete

{

[43] Fix | Delete

$this->filters = $filters;

[44] Fix | Delete

}

[45] Fix | Delete

/**

[46] Fix | Delete

* @return mixed

[47] Fix | Delete

*/

[48] Fix | Delete

#[\ReturnTypeWillChange]

[49] Fix | Delete

public function offsetGet($k)

[50] Fix | Delete

{

[51] Fix | Delete

if (\is_string($k)) {

[52] Fix | Delete

return parent::offsetGet($k);

[53] Fix | Delete

}

[54] Fix | Delete

$msg = "You tried to access the {$k} index, but Collection " . 'types only support string keys. (HINT: List calls ' . 'return an object with a `data` (which is the data ' . "array). You likely want to call ->data[{$k}])";

[55] Fix | Delete

throw new Exception\InvalidArgumentException($msg);

[56] Fix | Delete

}

[57] Fix | Delete

/**

[58] Fix | Delete

* @param null|array $params

[59] Fix | Delete

* @param null|array|string $opts

[60] Fix | Delete

*

[61] Fix | Delete

* @throws Exception\ApiErrorException

[62] Fix | Delete

*

[63] Fix | Delete

* @return Collection<TStripeObject>

[64] Fix | Delete

*/

[65] Fix | Delete

public function all($params = null, $opts = null)

[66] Fix | Delete

{

[67] Fix | Delete

self::_validateParams($params);

[68] Fix | Delete

list($url, $params) = $this->extractPathAndUpdateParams($params);

[69] Fix | Delete

list($response, $opts) = $this->_request('get', $url, $params, $opts);

[70] Fix | Delete

$obj = Util\Util::convertToStripeObject($response, $opts);

[71] Fix | Delete

if (!$obj instanceof \WPForms\Vendor\Stripe\Collection) {

[72] Fix | Delete

throw new \WPForms\Vendor\Stripe\Exception\UnexpectedValueException('Expected type ' . \WPForms\Vendor\Stripe\Collection::class . ', got "' . \get_class($obj) . '" instead.');

[73] Fix | Delete

}

[74] Fix | Delete

$obj->setFilters($params);

[75] Fix | Delete

return $obj;

[76] Fix | Delete

}

[77] Fix | Delete

/**

[78] Fix | Delete

* @param null|array $params

[79] Fix | Delete

* @param null|array|string $opts

[80] Fix | Delete

*

[81] Fix | Delete

* @throws Exception\ApiErrorException

[82] Fix | Delete

*

[83] Fix | Delete

* @return TStripeObject

[84] Fix | Delete

*/

[85] Fix | Delete

public function create($params = null, $opts = null)

[86] Fix | Delete

{

[87] Fix | Delete

self::_validateParams($params);

[88] Fix | Delete

list($url, $params) = $this->extractPathAndUpdateParams($params);

[89] Fix | Delete

list($response, $opts) = $this->_request('post', $url, $params, $opts);

[90] Fix | Delete

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

[91] Fix | Delete

}

[92] Fix | Delete

/**

[93] Fix | Delete

* @param string $id

[94] Fix | Delete

* @param null|array $params

[95] Fix | Delete

* @param null|array|string $opts

[96] Fix | Delete

*

[97] Fix | Delete

* @throws Exception\ApiErrorException

[98] Fix | Delete

*

[99] Fix | Delete

* @return TStripeObject

[100] Fix | Delete

*/

[101] Fix | Delete

public function retrieve($id, $params = null, $opts = null)

[102] Fix | Delete

{

[103] Fix | Delete

self::_validateParams($params);

[104] Fix | Delete

list($url, $params) = $this->extractPathAndUpdateParams($params);

[105] Fix | Delete

$id = Util\Util::utf8($id);

[106] Fix | Delete

$extn = \urlencode($id);

[107] Fix | Delete

list($response, $opts) = $this->_request('get', "{$url}/{$extn}", $params, $opts);

[108] Fix | Delete

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

[109] Fix | Delete

}

[110] Fix | Delete

/**

[111] Fix | Delete

* @return int the number of objects in the current page

[112] Fix | Delete

*/

[113] Fix | Delete

#[\ReturnTypeWillChange]

[114] Fix | Delete

public function count()

[115] Fix | Delete

{

[116] Fix | Delete

return \count($this->data);

[117] Fix | Delete

}

[118] Fix | Delete

/**

[119] Fix | Delete

* @return \ArrayIterator an iterator that can be used to iterate

[120] Fix | Delete

* across objects in the current page

[121] Fix | Delete

*/

[122] Fix | Delete

#[\ReturnTypeWillChange]

[123] Fix | Delete

public function getIterator()

[124] Fix | Delete

{

[125] Fix | Delete

return new \ArrayIterator($this->data);

[126] Fix | Delete

}

[127] Fix | Delete

/**

[128] Fix | Delete

* @return \ArrayIterator an iterator that can be used to iterate

[129] Fix | Delete

* backwards across objects in the current page

[130] Fix | Delete

*/

[131] Fix | Delete

public function getReverseIterator()

[132] Fix | Delete

{

[133] Fix | Delete

return new \ArrayIterator(\array_reverse($this->data));

[134] Fix | Delete

}

[135] Fix | Delete

/**

[136] Fix | Delete

* @return \Generator|TStripeObject[] A generator that can be used to

[137] Fix | Delete

* iterate across all objects across all pages. As page boundaries are

[138] Fix | Delete

* encountered, the next page will be fetched automatically for

[139] Fix | Delete

* continued iteration.

[140] Fix | Delete

*/

[141] Fix | Delete

public function autoPagingIterator()

[142] Fix | Delete

{

[143] Fix | Delete

$page = $this;

[144] Fix | Delete

while (\true) {

[145] Fix | Delete

$filters = $this->filters ?: [];

[146] Fix | Delete

if (\array_key_exists('ending_before', $filters) && !\array_key_exists('starting_after', $filters)) {

[147] Fix | Delete

foreach ($page->getReverseIterator() as $item) {

[148] Fix | Delete

(yield $item);

[149] Fix | Delete

}

[150] Fix | Delete

$page = $page->previousPage();

[151] Fix | Delete

} else {

[152] Fix | Delete

foreach ($page as $item) {

[153] Fix | Delete

(yield $item);

[154] Fix | Delete

}

[155] Fix | Delete

$page = $page->nextPage();

[156] Fix | Delete

}

[157] Fix | Delete

if ($page->isEmpty()) {

[158] Fix | Delete

break;

[159] Fix | Delete

}

[160] Fix | Delete

}

[161] Fix | Delete

}

[162] Fix | Delete

/**

[163] Fix | Delete

* Returns an empty collection. This is returned from {@see nextPage()}

[164] Fix | Delete

* when we know that there isn't a next page in order to replicate the

[165] Fix | Delete

* behavior of the API when it attempts to return a page beyond the last.

[166] Fix | Delete

*

[167] Fix | Delete

* @param null|array|string $opts

[168] Fix | Delete

*

[169] Fix | Delete

* @return Collection

[170] Fix | Delete

*/

[171] Fix | Delete

public static function emptyCollection($opts = null)

[172] Fix | Delete

{

[173] Fix | Delete

return Collection::constructFrom(['data' => []], $opts);

[174] Fix | Delete

}

[175] Fix | Delete

/**

[176] Fix | Delete

* Returns true if the page object contains no element.

[177] Fix | Delete

*

[178] Fix | Delete

* @return bool

[179] Fix | Delete

*/

[180] Fix | Delete

public function isEmpty()

[181] Fix | Delete

{

[182] Fix | Delete

return empty($this->data);

[183] Fix | Delete

}

[184] Fix | Delete

/**

[185] Fix | Delete

* Fetches the next page in the resource list (if there is one).

[186] Fix | Delete

*

[187] Fix | Delete

* This method will try to respect the limit of the current page. If none

[188] Fix | Delete

* was given, the default limit will be fetched again.

[189] Fix | Delete

*

[190] Fix | Delete

* @param null|array $params

[191] Fix | Delete

* @param null|array|string $opts

[192] Fix | Delete

*

[193] Fix | Delete

* @return Collection<TStripeObject>

[194] Fix | Delete

*/

[195] Fix | Delete

public function nextPage($params = null, $opts = null)

[196] Fix | Delete

{

[197] Fix | Delete

if (!$this->has_more) {

[198] Fix | Delete

return static::emptyCollection($opts);

[199] Fix | Delete

}

[200] Fix | Delete

$lastId = \end($this->data)->id;

[201] Fix | Delete

$params = \array_merge($this->filters ?: [], ['starting_after' => $lastId], $params ?: []);

[202] Fix | Delete

return $this->all($params, $opts);

[203] Fix | Delete

}

[204] Fix | Delete

/**

[205] Fix | Delete

* Fetches the previous page in the resource list (if there is one).

[206] Fix | Delete

*

[207] Fix | Delete

* This method will try to respect the limit of the current page. If none

[208] Fix | Delete

* was given, the default limit will be fetched again.

[209] Fix | Delete

*

[210] Fix | Delete

* @param null|array $params

[211] Fix | Delete

* @param null|array|string $opts

[212] Fix | Delete

*

[213] Fix | Delete

* @return Collection<TStripeObject>

[214] Fix | Delete

*/

[215] Fix | Delete

public function previousPage($params = null, $opts = null)

[216] Fix | Delete

{

[217] Fix | Delete

if (!$this->has_more) {

[218] Fix | Delete

return static::emptyCollection($opts);

[219] Fix | Delete

}

[220] Fix | Delete

$firstId = $this->data[0]->id;

[221] Fix | Delete

$params = \array_merge($this->filters ?: [], ['ending_before' => $firstId], $params ?: []);

[222] Fix | Delete

return $this->all($params, $opts);

[223] Fix | Delete

}

[224] Fix | Delete

/**

[225] Fix | Delete

* Gets the first item from the current page. Returns `null` if the current page is empty.

[226] Fix | Delete

*

[227] Fix | Delete

* @return null|TStripeObject

[228] Fix | Delete

*/

[229] Fix | Delete

public function first()

[230] Fix | Delete

{

[231] Fix | Delete

return \count($this->data) > 0 ? $this->data[0] : null;

[232] Fix | Delete

}

[233] Fix | Delete

/**

[234] Fix | Delete

* Gets the last item from the current page. Returns `null` if the current page is empty.

[235] Fix | Delete

*

[236] Fix | Delete

* @return null|TStripeObject

[237] Fix | Delete

*/

[238] Fix | Delete

public function last()

[239] Fix | Delete

{

[240] Fix | Delete

return \count($this->data) > 0 ? $this->data[\count($this->data) - 1] : null;

[241] Fix | Delete

}

[242] Fix | Delete

private function extractPathAndUpdateParams($params)

[243] Fix | Delete

{

[244] Fix | Delete

$url = \parse_url($this->url);

[245] Fix | Delete

if (!isset($url['path'])) {

[246] Fix | Delete

throw new Exception\UnexpectedValueException("Could not parse list url into parts: {$url}");

[247] Fix | Delete

}

[248] Fix | Delete

if (isset($url['query'])) {

[249] Fix | Delete

// If the URL contains a query param, parse it out into $params so they

[250] Fix | Delete

// don't interact weirdly with each other.

[251] Fix | Delete

$query = [];

[252] Fix | Delete

\parse_str($url['query'], $query);

[253] Fix | Delete

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

[254] Fix | Delete

}

[255] Fix | Delete

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

[256] Fix | Delete

}

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete