• Home
• ApiMethods

PHP Class ApiMethods

Supported Version: PHP >= 5.0 Show file Open project: fubralimited/php-oara

Public Methods

Method	Description
__construct ( string $protocol, string $version ) : void	Constructor: Sets the api version and protocol
doRestfulRequest ( array $resource, $parameter = false, string $body = false ) : string	Performs REST request.
doSoapRequest ( $service, string $method, array $params = [] ) : object	Performs SOAP request.
enableCompression ( ) : void	Set http protocol type
getProtocol ( ) : string	Returns api protocol type
getVersion ( ) : string	Sets the api version and protocol
serialize ( $rootName, $itemArray, $attr = [] ) : void	Serializes item.
setConnectId ( string $connectId ) : void	Set connectId
setHttpProtocol ( $httpProtocol ) : void	Set http protocol type
setProtocol ( string $protocol ) : void	Set api protocol type
setProxy ( string $host, integer $port, string $login, string $password ) : void	Set http protocol type
setPublicKey ( $publicKey ) : void	Set SecretKey
setRestfulAction ( $verb ) : void	Sets the HTTP RESTful action verb.
setSecretKey ( string $secretKey ) : void	Set SecretKey
setSecureApiCall ( $status = false ) : void	Enables the API authentication.
setVersion ( string $version ) : void	Sets the api version
unserialize ( string $string ) : void	Unserializes item.

Private Methods

Method	Description
getContentType ( ) : string	Returns restful content type
getRestfulPath ( ) : string	Returns restful api endpoint path
getWsdlUrl ( string $service ) : string	Returns wsdl api endpoint
httpRequest ( string $uri, string $header, string $body = false ) : mixed	HTTP REST Connection (GET/POST)
isValidHeader ( $responseHeader ) : string	Returns if http response is valid.

Method Details