diff --git a/reference/x-commerce/book.xml b/reference/x-commerce/book.xml deleted file mode 100644 index fb23918ff4..0000000000 --- a/reference/x-commerce/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - X.commerce - X.commerce - - - &reftitle.intro; - - This extension provides X.commerce bindings and avro helper methods. - X.commerce provides developers - and merchants an ecosystem to build as well as utilize commerce API's built - by others. It supports multi-tenancy, asynchronous/synchronous calls, - and service onboarding. - - Additional examples can be found on - github. - - - - &reference.x-commerce.setup; - &reference.x-commerce.xcom; - - - - diff --git a/reference/x-commerce/configure.xml b/reference/x-commerce/configure.xml deleted file mode 100644 index d2a87cca46..0000000000 --- a/reference/x-commerce/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;xcommerce - - -
- - - diff --git a/reference/x-commerce/constants.xml b/reference/x-commerce/constants.xml deleted file mode 100644 index 6ce60a4616..0000000000 --- a/reference/x-commerce/constants.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - diff --git a/reference/x-commerce/reference.xml b/reference/x-commerce/reference.xml deleted file mode 100644 index 96a2295fac..0000000000 --- a/reference/x-commerce/reference.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - X.commerce &Functions; - - - - diff --git a/reference/x-commerce/setup.xml b/reference/x-commerce/setup.xml deleted file mode 100644 index fc889167d2..0000000000 --- a/reference/x-commerce/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - ext/xcom requires PHP 5.1 or newer. - - - ext/xcom requires libcurl (which must be built with HTTPS - support). - - - ext/xcom requires libavro (which comes bundled in the package - but the installation will prefer the system libavro if available). - -
- - &reference.x-commerce.configure; - -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - - - -
- - - - diff --git a/reference/x-commerce/versions.xml b/reference/x-commerce/versions.xml deleted file mode 100644 index 075944b85d..0000000000 --- a/reference/x-commerce/versions.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - - - - - - - - - - diff --git a/reference/x-commerce/xcom.xml b/reference/x-commerce/xcom.xml deleted file mode 100644 index fc6e4a4bfc..0000000000 --- a/reference/x-commerce/xcom.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - The Xcom class - Xcom - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - Xcom - - - - - Xcom - - - - - Properties - - public - __debug - - - &Methods; - - - - -
- -
- &reftitle.properties; - - - __debug - - Set this to a non-FALSE value to enable debug mode - - - -
- - - - &reference.x-commerce.entities.xcom; - - - - diff --git a/reference/x-commerce/xcom/construct.xml b/reference/x-commerce/xcom/construct.xml deleted file mode 100644 index db6353329a..0000000000 --- a/reference/x-commerce/xcom/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Xcom::__construct - Create a new Xcom object - - - - &reftitle.description; - - public Xcom::__construct - stringfabric_url - stringfabric_token - stringcapability_token - - - Creates a new Xcom object - - - - - &reftitle.parameters; - - - - fabric_url - - - The fabric endpoint (XCOM_FABRIC_PRODUCTION for - production and XCOM_FABRIC_SANDBOX for sandbox). - - - - - fabric_token - - - The fabric token provided to you, pass an empty string if you only send messages. - - - - - capability_token - - - The capability or tenant token, it is used when sending messages. - - - - - - - - - - diff --git a/reference/x-commerce/xcom/decode.xml b/reference/x-commerce/xcom/decode.xml deleted file mode 100644 index a5a1535917..0000000000 --- a/reference/x-commerce/xcom/decode.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Xcom::decode - Decodes an avro message - - - - &reftitle.description; - - public objectXcom::decode - stringavro_msg - stringjson_schema - - - This method decodes an avro message. - - - - - &reftitle.parameters; - - - avro_message - - - The binary avro message to be decoded. - - - - - json_schema - - - The avro JSON schema (avpr) to be used in decoding the message. - - - - - - - - &reftitle.returnvalues; - - Returns a stdClass object, or FALSE on failure. - - - - - &reftitle.examples; - - - <function>Xcom::decode</function> example - -decode(file_get_contents('php://input'), $schema); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Xcom::encode - - - - - - - - diff --git a/reference/x-commerce/xcom/encode.xml b/reference/x-commerce/xcom/encode.xml deleted file mode 100644 index bbe9fa256c..0000000000 --- a/reference/x-commerce/xcom/encode.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Xcom::encode - Encode an avro message - - - - &reftitle.description; - - public stringXcom::encode - stdClassdata - stringavro_schema - - - This method encodes a stdClass object to an - avro binary encoded blob. - - - - - - &reftitle.parameters; - - - data - - - A stdClass compatible object to encode. - - - - - avro_schema - - - The avro JSON schema to encode the data against. - - - - - - - - &reftitle.returnvalues; - - Returns an avro-encoded string or &false; on failure. - - - - - &reftitle.examples; - - - <function>Xcom::encode</function> example - -orderID = "foo1234"; - -$schema = file_get_contents('http://api.x.com/ocl/com.x.example.v1/OrderFulfillment/OrderShipped/1.2.0/'); -$xcom = new Xcom(); -$xcom->encode($data, $schema); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Xcom::decode - - - - - - - - diff --git a/reference/x-commerce/xcom/getdebugoutput.xml b/reference/x-commerce/xcom/getdebugoutput.xml deleted file mode 100644 index bf148b2063..0000000000 --- a/reference/x-commerce/xcom/getdebugoutput.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Xcom::getDebugOutput - Get the debug output - - - - &reftitle.description; - - public stringXcom::getDebugOutput - - - - Get the full request/response headers and body from the previous - message (if Xcom::__debug was set to a - non-&false; value before the - Xcom::send). This call does not work for - messages which are sent using Xcom::sendAsync. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing request/response debug information. - - - - - &reftitle.examples; - - - <function>Xcom::getDebugOutput</function> example - -orderID = "123495585343"; - -$xcom = new Xcom(XCOM_FABRIC_SANDBOX, "fabric_token", "capability_token"); - -$xcom->send("/com.x.example.v1/OrderFulfillment/OrderShipped", $data, $schema); - -echo "Debug output: " . $xcom->getDebugOutput(); - -?> -]]> - - - - - - - - - diff --git a/reference/x-commerce/xcom/getlastresponse.xml b/reference/x-commerce/xcom/getlastresponse.xml deleted file mode 100644 index 2bc54237c5..0000000000 --- a/reference/x-commerce/xcom/getlastresponse.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Xcom::getLastResponse - Get the last response body - - - - &reftitle.description; - - public stringXcom::getLastResponse - - - - Fetch the body of the last response. Mostly useful when debugging - error messages, often times the reason for a failure is documentated - in the response body (ie, Invalid Token, bad HTTP method, etc.) - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a string containing the last response. - - - - - &reftitle.examples; - - - <function>Xcom::getLastResponse</function> example - -send("/com.x.example.v1/OrderFulfillment/OrderShipped", $data); - -echo "I failed because: " . $xcom->getLastResponse(); - -?> -]]> - - - - - - - - diff --git a/reference/x-commerce/xcom/getlastresponseinfo.xml b/reference/x-commerce/xcom/getlastresponseinfo.xml deleted file mode 100644 index ac8d64bf2d..0000000000 --- a/reference/x-commerce/xcom/getlastresponseinfo.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Xcom::getLastResponseInfo - Gets the last response HTTP information - - - - &reftitle.description; - - public arrayXcom::getLastResponseInfo - - - - Get the last response information such as HTTP response code, latencies, - and redirect URL's. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array containing HTTP response information. - - - - - - - diff --git a/reference/x-commerce/xcom/getonboardingurl.xml b/reference/x-commerce/xcom/getonboardingurl.xml deleted file mode 100644 index eeffbcfeca..0000000000 --- a/reference/x-commerce/xcom/getonboardingurl.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Xcom::getOnboardingURL - Generate an onboarding URL - - - - &reftitle.description; - - public stringXcom::getOnboardingURL - stringcapability_name - stringagreement_url - - - Generate an onboarding URL which can be given to the user - to authorize your capability. - - - - - &reftitle.parameters; - - - - capability_name - - - The capability name, such as "FooBar Inc.'s Calculator" - - - - - agreement_url - - - A URL to any additional agreements which would be - presented to users during the onboarding. - - - - - - - - - &reftitle.returnvalues; - - Returns the URL, or &false; on failure. - - - - - &reftitle.examples; - - - <function>Xcom::getOnboardingURL</function> example - -getOnboardingURL("Shipping Service", "http://legal.com/bar")); - -/* -* Output: -* https://devportal.x.com/go/here -*/ -?> -]]> - - - - - - - - diff --git a/reference/x-commerce/xcom/send.xml b/reference/x-commerce/xcom/send.xml deleted file mode 100644 index 5c99051f0c..0000000000 --- a/reference/x-commerce/xcom/send.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - Xcom::send - Send a message - - - - &reftitle.description; - - public intXcom::send - stringtopic - mixeddata - stringjson_schema - arrayhttp_headers - - - Send a message to a capability (API provider) for a topic. - - - - - &reftitle.parameters; - - If json_schema is specified, the data - must be an object and is encoded as an avro-encoded message. - - - If json_schema is not specified, the data - will be converted to a string and sent. - - - - - topic - - - The topic path (ie, /store/get/orders). - - - - - data - - - The data to be sent. - - - - - json_schema - - - The avro JSON schema if data is an object, - if left empty there is no avro encoding. - - - - - http_headers - - - HTTP client headers (such as User-Agent, Accept, etc.) - - - - - - - - - &reftitle.returnvalues; - - Returns the HTTP response code, or &false; on failure. - - - - - &reftitle.examples; - - - <function>Xcom::send</function> example (avro) - -orderID = "123495585343"; - -$xcom = new Xcom(XCOM_FABRIC_SANDBOX, "fabric_token", "capability_token"); - -var_dump($xcom->send("/com.x.example.v1/OrderFulfillment/OrderShipped", $data, $schema)); - -/* -* Output: -* int(200) -*/ -?> -]]> - - - - <function>Xcom::send</function> example (arbitrary payload) - -send("/get/profile", 'request-payload')); - -/* -* Output: -* int(200) -*/ -?> -]]> - - - - - - - &reftitle.seealso; - - - Xcom::sendAsync - - - - - - - diff --git a/reference/x-commerce/xcom/sendasync.xml b/reference/x-commerce/xcom/sendasync.xml deleted file mode 100644 index 40298920b2..0000000000 --- a/reference/x-commerce/xcom/sendasync.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Xcom::sendAsync - Send a message asynchronously - - - - &reftitle.description; - - public intXcom::sendAsync - stringtopic - mixeddata - stringjson_schema - arrayhttp_headers - - - Send a message to a capability (API provider) for a topic asynchronously (using pthreads). - - - - - &reftitle.parameters; - - If json_schema is specified, the data - must be an object and is encoded as an avro-encoded message. - - - If json_schema is not specified, the data - will be converted to a string and sent. - - - - - topic - - - The topic path (ie, /store/get/orders). - - - - - data - - - The data to be sent. - - - - - json_schema - - - The avro JSON schema if data is an object, - if left empty there is no avro encoding. - - - - - http_headers - - - HTTP client headers (such as User-Agent, Accept, etc.) - - - - - - - - - &reftitle.returnvalues; - - Returns 0. - - - - - &reftitle.examples; - - - <function>Xcom::sendAsync</function> example (avro) - -orderID = "123495585343"; - -$xcom = new Xcom(XCOM_FABRIC_SANDBOX, "fabric_token", "capability_token"); - -$xcom->sendAsync("/com.x.example.v1/OrderFulfillment/OrderShipped", $data, $schema); -?> -]]> - - - - <function>Xcom::sendAsync</function> example (arbitrary payload) - -sendAsync("/get/profile", 'request-payload'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Xcom::send - - - - - - -