PHP Interface Cartalyst\Stripe\Api\ApiInterface

Show file Open project: cartalyst/stripe Interface Usage Examples

Public Methods

Method Description
_delete ( string $url = null, array $parameters = [] ) : array Send a DELETE request.
_get ( string $url = null, array $parameters = [] ) : array Send a GET request.
_head ( string $url = null, array $parameters = [] ) : array Send a HEAD request.
_options ( string $url = null, array $parameters = [] ) : array Send an OPTIONS request.
_patch ( string $url = null, array $parameters = [] ) : array Send a PATCH request.
_post ( string $url = null, array $parameters = [] ) : array Send a POST request.
_put ( string $url = null, array $parameters = [] ) : array Send a PUT request.
baseUrl ( ) : string Returns the API base url.
execute ( string $httpMethod, string $url, array $parameters = [] ) : array Executes the HTTP request.
getPerPage ( ) : void Returns the number of items to return per page.
setPerPage ( integer $perPage ) Sets the number of items to return per page.

Method Details

_delete() public method

Send a DELETE request.
public _delete ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

_get() public method

Send a GET request.
public _get ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

_head() public method

Send a HEAD request.
public _head ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

_options() public method

Send an OPTIONS request.
public _options ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

_patch() public method

Send a PATCH request.
public _patch ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

_post() public method

Send a POST request.
public _post ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

_put() public method

Send a PUT request.
public _put ( string $url = null, array $parameters = [] ) : array
$url string
$parameters array
return array

baseUrl() public method

Returns the API base url.
public baseUrl ( ) : string
return string

execute() public method

Executes the HTTP request.
public execute ( string $httpMethod, string $url, array $parameters = [] ) : array
$httpMethod string
$url string
$parameters array
return array

getPerPage() public method

Returns the number of items to return per page.
public getPerPage ( ) : void
return void

setPerPage() public method

Sets the number of items to return per page.
public setPerPage ( integer $perPage )
$perPage integer