Simplify_TransactionReview

Copyright (c) 2013 - 2015 MasterCard International Incorporated All rights reserved.

Defined (1)

The class is defined in the following location(s).

/includes/gateways/simplify-commerce/includes/Simplify/TransactionReview.php  
  1. class Simplify_TransactionReview extends Simplify_Object { 
  2. /** 
  3. * Creates an Simplify_TransactionReview object 
  4. * @param array $hash a map of parameters; valid keys are:<dl style="padding-left:10px;"></dl> 
  5. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/> 
  6. * @return TransactionReview a TransactionReview object. 
  7. */ 
  8. static public function createTransactionReview($hash, $authentication = null) { 
  9.  
  10. $args = func_get_args(); 
  11. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  12.  
  13. $instance = new Simplify_TransactionReview(); 
  14. $instance->setAll($hash); 
  15.  
  16. $object = Simplify_PaymentsApi::createObject($instance, $authentication); 
  17. return $object; 
  18.  
  19.  
  20.  
  21.  
  22. /** 
  23. * Deletes an Simplify_TransactionReview object. 
  24. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i> 
  25. */ 
  26. public function deleteTransactionReview($authentication = null) { 
  27.  
  28. $args = func_get_args(); 
  29. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1); 
  30.  
  31. $obj = Simplify_PaymentsApi::deleteObject($this, $authentication); 
  32. $this->properties = null; 
  33. return true; 
  34.  
  35.  
  36. /** 
  37. * Retrieve Simplify_TransactionReview objects. 
  38. * @param array criteria a map of parameters; valid keys are:<dl style="padding-left:10px;"> 
  39. * <dt><tt>filter</tt></dt> <dd>Allows for ascending or descending sorting of the list. </dd> 
  40. * <dt><tt>max</tt></dt> <dd>Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] </dd> 
  41. * <dt><tt>offset</tt></dt> <dd>Filters to apply to the list. [min value: 0, default: 0] </dd> 
  42. * <dt><tt>sorting</tt></dt> <dd>Used in paging of the list. This is the start offset of the page. The value maps properties to the sort direction (either <tt>asc</tt> for ascending or <tt>desc</tt> for descending). Sortable properties are: <tt> dateCreated</tt><tt> status</tt>.</dd></dl> 
  43. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i> 
  44. * @return ResourceList a ResourceList object that holds the list of TransactionReview objects and the total 
  45. * number of TransactionReview objects available for the given criteria. 
  46. * @see ResourceList 
  47. */ 
  48. static public function listTransactionReview($criteria = null, $authentication = null) { 
  49.  
  50. $args = func_get_args(); 
  51. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  52.  
  53. $val = new Simplify_TransactionReview(); 
  54. $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication); 
  55.  
  56. return $list; 
  57.  
  58.  
  59. /** 
  60. * Retrieve a Simplify_TransactionReview object from the API 
  61. * @param string id the id of the TransactionReview object to retrieve 
  62. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i> 
  63. * @return TransactionReview a TransactionReview object 
  64. */ 
  65. static public function findTransactionReview($id, $authentication = null) { 
  66.  
  67. $args = func_get_args(); 
  68. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  69.  
  70. $val = new Simplify_TransactionReview(); 
  71. $val->id = $id; 
  72.  
  73. $obj = Simplify_PaymentsApi::findObject($val, $authentication); 
  74.  
  75. return $obj; 
  76.  
  77.  
  78. /** 
  79. * Updates an Simplify_TransactionReview object. 
  80. * The properties that can be updated: 
  81. * <dl style="padding-left:10px;"> 
  82. * <dt><tt>status</tt></dt> <dd>Status of the transaction review. </dd></dl> 
  83. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i> 
  84. * @return TransactionReview a TransactionReview object. 
  85. */ 
  86. public function updateTransactionReview($authentication = null) { 
  87.  
  88. $args = func_get_args(); 
  89. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1); 
  90.  
  91. $object = Simplify_PaymentsApi::updateObject($this, $authentication); 
  92. return $object; 
  93.  
  94. /** 
  95. * @ignore 
  96. */ 
  97. public function getClazz() { 
  98. return "TransactionReview";