VERSION
VERSION
The wrapper version.
The wrapper version number.
Services Web Service.
setCryptoMethod(integer $method)
Set the crypto method used when connectiing to the web services server.
This allows a specific crypto method to be used when connecting to the web service server. The values should be one of the STREAM_CRYPTO_METHOD_TLSv1_N_CLIENT constants. The default is STREAM_CRYPTO_METHOD_ANY_CLIENT.
| integer | $method | The crypto method to use. |
getServiceSchema(boolean $is_outbound, string $dst_filename = null) : object|integer
Get service schema.
| boolean | $is_outbound | Whether to get outbound or inbound schema. |
| string | $dst_filename | A local filename to store the schema in. |
Returns the schema as an object, or the amount of data written to the file.
readService(boolean $is_outbound, string $service_name, string $dst_filename = null) : object|integer
Read a service configuration.
| boolean | $is_outbound | Whether to read an outbound or an inbound sservice. |
| string | $service_name | The name of the service to read. |
| string | $dst_filename | A local filename to store the retrieved configuration in. |
Returns the service configuration as an object, or the amount of data written to the file.
writeService(boolean $is_outbound, string $service_name, mixed $config = null, string $dst_filename = null) : array
Write a service configuration.
| boolean | $is_outbound | Whether to write an outbound or an inbound sservice. |
| string | $service_name | The name of the service to write. |
| mixed | $config | The configuration to write. If a string, it is treated as a local file to read the configuration from. Other types are encoded using json_encode(). Null means no body is included, which is only valid for inbound services. |
| string | $dst_filename | A local filename to store the new configuration in. |
The array will have a 'status' key, the value of which will be "created" if the service was created, or "replaced" if the service existed and was replaced. If a destination filename was given, an 'amount_written' key with the value being the number of bytes written as integer. Otherwise, a 'config' key with the value being the new configuration as an object.
modifyService(boolean $is_outbound, string $service_name, mixed $config, string $dst_filename = null) : object|integer
Modify a service configuration.
| boolean | $is_outbound | Whether to modify an outbound or an inbound sservice. |
| string | $service_name | The name of the service to modify. |
| mixed | $config | The configuration to apply as a modification. If a string, it is treated as a local file to read the configuration from. Other types are encoded using json_encode(). |
| string | $dst_filename | A local filename to store the new configuration in. |
Returns the new configuration as an object, or the amount of data written to the file.
outboundQueueInfo(string $service_name) : \Aculab\WebServicesWrapper\OutboundQueueInfo
Get the outbound queue info.
| string | $service_name | The name of the service to get the queue info for. |
outboundQueuePurge(string $service_name) : \Aculab\WebServicesWrapper\OutboundQueuePurgeResult
Purge the outbound queue.
| string | $service_name | The name of the service to purge the queue of. |