PHP Класс Braintree\Configuration

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$global

Открытые методы

Метод Описание
__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.

Приватные методы

Метод Описание
setProxyHost ( $value )
setProxyPassword ( $value )
setProxyPort ( $value )
setProxyType ( $value )
setProxyUser ( $value )
setTimeout ( $value )

Описание методов

__construct() публичный Метод

public __construct ( $attribs = [] )

assertGlobalHasAccessTokenOrKeys() публичный статический Метод

assertHasAccessTokenOrKeys() публичный Метод

assertHasClientCredentials() публичный Метод

assertHasClientId() публичный Метод

public assertHasClientId ( )

assertHasClientSecret() публичный Метод

authUrl() публичный Метод

public authUrl ( )

baseUrl() публичный Метод

returns the base braintree gateway URL based on config values
public baseUrl ( ) : string
Результат string braintree gateway URL

caFile() публичный Метод

sets the physical path for the location of the CA certs
public caFile ( $sslPath = NULL ) : string
Результат string filepath

environment() публичный статический Метод

public static environment ( $value = null )

gateway() публичный статический Метод

public static gateway ( )

getAccessToken() публичный Метод

public getAccessToken ( )

getClientId() публичный Метод

public getClientId ( )

getClientSecret() публичный Метод

public getClientSecret ( )

getEnvironment() публичный Метод

public getEnvironment ( )

getMerchantId() публичный Метод

public getMerchantId ( )

getPrivateKey() публичный Метод

public getPrivateKey ( )

getProxyHost() публичный Метод

public getProxyHost ( )

getProxyPassword() публичный Метод

public getProxyPassword ( )

getProxyPort() публичный Метод

public getProxyPort ( )

getProxyType() публичный Метод

public getProxyType ( )

getProxyUser() публичный Метод

public getProxyUser ( )

getPublicKey() публичный Метод

public getPublicKey ( )

getTimeout() публичный Метод

public getTimeout ( )

isAccessToken() публичный Метод

public isAccessToken ( )

isAuthenticatedProxy() публичный статический Метод

Specified whether or not a username and password have been provided for use with an authenticated proxy
public static isAuthenticatedProxy ( ) : boolean
Результат boolean true if both proxyUser and proxyPassword are present

isClientCredentials() публичный Метод

public isClientCredentials ( )

isUsingProxy() публичный статический Метод

Specifies whether or not a proxy is properly configured
public static isUsingProxy ( ) : boolean
Результат boolean true if a proxy is configured properly, false if not

logMessage() публичный Метод

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

merchantId() публичный статический Метод

public static merchantId ( $value = null )

merchantPath() публичный Метод

sets the merchant path based on merchant ID
public merchantPath ( ) : string
Результат string merchant path uri

portNumber() публичный Метод

returns the port number depending on environment
public portNumber ( ) : integer
Результат integer portnumber

privateKey() публичный статический Метод

public static privateKey ( $value = null )

protocol() публичный Метод

returns http protocol depending on environment
public protocol ( ) : string
Результат string http || https

proxyHost() публичный статический Метод

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
Результат string The proxy host used for connecting to Braintree

proxyPassword() публичный статический Метод

public static proxyPassword ( $value = null )

proxyPort() публичный статический Метод

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
Результат string The port of the proxy used for connecting to Braintree

proxyType() публичный статический Метод

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
Результат string The proxy type used for connecting to Braintree

proxyUser() публичный статический Метод

public static proxyUser ( $value = null )

publicKey() публичный статический Метод

public static publicKey ( $value = null )

reset() публичный статический Метод

resets configuration to default
public static reset ( )

serverName() публичный Метод

returns gateway server name depending on environment
public serverName ( ) : string
Результат string server domain name

setEnvironment() публичный Метод

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

setMerchantId() публичный Метод

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

setPrivateKey() публичный Метод

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

setPublicKey() публичный Метод

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

sslOn() публичный Метод

returns boolean indicating SSL is on or off for this session, depending on environment
public sslOn ( ) : boolean
Результат boolean

timeout() публичный статический Метод

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
Результат integer The read timeout used for connecting to Braintree

Описание свойств

$global публичное статическое свойство

public static $global