PHP Class Braintree\TransactionGateway

== More information == For more detailed information on Transactions, see {@link http://www.braintreepayments.com/gateway/transaction-api http://www.braintreepaymentsolutions.com/gateway/transaction-api}

Datei anzeigen Open project: braintree/braintree_php Class Usage Examples

Public Methods

Method	Description
__construct ( $gateway )
_doCreate ( var $subPath, array $params ) : mixed	sends the create request to the gateway
cancelRelease ( $transactionId )
cloneSignature ( )
cloneTransaction ( $transactionId, $attribs )
createFromTransparentRedirect ( $queryString ) : object
createSignature ( ) : array	creates a full array signature of a valid gateway request
createTransactionUrl ( ) : string
credit ( array $attribs ) : Braintree\Result\Successful \| Error
creditNoValidate ( array $attribs ) : Braintree\Result\Successful \| Error
fetch ( $query, $ids )
find ( $id ) : Transaction
holdInEscrow ( $transactionId )
refund ( $transactionId, $amount_or_options = null )
refundSignature ( )
releaseFromEscrow ( $transactionId )
sale ( array $attribs ) : array	new sale
saleNoValidate ( array $attribs ) : array	roughly equivalent to the ruby bang method
search ( mixed $query ) : ResourceCollection	Returns a ResourceCollection of transactions matching the search query.
submitForPartialSettlement ( $transactionId, $amount, $attribs = [] )
submitForSettlement ( $transactionId, $amount = null, $attribs = [] )
submitForSettlementNoValidate ( $transactionId, $amount = null, $attribs = [] )
submitForSettlementSignature ( )
updateDetails ( $transactionId, $attribs = [] )
updateDetailsSignature ( )
void ( $transactionId ) : Braintree\Result\Successful \| Error	void a transaction by id
voidNoValidate ( $transactionId )

Private Methods

Method	Description
_validateId ( $id = null )	verifies that a valid transaction id is being used
_verifyGatewayResponse ( array $response ) : Braintree\Result\Successful \| Error	generic method for validating incoming gateway responses
create ( array $attribs ) : object
createNoValidate ( array $attribs ) : object

Method Details

__construct() public method

public __construct ( $gateway )

_doCreate() public method

sends the create request to the gateway

public _doCreate ( var $subPath, array $params ) : mixed
$subPath	var
$params	array
return	mixed

cancelRelease() public method

public cancelRelease ( $transactionId )

cloneSignature() public static method

public static cloneSignature ( )

cloneTransaction() public method

public cloneTransaction ( $transactionId, $attribs )

createFromTransparentRedirect() public method

Deprecation: since version 2.3.0

public createFromTransparentRedirect ( $queryString ) : object
return	object

createSignature() public static method

creates a full array signature of a valid gateway request

public static createSignature ( ) : array
return	array	gateway request signature format

createTransactionUrl() public method

Deprecation: since version 2.3.0

public createTransactionUrl ( ) : string
return	string

credit() public method

public credit ( array $attribs ) : Braintree\Result\Successful \| Error
$attribs	array
return	Braintree\Result\Successful \| Braintree\Result\Error

creditNoValidate() public method

public creditNoValidate ( array $attribs ) : Braintree\Result\Successful \| Error
$attribs	array
return	Braintree\Result\Successful \| Braintree\Result\Error

fetch() public method

public fetch ( $query, $ids )

find() public method

public find ( $id ) : Transaction
return	Transaction

holdInEscrow() public method

public holdInEscrow ( $transactionId )

refund() public method

public refund ( $transactionId, $amount_or_options = null )

refundSignature() public static method

public static refundSignature ( )

releaseFromEscrow() public method

public releaseFromEscrow ( $transactionId )

sale() public method

new sale

public sale ( array $attribs ) : array
$attribs	array
return	array

saleNoValidate() public method

roughly equivalent to the ruby bang method

public saleNoValidate ( array $attribs ) : array
$attribs	array
return	array

search() public method

If query is a string, the search will be a basic search. If query is a hash, the search will be an advanced search. For more detailed information and examples, see {@link http://www.braintreepayments.com/gateway/transaction-api#searching http://www.braintreepaymentsolutions.com/gateway/transaction-api}

public search ( mixed $query ) : ResourceCollection
$query	mixed	search query
return	ResourceCollection

submitForPartialSettlement() public method

public submitForPartialSettlement ( $transactionId, $amount, $attribs = [] )

submitForSettlement() public method

public submitForSettlement ( $transactionId, $amount = null, $attribs = [] )

submitForSettlementNoValidate() public method

public submitForSettlementNoValidate ( $transactionId, $amount = null, $attribs = [] )

submitForSettlementSignature() public static method

public static submitForSettlementSignature ( )

updateDetails() public method

public updateDetails ( $transactionId, $attribs = [] )

updateDetailsSignature() public static method

public static updateDetailsSignature ( )

void() public method

void a transaction by id

public void ( $transactionId ) : Braintree\Result\Successful \| Error
return	Braintree\Result\Successful \| Braintree\Result\Error

voidNoValidate() public method

public voidNoValidate ( $transactionId )