From 1003ceb8ce60af9eb38a42160e3457b27124d71e Mon Sep 17 00:00:00 2001 From: kosmik-koi Date: Tue, 19 Nov 2013 00:35:33 -0800 Subject: [PATCH] updating command options based on source code, marking deprecated options in documentation. adding in new parameters, especially the very useful command.request_options. --- docs/webservice-client/webservice-client.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/webservice-client/webservice-client.rst b/docs/webservice-client/webservice-client.rst index 5fe6d0b3..fd03ffde 100644 --- a/docs/webservice-client/webservice-client.rst +++ b/docs/webservice-client/webservice-client.rst @@ -486,16 +486,22 @@ Special command options ----------------------- Guzzle exposes several options that help to control how commands are validated, serialized, and parsed. +Command options can be specified when creating a command or in the ``command.params`` parameter in the +``Guzzle\Service\Client``. =========================== ============================================================================================ -command.headers Additional ``Collection`` of headers to add to the serialized request -command.on_complete Function to execute when the command has been executed and the response has been parsed +command.request_options Option used to add :ref:`Request options ` to the request created by a + command +command.hidden_params An array of the names of parameters ignored by the ``additionalParameters`` parameter schema command.disable_validation Set to true to disable JSON schema validation of the command's input parameters command.response_processing Determines how the default response parser will parse the command. One of "raw" no parsing, "model" (the default method used to parse commands using response models defined in service descriptions) -command.response_body Tells the command object which EntityBody object should be used to store the response body - of a request that will be serialized by the command +command.headers (deprecated) Option used to specify custom headers. Use ``command.request_options`` instead +command.on_complete (deprecated) Option used to add an onComplete method to a command. Use + ``command.after_send`` event instead +command.response_body (deprecated) Option used to change the entity body used to store a response. + Use ``command.request_options`` instead =========================== ============================================================================================ Advanced client configuration