give / vendor / stripe / stripe-php / lib / ApiOperations / NestedResource.php

NestedResource.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.1, at vendor/stripe/stripe-php/lib/ApiOperations/NestedResource.php

136 lines 3.9 KB

Raw Download Zip

1	<?php
2
3	namespace Stripe\ApiOperations;
4
5	/**
6	* Trait for resources that have nested resources.
7	*
8	* This trait should only be applied to classes that derive from StripeObject.
9	*/
10	trait NestedResource
11	{
12	/**
13	* @param string $method
14	* @param string $url
15	* @param null\|array $params
16	* @param null\|array\|string $options
17	*
18	* @return \Stripe\StripeObject
19	*/
20	protected static function _nestedResourceOperation($method, $url, $params = null, $options = null)
21	{
22	self::_validateParams($params);
23
24	list($response, $opts) = static::_staticRequest($method, $url, $params, $options);
25	$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
26	$obj->setLastResponse($response);
27
28	return $obj;
29	}
30
31	/**
32	* @param string $id
33	* @param string $nestedPath
34	* @param null\|string $nestedId
35	*
36	* @return string
37	*/
38	protected static function _nestedResourceUrl($id, $nestedPath, $nestedId = null)
39	{
40	$url = static::resourceUrl($id) . $nestedPath;
41	if (null !== $nestedId) {
42	$url .= "/{$nestedId}";
43	}
44
45	return $url;
46	}
47
48	/**
49	* @param string $id
50	* @param string $nestedPath
51	* @param null\|array $params
52	* @param null\|array\|string $options
53	*
54	* @throws \Stripe\Exception\ApiErrorException if the request fails
55	*
56	* @return \Stripe\StripeObject
57	*/
58	protected static function _createNestedResource($id, $nestedPath, $params = null, $options = null)
59	{
60	$url = static::_nestedResourceUrl($id, $nestedPath);
61
62	return self::_nestedResourceOperation('post', $url, $params, $options);
63	}
64
65	/**
66	* @param string $id
67	* @param string $nestedPath
68	* @param null\|string $nestedId
69	* @param null\|array $params
70	* @param null\|array\|string $options
71	*
72	* @throws \Stripe\Exception\ApiErrorException if the request fails
73	*
74	* @return \Stripe\StripeObject
75	*/
76	protected static function _retrieveNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
77	{
78	$url = static::_nestedResourceUrl($id, $nestedPath, $nestedId);
79
80	return self::_nestedResourceOperation('get', $url, $params, $options);
81	}
82
83	/**
84	* @param string $id
85	* @param string $nestedPath
86	* @param null\|string $nestedId
87	* @param null\|array $params
88	* @param null\|array\|string $options
89	*
90	* @throws \Stripe\Exception\ApiErrorException if the request fails
91	*
92	* @return \Stripe\StripeObject
93	*/
94	protected static function _updateNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
95	{
96	$url = static::_nestedResourceUrl($id, $nestedPath, $nestedId);
97
98	return self::_nestedResourceOperation('post', $url, $params, $options);
99	}
100
101	/**
102	* @param string $id
103	* @param string $nestedPath
104	* @param null\|string $nestedId
105	* @param null\|array $params
106	* @param null\|array\|string $options
107	*
108	* @throws \Stripe\Exception\ApiErrorException if the request fails
109	*
110	* @return \Stripe\StripeObject
111	*/
112	protected static function _deleteNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
113	{
114	$url = static::_nestedResourceUrl($id, $nestedPath, $nestedId);
115
116	return self::_nestedResourceOperation('delete', $url, $params, $options);
117	}
118
119	/**
120	* @param string $id
121	* @param string $nestedPath
122	* @param null\|array $params
123	* @param null\|array\|string $options
124	*
125	* @throws \Stripe\Exception\ApiErrorException if the request fails
126	*
127	* @return \Stripe\StripeObject
128	*/
129	protected static function _allNestedResources($id, $nestedPath, $params = null, $options = null)
130	{
131	$url = static::_nestedResourceUrl($id, $nestedPath);
132
133	return self::_nestedResourceOperation('get', $url, $params, $options);
134	}
135	}
136