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

   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 array|null $params
  16      * @param array|string|null $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         return $obj;
  28     }
  29
  30     /**
  31      * @param string $id
  32      * @param string $nestedPath
  33      * @param string|null $nestedId
  34      *
  35      * @return string
  36      */
  37     protected static function _nestedResourceUrl($id, $nestedPath, $nestedId = null)
  38     {
  39         $url = static::resourceUrl($id) . $nestedPath;
  40         if ($nestedId !== null) {
  41             $url .= "/$nestedId";
  42         }
  43         return $url;
  44     }
  45
  46     /**
  47      * @param string $id
  48      * @param string $nestedPath
  49      * @param array|null $params
  50      * @param array|string|null $options
  51      *
  52      * @return \Stripe\StripeObject
  53      */
  54     protected static function _createNestedResource($id, $nestedPath, $params = null, $options = null)
  55     {
  56         $url = static::_nestedResourceUrl($id, $nestedPath);
  57         return self::_nestedResourceOperation('post', $url, $params, $options);
  58     }
  59
  60     /**
  61      * @param string $id
  62      * @param string $nestedPath
  63      * @param array|null $params
  64      * @param array|string|null $options
  65      *
  66      * @return \Stripe\StripeObject
  67      */
  68     protected static function _retrieveNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
  69     {
  70         $url = static::_nestedResourceUrl($id, $nestedPath, $nestedId);
  71         return self::_nestedResourceOperation('get', $url, $params, $options);
  72     }
  73
  74     /**
  75      * @param string $id
  76      * @param string $nestedPath
  77      * @param array|null $params
  78      * @param array|string|null $options
  79      *
  80      * @return \Stripe\StripeObject
  81      */
  82     protected static function _updateNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
  83     {
  84         $url = static::_nestedResourceUrl($id, $nestedPath, $nestedId);
  85         return self::_nestedResourceOperation('post', $url, $params, $options);
  86     }
  87
  88     /**
  89      * @param string $id
  90      * @param string $nestedPath
  91      * @param array|null $params
  92      * @param array|string|null $options
  93      *
  94      * @return \Stripe\StripeObject
  95      */
  96     protected static function _deleteNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
  97     {
  98         $url = static::_nestedResourceUrl($id, $nestedPath, $nestedId);
  99         return self::_nestedResourceOperation('delete', $url, $params, $options);
 100     }
 101
 102     /**
 103      * @param string $id
 104      * @param string $nestedPath
 105      * @param array|null $params
 106      * @param array|string|null $options
 107      *
 108      * @return \Stripe\StripeObject
 109      */
 110     protected static function _allNestedResources($id, $nestedPath, $params = null, $options = null)
 111     {
 112         $url = static::_nestedResourceUrl($id, $nestedPath);
 113         return self::_nestedResourceOperation('get', $url, $params, $options);
 114     }
 115 }