mirror_php/guzzle
1
0
Fork 0
mirror of https://github.com/guzzle/guzzle.git synced 2025-02-26 02:53:22 +01:00
Code Issues Releases Wiki Activity

updating command options

Browse Source 
based on source code, marking deprecated options in documentation.
adding in new parameters, especially the very useful command.request_options.
This commit is contained in:
kosmik-koi 2013-11-19 00:35:33 -08:00
parent 743d5fbfd4
commit 1003ceb8ce
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/webservice-client/webservice-client.rst
View File

@ -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 <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