<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Vendor\Stripe;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Search results for an API resource.

[5] Fix | Delete

*

[6] Fix | Delete

* This behaves similarly to <code>Collection</code> in that they both wrap

[7] Fix | Delete

* around a list of objects and provide pagination. However the

[8] Fix | Delete

* <code>SearchResult</code> object paginates by relying on a

[9] Fix | Delete

* <code>next_page</code> token included in the response rather than using

[10] Fix | Delete

* object IDs and a <code>starting_before</code>/<code>ending_after</code>

[11] Fix | Delete

* parameter. Thus, <code>SearchResult</code> only supports forwards pagination.

[12] Fix | Delete

*

[13] Fix | Delete

* The {@see $total_count} property is only available when

[14] Fix | Delete

* the `expand` parameter contains `total_count`.

[15] Fix | Delete

*

[16] Fix | Delete

* @template TStripeObject of StripeObject

[17] Fix | Delete

* @template-implements \IteratorAggregate<TStripeObject>

[18] Fix | Delete

*

[19] Fix | Delete

* @property string $object

[20] Fix | Delete

* @property string $url

[21] Fix | Delete

* @property string $next_page

[22] Fix | Delete

* @property int $total_count

[23] Fix | Delete

* @property bool $has_more

[24] Fix | Delete

* @property TStripeObject[] $data

[25] Fix | Delete

*/

[26] Fix | Delete

class SearchResult extends StripeObject implements \Countable, \IteratorAggregate

[27] Fix | Delete

{

[28] Fix | Delete

const OBJECT_NAME = 'search_result';

[29] Fix | Delete

use ApiOperations\Request;

[30] Fix | Delete

/** @var array */

[31] Fix | Delete

protected $filters = [];

[32] Fix | Delete

/**

[33] Fix | Delete

* @return string the base URL for the given class

[34] Fix | Delete

*/

[35] Fix | Delete

public static function baseUrl()

[36] Fix | Delete

{

[37] Fix | Delete

return Stripe::$apiBase;

[38] Fix | Delete

}

[39] Fix | Delete

/**

[40] Fix | Delete

* Returns the filters.

[41] Fix | Delete

*

[42] Fix | Delete

* @return array the filters

[43] Fix | Delete

*/

[44] Fix | Delete

public function getFilters()

[45] Fix | Delete

{

[46] Fix | Delete

return $this->filters;

[47] Fix | Delete

}

[48] Fix | Delete

/**

[49] Fix | Delete

* Sets the filters, removing paging options.

[50] Fix | Delete

*

[51] Fix | Delete

* @param array $filters the filters

[52] Fix | Delete

*/

[53] Fix | Delete

public function setFilters($filters)

[54] Fix | Delete

{

[55] Fix | Delete

$this->filters = $filters;

[56] Fix | Delete

}

[57] Fix | Delete

/**

[58] Fix | Delete

* @return mixed

[59] Fix | Delete

*/

[60] Fix | Delete

#[\ReturnTypeWillChange]

[61] Fix | Delete

public function offsetGet($k)

[62] Fix | Delete

{

[63] Fix | Delete

if (\is_string($k)) {

[64] Fix | Delete

return parent::offsetGet($k);

[65] Fix | Delete

}

[66] Fix | Delete

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

[67] Fix | Delete

throw new Exception\InvalidArgumentException($msg);

[68] Fix | Delete

}

[69] Fix | Delete

/**

[70] Fix | Delete

* @param null|array $params

[71] Fix | Delete

* @param null|array|string $opts

[72] Fix | Delete

*

[73] Fix | Delete

* @throws Exception\ApiErrorException

[74] Fix | Delete

*

[75] Fix | Delete

* @return SearchResult<TStripeObject>

[76] Fix | Delete

*/

[77] Fix | Delete

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

[78] Fix | Delete

{

[79] Fix | Delete

self::_validateParams($params);

[80] Fix | Delete

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

[81] Fix | Delete

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

[82] Fix | Delete

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

[83] Fix | Delete

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

[84] Fix | Delete

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

[85] Fix | Delete

}

[86] Fix | Delete

$obj->setFilters($params);

[87] Fix | Delete

return $obj;

[88] Fix | Delete

}

[89] Fix | Delete

/**

[90] Fix | Delete

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

[91] Fix | Delete

*/

[92] Fix | Delete

#[\ReturnTypeWillChange]

[93] Fix | Delete

public function count()

[94] Fix | Delete

{

[95] Fix | Delete

return \count($this->data);

[96] Fix | Delete

}

[97] Fix | Delete

/**

[98] Fix | Delete

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

[99] Fix | Delete

* across objects in the current page

[100] Fix | Delete

*/

[101] Fix | Delete

#[\ReturnTypeWillChange]

[102] Fix | Delete

public function getIterator()

[103] Fix | Delete

{

[104] Fix | Delete

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

[105] Fix | Delete

}

[106] Fix | Delete

/**

[107] Fix | Delete

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

[108] Fix | Delete

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

[109] Fix | Delete

* encountered, the next page will be fetched automatically for

[110] Fix | Delete

* continued iteration.

[111] Fix | Delete

*/

[112] Fix | Delete

public function autoPagingIterator()

[113] Fix | Delete

{

[114] Fix | Delete

$page = $this;

[115] Fix | Delete

while (\true) {

[116] Fix | Delete

foreach ($page as $item) {

[117] Fix | Delete

(yield $item);

[118] Fix | Delete

}

[119] Fix | Delete

$page = $page->nextPage();

[120] Fix | Delete

if ($page->isEmpty()) {

[121] Fix | Delete

break;

[122] Fix | Delete

}

[123] Fix | Delete

}

[124] Fix | Delete

}

[125] Fix | Delete

/**

[126] Fix | Delete

* Returns an empty set of search results. This is returned from

[127] Fix | Delete

* {@see nextPage()} when we know that there isn't a next page in order to

[128] Fix | Delete

* replicate the behavior of the API when it attempts to return a page

[129] Fix | Delete

* beyond the last.

[130] Fix | Delete

*

[131] Fix | Delete

* @param null|array|string $opts

[132] Fix | Delete

*

[133] Fix | Delete

* @return SearchResult

[134] Fix | Delete

*/

[135] Fix | Delete

public static function emptySearchResult($opts = null)

[136] Fix | Delete

{

[137] Fix | Delete

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

[138] Fix | Delete

}

[139] Fix | Delete

/**

[140] Fix | Delete

* Returns true if the page object contains no element.

[141] Fix | Delete

*

[142] Fix | Delete

* @return bool

[143] Fix | Delete

*/

[144] Fix | Delete

public function isEmpty()

[145] Fix | Delete

{

[146] Fix | Delete

return empty($this->data);

[147] Fix | Delete

}

[148] Fix | Delete

/**

[149] Fix | Delete

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

[150] Fix | Delete

*

[151] Fix | Delete

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

[152] Fix | Delete

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

[153] Fix | Delete

*

[154] Fix | Delete

* @param null|array $params

[155] Fix | Delete

* @param null|array|string $opts

[156] Fix | Delete

*

[157] Fix | Delete

* @return SearchResult<TStripeObject>

[158] Fix | Delete

*/

[159] Fix | Delete

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

[160] Fix | Delete

{

[161] Fix | Delete

if (!$this->has_more) {

[162] Fix | Delete

return static::emptySearchResult($opts);

[163] Fix | Delete

}

[164] Fix | Delete

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

[165] Fix | Delete

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

[166] Fix | Delete

}

[167] Fix | Delete

/**

[168] Fix | Delete

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

[169] Fix | Delete

*

[170] Fix | Delete

* @return null|TStripeObject

[171] Fix | Delete

*/

[172] Fix | Delete

public function first()

[173] Fix | Delete

{

[174] Fix | Delete

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

[175] Fix | Delete

}

[176] Fix | Delete

/**

[177] Fix | Delete

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

[178] Fix | Delete

*

[179] Fix | Delete

* @return null|TStripeObject

[180] Fix | Delete

*/

[181] Fix | Delete

public function last()

[182] Fix | Delete

{

[183] Fix | Delete

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

[184] Fix | Delete

}

[185] Fix | Delete

private function extractPathAndUpdateParams($params)

[186] Fix | Delete

{

[187] Fix | Delete

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

[188] Fix | Delete

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

[189] Fix | Delete

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

[190] Fix | Delete

}

[191] Fix | Delete

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

[192] Fix | Delete

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

[193] Fix | Delete

// don't interact weirdly with each other.

[194] Fix | Delete

$query = [];

[195] Fix | Delete

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

[196] Fix | Delete

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

[197] Fix | Delete

}

[198] Fix | Delete

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

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete