PHP Class Pingpp\Pingpp

Exibir arquivo Open project: pingplusplus/pingpp-php Class Usage Examples

Public Properties

Property Type Description
$apiBase The base URL for the Pingpp API.
$apiKey The Pingpp API key to be used for requests.
$apiVersion The version of the Pingpp API to use for requests.
$privateKey The PEM formatted private key to be used for signing requests.
$privateKeyPath The private key path to be used for signing requests.
$verifySslCerts Defaults to true.

Public Methods

Method Description
getApiKey ( ) : string
getApiVersion ( ) : string
getPrivateKey ( ) : string
getPrivateKeyPath ( ) : string
getVerifySslCerts ( ) : boolean
setApiKey ( string $apiKey ) Sets the API key to be used for requests.
setApiVersion ( string $apiVersion )
setPrivateKey ( string $key )
setPrivateKeyPath ( string $path )
setVerifySslCerts ( boolean $verify )

Method Details

getApiKey() public static method

public static getApiKey ( ) : string
return string The API key used for requests.

getApiVersion() public static method

public static getApiVersion ( ) : string
return string The API version used for requests. null if we're using the latest version.

getPrivateKey() public static method

public static getPrivateKey ( ) : string
return string

getPrivateKeyPath() public static method

public static getPrivateKeyPath ( ) : string
return string

getVerifySslCerts() public static method

public static getVerifySslCerts ( ) : boolean
return boolean

setApiKey() public static method

Sets the API key to be used for requests.
public static setApiKey ( string $apiKey )
$apiKey string

setApiVersion() public static method

public static setApiVersion ( string $apiVersion )
$apiVersion string The API version to use for requests.

setPrivateKey() public static method

public static setPrivateKey ( string $key )
$key string

setPrivateKeyPath() public static method

public static setPrivateKeyPath ( string $path )
$path string

setVerifySslCerts() public static method

public static setVerifySslCerts ( boolean $verify )
$verify boolean

Property Details

$apiBase public_oe static_oe property

The base URL for the Pingpp API.
public static $apiBase

$apiKey public_oe static_oe property

The Pingpp API key to be used for requests.
public static $apiKey

$apiVersion public_oe static_oe property

The version of the Pingpp API to use for requests.
public static $apiVersion

$privateKey public_oe static_oe property

The PEM formatted private key to be used for signing requests.
public static $privateKey

$privateKeyPath public_oe static_oe property

The private key path to be used for signing requests.
public static $privateKeyPath

$verifySslCerts public_oe static_oe property

Defaults to true.
public static $verifySslCerts