PHP Class Mollie_API_Resource_Base, mollie-api-php

All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
See link: https://www.mollie.nl
Author: Mollie B.V. ([email protected])
Exibir arquivo Open project: mollie/mollie-api-php Class Usage Examples

Protected Properties

Property Type Description
$api Mollie_API_Client
$parent_id string | null
$resource_path string

Public Methods

Method Description
__construct ( Mollie_API_Client $api )
all ( integer $offset, integer $limit, array $filters = [] ) : Mollie_API_Object_List Retrieve all objects of a certain resource.
create ( array $data = [], array $filters = [] ) : object Create a resource with the remote API.
delete ( string $resource_id ) : object Delete a single resource from Mollie.
get ( string $resource_id, array $filters = [] ) : object Retrieve information on a single resource from Mollie.
getResourcePath ( ) : string
setResourcePath ( string $resource_path )
with ( Mollie_API_Object_Payment | object $parent ) Set the resource to use a certain parent. Use this method before performing a get() or all() call.
withParentId ( string $parent_id )

Protected Methods

Method Description
copy ( object $api_result, object $object ) : object Copy the results received from the API into the PHP objects that we use.
getResourceObject ( ) : object Get the object that is used by this API. Every API uses one type of object.
performApiCall ( $http_method, $api_method, null $http_body = NULL ) : object Perform an API call, and interpret the results and convert them to correct objects.
rest_update ( string $rest_resource, string $id, string $body ) : object Sends a POST request to a single Molle API object to update it.

Private Methods

Method Description
buildQueryString ( array $filters ) : string
rest_create ( string $rest_resource, $body, array $filters ) : object
rest_delete ( string $rest_resource, string $id ) : object Sends a DELETE request to a single Molle API object.
rest_list ( $rest_resource, integer $offset, integer $limit = self::DEFAULT_LIMIT, array $filters ) : Mollie_API_Object_List Get a collection of objects from the REST API.
rest_read ( string $rest_resource, string $id, array $filters ) : object Retrieves a single object from the REST API.

Method Details

__construct() public method

public __construct ( Mollie_API_Client $api )
$api Mollie_API_Client

all() public method

Retrieve all objects of a certain resource.
public all ( integer $offset, integer $limit, array $filters = [] ) : Mollie_API_Object_List
$offset integer
$limit integer
$filters array
return Mollie_API_Object_List

copy() protected method

Copy the results received from the API into the PHP objects that we use.
protected copy ( object $api_result, object $object ) : object
$api_result object
$object object
return object

create() public method

Create a resource with the remote API.
public create ( array $data = [], array $filters = [] ) : object
$data array An array containing details on the resource. Fields supported depend on the resource created.
$filters array
return object

delete() public method

Will throw a Mollie_API_Exception if the resource cannot be found.
public delete ( string $resource_id ) : object
$resource_id string
return object

get() public method

Will throw a Mollie_API_Exception if the resource cannot be found.
public get ( string $resource_id, array $filters = [] ) : object
$resource_id string
$filters array
return object

getResourceObject() abstract protected method

Get the object that is used by this API. Every API uses one type of object.
abstract protected getResourceObject ( ) : object
return object

getResourcePath() public method

public getResourcePath ( ) : string
return string

performApiCall() protected method

Perform an API call, and interpret the results and convert them to correct objects.
protected performApiCall ( $http_method, $api_method, null $http_body = NULL ) : object
$http_method
$api_method
$http_body null
return object

rest_update() protected method

Sends a POST request to a single Molle API object to update it.
protected rest_update ( string $rest_resource, string $id, string $body ) : object
$rest_resource string
$id string
$body string
return object

setResourcePath() public method

public setResourcePath ( string $resource_path )
$resource_path string

with() public method

Set the resource to use a certain parent. Use this method before performing a get() or all() call.
public with ( Mollie_API_Object_Payment | object $parent )
$parent Mollie_API_Object_Payment | object An object with an 'id' property

withParentId() public method

public withParentId ( string $parent_id )
$parent_id string

Property Details

$api protected_oe property

protected Mollie_API_Client $api
return Mollie_API_Client

$parent_id protected_oe property

protected string|null $parent_id
return string | null

$resource_path protected_oe property

protected string $resource_path
return string