Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Latest
------

### Changes
* [#79](https://github.com/cleverage/soap-process-bundle/issues/79) Documentation: SOAP call options restored after the call, exceptions of the bundle in the reference pages.

### Fixes
* [#73](https://github.com/cleverage/soap-process-bundle/issues/73) `RequestTransformer` is a private service again, as in 3.2: 3.3 made it public by mistake, with the deprecation of a direct access from the service container that never existed. `UPGRADE.md` (3.3) only mentions the task. Update tests.

Expand Down
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,10 @@ No option can be configured under `cleverage_soap_process`: a key there is ignor

- [Call a SOAP service and export the response](cookbooks/soap_call_and_export.md)
- [Enrich a CSV file with a SOAP service](cookbooks/soap_enrich_csv.md)

## Exceptions

The exceptions named without namespace in the reference pages (e.g. `UnexpectedValueException`) are the ones of the
bundle, `CleverAge\SoapProcessBundle\Exception\*`: they extend the SPL exceptions of the same name and implement
`CleverAge\ProcessBundle\Exception\ProcessExceptionInterface`, so that all the errors of the process bundles can be
caught at once.
8 changes: 4 additions & 4 deletions docs/reference/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Arguments of the `CleverAge\SoapProcessBundle\Client\Client` base class:
Setters
-------

These values can be set with `calls` in the service definition. Note that the [RequestTask](tasks/request_task.md)
overwrites the SOAP call options and headers each time it is executed (see Notes).
These values can be set with `calls` in the service definition. The [RequestTask](tasks/request_task.md) uses its own
SOAP call options and headers for its call only: the values of the client are restored afterwards (see Notes).

| Method | Description |
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -128,11 +128,11 @@ Notes
* The clients are registered by the `code` attribute of their tag, in a service locator built when the container is
compiled: a client is only instantiated when a task or the transformer uses it (an error in a client that a process
does not use does not make it fail). The `code` must be the one returned by `getCode()` (an
`\UnexpectedValueException` is thrown otherwise when it is fetched). Two clients with the same code, or an empty
`UnexpectedValueException` is thrown otherwise when it is fetched). Two clients with the same code, or an empty
code, fail the container compilation.
* **Deprecated**: a service tagged without `code` is still registered, with `ClientRegistry::addClient()`, instantiated
with the registry (deprecated since 3.3, the `code` will be required in 4.0). Two clients with the same code then
throw an `\UnexpectedValueException` giving the ids of both services
throw an `UnexpectedValueException` giving the ids of both services
(`Client <code> is already defined by service "<id>", cannot register service "<id>"`) when the registry is
instantiated, i.e. when the first SOAP task or transformer service is built.
* Using a code that is not registered throws a `CleverAge\SoapProcessBundle\Exception\MissingClientException`
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/tasks/request_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Accepted inputs
[SoapClient::__soapCall()](https://www.php.net/manual/en/soapclient.soapcall.php). An empty input (`null`, `[]`, …)
calls the method without argument.

Any other non-empty input (e.g. a `string`) throws an `\UnexpectedValueException`.
Any other non-empty input (e.g. a `string`) throws an `UnexpectedValueException`.

For a document/literal service, the arguments of the method are usually wrapped in a single array, e.g.
`{ parameters: { sCountryISOCode: FR } }` (in WSDL mode, the keys of the first level are ignored, only the order
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/transformers/request_transformer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Accepted inputs

`array`: list of the arguments passed as `$args` to
[SoapClient::__soapCall()](https://www.php.net/manual/en/soapclient.soapcall.php) (see the
[RequestTask](../tasks/request_task.md#accepted-inputs)). Any other type throws an `\UnexpectedValueException`
[RequestTask](../tasks/request_task.md#accepted-inputs)). Any other type throws an `UnexpectedValueException`
(`Expecting an array of value`).

Possible outputs
Expand Down
Loading