PHP Class Braintree\Configuration

Afficher le fichier Open project: braintree/braintree_php Class Usage Examples

Méthodes publiques

Свойство Type Description
$global

Méthodes publiques

Méthode Description
__construct ( $attribs = [] )
assertGlobalHasAccessTokenOrKeys ( )
assertHasAccessTokenOrKeys ( )
assertHasClientCredentials ( )
assertHasClientId ( )
assertHasClientSecret ( )
authUrl ( )
baseUrl ( ) : string returns the base braintree gateway URL based on config values
caFile ( $sslPath = NULL ) : string sets the physical path for the location of the CA certs
environment ( $value = null )
gateway ( )
getAccessToken ( )
getClientId ( )
getClientSecret ( )
getEnvironment ( )
getMerchantId ( )
getPrivateKey ( )
getProxyHost ( )
getProxyPassword ( )
getProxyPort ( )
getProxyType ( )
getProxyUser ( )
getPublicKey ( )
getTimeout ( )
isAccessToken ( )
isAuthenticatedProxy ( ) : boolean Specified whether or not a username and password have been provided for use with an authenticated proxy
isClientCredentials ( )
isUsingProxy ( ) : boolean Specifies whether or not a proxy is properly configured
logMessage ( string $message ) log message to default logger
merchantId ( $value = null )
merchantPath ( ) : string sets the merchant path based on merchant ID
portNumber ( ) : integer returns the port number depending on environment
privateKey ( $value = null )
protocol ( ) : string returns http protocol depending on environment
proxyHost ( string $value = null ) : string Sets or gets the proxy host to use for connecting to Braintree
proxyPassword ( $value = null )
proxyPort ( string $value = null ) : string Sets or gets the port of the proxy to use for connecting to Braintree
proxyType ( string $value = null ) : string Sets or gets the proxy type to use for connecting to Braintree. This value can be any of the CURLOPT_PROXYTYPE options in PHP cURL.
proxyUser ( $value = null )
publicKey ( $value = null )
reset ( ) resets configuration to default
serverName ( ) : string returns gateway server name depending on environment
setEnvironment ( $value ) Do not use this method directly. Pass in the environment to the constructor.
setMerchantId ( $value ) Do not use this method directly. Pass in the merchantId to the constructor.
setPrivateKey ( $value ) Do not use this method directly. Pass in the privateKey to the constructor.
setPublicKey ( $value ) Do not use this method directly. Pass in the publicKey to the constructor.
sslOn ( ) : boolean returns boolean indicating SSL is on or off for this session, depending on environment
timeout ( integer $value = null ) : integer Sets or gets the read timeout to use for making requests.

Private Methods

Méthode Description
setProxyHost ( $value )
setProxyPassword ( $value )
setProxyPort ( $value )
setProxyType ( $value )
setProxyUser ( $value )
setTimeout ( $value )

Method Details

__construct() public méthode

public __construct ( $attribs = [] )

assertGlobalHasAccessTokenOrKeys() public static méthode

public static assertGlobalHasAccessTokenOrKeys ( )

assertHasAccessTokenOrKeys() public méthode

public assertHasAccessTokenOrKeys ( )

assertHasClientCredentials() public méthode

public assertHasClientCredentials ( )

assertHasClientId() public méthode

public assertHasClientId ( )

assertHasClientSecret() public méthode

public assertHasClientSecret ( )

authUrl() public méthode

public authUrl ( )

baseUrl() public méthode

returns the base braintree gateway URL based on config values
public baseUrl ( ) : string
Résultat string braintree gateway URL

caFile() public méthode

sets the physical path for the location of the CA certs
public caFile ( $sslPath = NULL ) : string
Résultat string filepath

environment() public static méthode

public static environment ( $value = null )

gateway() public static méthode

public static gateway ( )

getAccessToken() public méthode

public getAccessToken ( )

getClientId() public méthode

public getClientId ( )

getClientSecret() public méthode

public getClientSecret ( )

getEnvironment() public méthode

public getEnvironment ( )

getMerchantId() public méthode

public getMerchantId ( )

getPrivateKey() public méthode

public getPrivateKey ( )

getProxyHost() public méthode

public getProxyHost ( )

getProxyPassword() public méthode

public getProxyPassword ( )

getProxyPort() public méthode

public getProxyPort ( )

getProxyType() public méthode

public getProxyType ( )

getProxyUser() public méthode

public getProxyUser ( )

getPublicKey() public méthode

public getPublicKey ( )

getTimeout() public méthode

public getTimeout ( )

isAccessToken() public méthode

public isAccessToken ( )

isAuthenticatedProxy() public static méthode

Specified whether or not a username and password have been provided for use with an authenticated proxy
public static isAuthenticatedProxy ( ) : boolean
Résultat boolean true if both proxyUser and proxyPassword are present

isClientCredentials() public méthode

public isClientCredentials ( )

isUsingProxy() public static méthode

Specifies whether or not a proxy is properly configured
public static isUsingProxy ( ) : boolean
Résultat boolean true if a proxy is configured properly, false if not

logMessage() public méthode

log message to default logger
public logMessage ( string $message )
$message string

merchantId() public static méthode

public static merchantId ( $value = null )

merchantPath() public méthode

sets the merchant path based on merchant ID
public merchantPath ( ) : string
Résultat string merchant path uri

portNumber() public méthode

returns the port number depending on environment
public portNumber ( ) : integer
Résultat integer portnumber

privateKey() public static méthode

public static privateKey ( $value = null )

protocol() public méthode

returns http protocol depending on environment
public protocol ( ) : string
Résultat string http || https

proxyHost() public static méthode

Sets or gets the proxy host to use for connecting to Braintree
public static proxyHost ( string $value = null ) : string
$value string If provided, sets the proxy host
Résultat string The proxy host used for connecting to Braintree

proxyPassword() public static méthode

public static proxyPassword ( $value = null )

proxyPort() public static méthode

Sets or gets the port of the proxy to use for connecting to Braintree
public static proxyPort ( string $value = null ) : string
$value string If provided, sets the port of the proxy
Résultat string The port of the proxy used for connecting to Braintree

proxyType() public static méthode

Sets or gets the proxy type to use for connecting to Braintree. This value can be any of the CURLOPT_PROXYTYPE options in PHP cURL.
public static proxyType ( string $value = null ) : string
$value string If provided, sets the proxy type
Résultat string The proxy type used for connecting to Braintree

proxyUser() public static méthode

public static proxyUser ( $value = null )

publicKey() public static méthode

public static publicKey ( $value = null )

reset() public static méthode

resets configuration to default
public static reset ( )

serverName() public méthode

returns gateway server name depending on environment
public serverName ( ) : string
Résultat string server domain name

setEnvironment() public méthode

Do not use this method directly. Pass in the environment to the constructor.
public setEnvironment ( $value )

setMerchantId() public méthode

Do not use this method directly. Pass in the merchantId to the constructor.
public setMerchantId ( $value )

setPrivateKey() public méthode

Do not use this method directly. Pass in the privateKey to the constructor.
public setPrivateKey ( $value )

setPublicKey() public méthode

Do not use this method directly. Pass in the publicKey to the constructor.
public setPublicKey ( $value )

sslOn() public méthode

returns boolean indicating SSL is on or off for this session, depending on environment
public sslOn ( ) : boolean
Résultat boolean

timeout() public static méthode

Sets or gets the read timeout to use for making requests.
public static timeout ( integer $value = null ) : integer
$value integer If provided, sets the read timeout
Résultat integer The read timeout used for connecting to Braintree

Property Details

$global public_oe static_oe property

public static $global