NestedResource.php 3.4 KB

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