class Braintree_Result_Error in Commerce Braintree 7

Braintree Error Result

An Error Result will be returned from gateway methods when the gateway responds with an error. It will provide access to the original request. For example, when voiding a transaction, Error Result will respond to the void request if it failed:

<code> $result = Braintree_Transaction::void('abc123'); if ($result->success) { // Successful Result } else { // Braintree_Result_Error } </code>

@package Braintree @subpackage Result @copyright 2010 Braintree Payment Solutions

@property-read array $params original passed params @property-read object $errors Braintree_Error_ErrorCollection @property-read object $creditCardVerification credit card verification data

Hierarchy

• class \Braintree
  • class \Braintree_Result_Error

File

braintree_php/lib/Braintree/Result/Error.php, line 36

class Braintree_Result_Error extends Braintree {

  /**
   *
   * @var boolean always false
   */
  public $success = false;

  /**
   * return original value for a field
   * For example, if a user tried to submit 'invalid-email' in the html field transaction[customer][email],
   * $result->valueForHtmlField("transaction[customer][email]") would yield "invalid-email"
   *
   * @param string $field
   * @return string
   */
  public function valueForHtmlField($field) {
    $pieces = preg_split("/[\\[\\]]+/", $field, 0, PREG_SPLIT_NO_EMPTY);
    $params = $this->params;
    foreach (array_slice($pieces, 0, -1) as $key) {
      $params = $params[Braintree_Util::delimiterToCamelCase($key)];
    }
    $finalKey = Braintree_Util::delimiterToCamelCase(end($pieces));
    $fieldValue = isset($params[$finalKey]) ? $params[$finalKey] : null;
    return $fieldValue;
  }

  /**
   * overrides default constructor
   * @ignore
   * @param array $response gateway response array
   */
  public function __construct($response) {
    $this->_attributes = $response;
    $this
      ->_set('errors', new Braintree_Error_ErrorCollection($response['errors']));
    if (isset($response['verification'])) {
      $this
        ->_set('creditCardVerification', new Braintree_Result_CreditCardVerification($response['verification']));
    }
    else {
      $this
        ->_set('creditCardVerification', null);
    }
    if (isset($response['transaction'])) {
      $this
        ->_set('transaction', Braintree_Transaction::factory($response['transaction']));
    }
    else {
      $this
        ->_set('transaction', null);
    }
    if (isset($response['subscription'])) {
      $this
        ->_set('subscription', Braintree_Subscription::factory($response['subscription']));
    }
    else {
      $this
        ->_set('subscription', null);
    }
  }

  /**
   * create a printable representation of the object as:
   * ClassName[property=value, property=value]
   * @ignore
   * @return var
   */
  public function __toString() {
    $output = Braintree_Util::attributesToString($this->_attributes);
    if (isset($this->_creditCardVerification)) {
      $output .= sprintf('%s', $this->_creditCardVerification);
    }
    return __CLASS__ . '[' . $output . ']';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Braintree::returnObjectOrThrowException	public static	function
Braintree::_set	public	function
Braintree::__clone	protected	function	@ignore don't permit cloning the instances (like $x = clone $v)
Braintree::__get	public	function	returns private/nonexistent instance properties @ignore @access public
Braintree::__isset	public	function	used by isset() and empty() @access public
Braintree_Result_Error::$success	public	property
Braintree_Result_Error::valueForHtmlField	public	function	return original value for a field For example, if a user tried to submit 'invalid-email' in the html field transaction[customer][email], $result->valueForHtmlField("transaction[customer][email]") would yield…
Braintree_Result_Error::__construct	public	function	overrides default constructor @ignore Overrides Braintree::__construct
Braintree_Result_Error::__toString	public	function	create a printable representation of the object as: ClassName[property=value, property=value] @ignore