PHP Class Scalr\Service\Aws\Client\SoapClient

Since: 27.02.2013
Author: Vitaliy Demidov ([email protected])
Inheritance: extends SoapClient, implements Scalr\Service\Aws\Client\ClientInterface
显示文件 Open project: scalr/scalr Class Usage Examples

Protected Properties

Property Type Description
$apiVersion string AWS API Version
$awsAccessKeyId string AWS Access Key Id
$canonicalMethod
$certificate string x.509 certificate
$privateKey string private key
$secretAccessKey string Secret Access Key
$sigNode
$url string Base url for API requests
$wsdl string WSDL local path or uri

Public Methods

Method Description
__call ( $function_name, $arguments )
__construct ( string $awsAccessKeyId, string $secretAccessKey, string $apiVersion, string $url, string $wsdl ) Constructor
__doRequest ( $request, $location, $action, $version, $one_way = null )
call ( $action, $options, $path = '/' )
getApiVersion ( ) : string Gets API Version date
getAws ( ) : Aws Gets AWS instance
getCertificate ( ) : string Gets x.509 certificate
getPrivateKey ( ) : string Gets private key that associated with x.509 certificate
getQueriesQuantity ( )
getServiceName ( )
getType ( )
getUrl ( ) : string Gets base url for API requests
setApiVersion ( string $apiVersion ) Sets Api Version
setAws ( Aws $aws = null ) : SoapClient Sets aws instance
setCertificate ( string $certificate ) : SoapClient Sets x.509 certificate
setPrivateKey ( string $pk ) : SoapClient Sets private key that associated with x.509 certificate
setServiceName ( $service )
setUrl ( string $url ) Sets query url

Protected Methods

Method Description
_addRefInternal ( $sinfoNode, $node, $algorithm, $arTransforms = null, $options = null )
_calculateDigest ( $digestAlgorithm, $data )
_canonicalizeData ( $node, $canonicalmethod, $arXPath = null, $prefixList = null )
_createNewSignNode ( $name, $value = NULL )
_generateGuid ( $prefix = 'pfx' )
_get509XCert ( $cert, $isPEMFormat = true )
_incrementQueriesQuantity ( ) Increments the quantity of the processed queries during current client instance
_insertSignature ( $node, $beforeNode = NULL ) This function inserts the signature element.
_locateSignature ( $objDoc )
_processTransforms ( $refNode, $objData )
_staticGet509XCerts ( $certs, $isPEMFormat = true )
getExpirationTime ( ) : string Gets expiration time for Expires option.
getRequestObjectByArray ( $options )

Method Details

__call() public method

See also: SoapClient::__call()
public __call ( $function_name, $arguments )

__construct() public method

Constructor
public __construct ( string $awsAccessKeyId, string $secretAccessKey, string $apiVersion, string $url, string $wsdl )
$awsAccessKeyId string AWS Access Key Id
$secretAccessKey string AWS Secret Access Key
$apiVersion string YYYY-MM-DD representation of AWS API version
$url string host name for the all api requests
$wsdl string WSDL local path or url

__doRequest() public method

See also: SoapClient::__doRequest()
public __doRequest ( $request, $location, $action, $version, $one_way = null )

_addRefInternal() protected method

protected _addRefInternal ( $sinfoNode, $node, $algorithm, $arTransforms = null, $options = null )

_calculateDigest() protected method

protected _calculateDigest ( $digestAlgorithm, $data )

_canonicalizeData() protected method

protected _canonicalizeData ( $node, $canonicalmethod, $arXPath = null, $prefixList = null )

_createNewSignNode() protected method

protected _createNewSignNode ( $name, $value = NULL )

_generateGuid() protected static method

protected static _generateGuid ( $prefix = 'pfx' )

_get509XCert() protected static method

protected static _get509XCert ( $cert, $isPEMFormat = true )

_incrementQueriesQuantity() protected method

Increments the quantity of the processed queries during current client instance
protected _incrementQueriesQuantity ( )

_insertSignature() protected method

The signature element will be appended to the element, unless $beforeNode is specified. If $beforeNode is specified, the signature element will be inserted as the last element before $beforeNode.
protected _insertSignature ( $node, $beforeNode = NULL )
$node The node the signature element should be inserted into.
$beforeNode The node the signature element should be located before.

_locateSignature() protected method

protected _locateSignature ( $objDoc )

_processTransforms() protected method

protected _processTransforms ( $refNode, $objData )

_staticGet509XCerts() protected static method

protected static _staticGet509XCerts ( $certs, $isPEMFormat = true )

call() public method

public call ( $action, $options, $path = '/' )

getApiVersion() public method

Gets API Version date
public getApiVersion ( ) : string
return string Returns API Version Date in YYYY-MM-DD format

getAws() public method

Gets AWS instance
public getAws ( ) : Aws
return Scalr\Service\Aws Returns an AWS intance

getCertificate() public method

Gets x.509 certificate
public getCertificate ( ) : string
return string Returns x.509 certificate

getExpirationTime() protected method

Gets expiration time for Expires option.
protected getExpirationTime ( ) : string
return string Returns expiration time form Expires option that's used in AWS api requests.

getPrivateKey() public method

Gets private key that associated with x.509 certificate
public getPrivateKey ( ) : string
return string Returns private key that associated with x.509 certificate

getQueriesQuantity() public method

public getQueriesQuantity ( )

getRequestObjectByArray() protected method

protected getRequestObjectByArray ( $options )

getServiceName() public method

See also: Scalr\Service\Aws\Client\ClientInterface::getServiceName()
public getServiceName ( )

getType() public method

public getType ( )

getUrl() public method

Gets base url for API requests
public getUrl ( ) : string
return string Returns base url for API requests

setApiVersion() public method

Sets Api Version
public setApiVersion ( string $apiVersion )
$apiVersion string YYYY-MM-DD representation of AWS API version

setAws() public method

Sets aws instance
public setAws ( Aws $aws = null ) : SoapClient
$aws Scalr\Service\Aws AWS intance
return SoapClient

setCertificate() public method

Sets x.509 certificate
public setCertificate ( string $certificate ) : SoapClient
$certificate string x.509 certificate
return SoapClient

setPrivateKey() public method

Sets private key that associated with x.509 certificate
public setPrivateKey ( string $pk ) : SoapClient
$pk string private key that associated with x.509 certificate
return SoapClient

setServiceName() public method

See also: Scalr\Service\Aws\Client\ClientInterface::setServiceName()
public setServiceName ( $service )

setUrl() public method

Sets query url
public setUrl ( string $url )
$url string Base url for API requests

Property Details

$apiVersion protected_oe property

AWS API Version
protected string $apiVersion
return string

$awsAccessKeyId protected_oe property

AWS Access Key Id
protected string $awsAccessKeyId
return string

$canonicalMethod protected_oe property

protected $canonicalMethod

$certificate protected_oe property

x.509 certificate
protected string $certificate
return string

$privateKey protected_oe property

private key
protected string $privateKey
return string

$secretAccessKey protected_oe property

Secret Access Key
protected string $secretAccessKey
return string

$sigNode protected_oe property

protected $sigNode

$url protected_oe property

Base url for API requests
protected string $url
return string

$wsdl protected_oe property

WSDL local path or uri
protected string $wsdl
return string