class Mollie_API_Resource_Payments in Commerce Mollie 7

Copyright (c) 2013, Mollie B.V. 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.

@license Berkeley Software Distribution License (BSD-License 2) http://www.opensource.org/licenses/bsd-license.php @author Mollie B.V. <[e-mail]> @copyright Mollie B.V. @link https://www.mollie.nl

@method Mollie_API_Object_Payment[]|Mollie_API_Object_List all($offset = 0, $limit = 0) @method Mollie_API_Object_Payment create(array $data) @method Mollie_API_Object_Payment get($id)

Hierarchy

• class \Mollie_API_Resource_Base
  • class \Mollie_API_Resource_Payments

File

Mollie/API/Resource/Payments.php, line 37

class Mollie_API_Resource_Payments extends Mollie_API_Resource_Base {

  /**
   * @return Mollie_API_Object_Payment
   */
  protected function getResourceObject() {
    return new Mollie_API_Object_Payment();
  }

  /**
   * @param Mollie_API_Object_Payment $payment
   * @return Mollie_API_Object_Payment_Refund
   */
  public function refund(Mollie_API_Object_Payment $payment) {
    $resource = "{$this->getResourceName()}/" . urlencode($payment->id) . "/refunds";
    $result = $this
      ->performApiCall(self::REST_CREATE, $resource, new stdClass());

    /*
     * Update the payment with the new properties that we got from the refund.
     */
    if (!empty($result->payment)) {
      foreach ($result->payment as $payment_key => $payment_value) {
        $payment->{$payment_key} = $payment_value;
      }
    }
    return $this
      ->copy($result, new Mollie_API_Object_Payment_Refund());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Mollie_API_Resource_Base::$api	protected	property
Mollie_API_Resource_Base::all	public	function	Retrieve all objects of a certain resource.
Mollie_API_Resource_Base::copy	protected	function	Copy the results received from the API into the PHP objects that we use.
Mollie_API_Resource_Base::create	public	function	Create a resource with the remote API.
Mollie_API_Resource_Base::DEFAULT_LIMIT		constant	Default number of objects to retrieve when listing all objects.
Mollie_API_Resource_Base::get	public	function	Retrieve information on a single resource from Mollie.
Mollie_API_Resource_Base::getResourceName	protected	function		1
Mollie_API_Resource_Base::performApiCall	protected	function	Perform an API call, and interpret the results and convert them to correct objects.
Mollie_API_Resource_Base::rest_create	private	function
Mollie_API_Resource_Base::REST_CREATE		constant
Mollie_API_Resource_Base::REST_DELETE		constant
Mollie_API_Resource_Base::rest_list	private	function	Get a collection of objects from the REST API.
Mollie_API_Resource_Base::REST_LIST		constant
Mollie_API_Resource_Base::rest_read	private	function	Retrieves a single object from the REST API.
Mollie_API_Resource_Base::REST_READ		constant
Mollie_API_Resource_Base::REST_UPDATE		constant
Mollie_API_Resource_Base::__construct	public	function
Mollie_API_Resource_Payments::getResourceObject	protected	function	Overrides Mollie_API_Resource_Base::getResourceObject
Mollie_API_Resource_Payments::refund	public	function