PHP Class Smalot\Magento\RemoteAdapter

Inheritance: implements Smalot\Magento\RemoteAdapterInterface

Show file Open project: smalot/magento-client Class Usage Examples

Protected Properties

Property	Type	Description
$apiKey	string
$apiUser	string
$autoLogin	boolean
$defaultOptions	array
$options	array
$sessionId	string
$soapClient	SoapClient
$wsdl	string

Public Methods

Method	Description
__construct ( string $path, string $apiUser, string $apiKey, array $options = [], boolean $autoLogin = true )
__destruct ( )
call ( Smalot\Magento\ActionInterface $action, boolean $throwsException = true ) : array \| false
getDefaultOptions ( ) : array
getLastRequest ( ) : string
getLastRequestHeaders ( ) : string
getLastResponse ( ) : string
getLastResponseHeaders ( ) : string
getOptions ( ) : array
login ( string $apiUser = null, string $apiKey = null ) : boolean
logout ( ) : boolean
multiCall ( Smalot\Magento\MultiCallQueueInterface $queue, boolean $throwsException = true ) : array \| false
ping ( ) : boolean
setDefaultOptions ( array $options = [] )
setOptions ( $options )

Protected Methods

Method	Description
checkSecurity ( )
getActions ( Smalot\Magento\MultiCallQueueInterface $queue ) : array
handleCallbacks ( Smalot\Magento\MultiCallQueueInterface $queue, array $results )

Method Details

__construct() public method

public __construct ( string $path, string $apiUser, string $apiKey, array $options = [], boolean $autoLogin = true )
$path	string
$apiUser	string
$apiKey	string
$options	array
$autoLogin	boolean

__destruct() public method

public __destruct ( )

call() public method

public call ( Smalot\Magento\ActionInterface $action, boolean $throwsException = true ) : array \| false
$action	Smalot\Magento\ActionInterface
$throwsException	boolean
return	array \| false

checkSecurity() protected method

protected checkSecurity ( )

getActions() protected method

protected getActions ( Smalot\Magento\MultiCallQueueInterface $queue ) : array
$queue	Smalot\Magento\MultiCallQueueInterface
return	array

getDefaultOptions() public static method

public static getDefaultOptions ( ) : array
return	array

getLastRequest() public method

public getLastRequest ( ) : string
return	string

getLastRequestHeaders() public method

public getLastRequestHeaders ( ) : string
return	string

getLastResponse() public method

public getLastResponse ( ) : string
return	string

getLastResponseHeaders() public method

public getLastResponseHeaders ( ) : string
return	string

getOptions() public method

public getOptions ( ) : array
return	array

handleCallbacks() protected method

protected handleCallbacks ( Smalot\Magento\MultiCallQueueInterface $queue, array $results )
$queue	Smalot\Magento\MultiCallQueueInterface
$results	array

login() public method

public login ( string $apiUser = null, string $apiKey = null ) : boolean
$apiUser	string
$apiKey	string
return	boolean

logout() public method

public logout ( ) : boolean
return	boolean

multiCall() public method

public multiCall ( Smalot\Magento\MultiCallQueueInterface $queue, boolean $throwsException = true ) : array \| false
$queue	Smalot\Magento\MultiCallQueueInterface
$throwsException	boolean
return	array \| false

ping() public method

public ping ( ) : boolean
return	boolean

setDefaultOptions() public static method

public static setDefaultOptions ( array $options = [] )
$options	array

setOptions() public method

public setOptions ( $options )
$options

Property Details

$apiKey protected property

protected string $apiKey
return	string

$apiUser protected property

protected string $apiUser
return	string

$autoLogin protected property

protected bool $autoLogin
return	boolean

$defaultOptions protected static property

protected static array $defaultOptions
return	array

$options protected property

protected array $options
return	array

$sessionId protected property

protected string $sessionId
return	string

$soapClient protected property

protected SoapClient $soapClient
return	SoapClient

$wsdl protected property

protected string $wsdl
return	string