Added php language to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f1af3ade Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f1af3ade Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f1af3ade Branch: refs/heads/master Commit: f1af3adee01b9c2051e4543174ed2a16d3cb1ebd Parents: 705951b Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Aug 25 12:11:48 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Aug 25 12:11:48 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/php-language.adoc | 163 +++++++++++++++++++ 1 file changed, 163 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/f1af3ade/components/camel-script/src/main/docs/php-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/php-language.adoc b/components/camel-script/src/main/docs/php-language.adoc new file mode 100644 index 0000000..5aa086d --- /dev/null +++ b/components/camel-script/src/main/docs/php-language.adoc @@ -0,0 +1,163 @@ +[[PHP-PHP]] +PHP +~~~ + +Camel supports http://www.php.net/[PHP] among other +link:scripting-languages.html[Scripting Languages] to allow an +link:expression.html[Expression] or link:predicate.html[Predicate] to be +used in the link:dsl.html[DSL] or link:xml-configuration.html[Xml +Configuration]. + +To use a PHP expression use the following Java code + +[source,java] +--------------------------------- +... php("somePHPExpression") ... +--------------------------------- + +For example you could use the *php* function to create an +link:predicate.html[Predicate] in a link:message-filter.html[Message +Filter] or as an link:expression.html[Expression] for a +link:recipient-list.html[Recipient List] + +[[PHP-Language-options]] +PHP Language Options +^^^^^^^^^^^^^^^^^^^^ + +// language options: START +The PHP language supports 1 options which are listed below. + + + +{% raw %} +[width="100%",cols="2,1m,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks +|======================================================================= +{% endraw %} +// language options: END + +[[PHP-ScriptContext]] +ScriptContext +^^^^^^^^^^^^^ + +The JSR-223 scripting languages ScriptContext is pre configured with the +following attributes all set at `ENGINE_SCOPE`: + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Attribute |Type |Value + +|context |`org.apache.camel.CamelContext` |The Camel Context ( It cannot be used in groovy) + +|camelContext |`org.apache.camel.CamelContext` |The Camel Context + +|exchange |`org.apache.camel.Exchange` |The current Exchange + +|request |`org.apache.camel.Message` |The message (IN message) + +|response |`org.apache.camel.Message` |*Deprecated*: The OUT message. The OUT message if null by default. Use +IN message instead. + +|properties |`org.apache.camel.builder.script.PropertiesFunction` |*Camel 2.9:* Function with a `resolve` method to make it easier to use +Camels link:properties.html[Properties] component from scripts. See +further below for example. +|======================================================================= + +See link:scripting-languages.html[Scripting Languages] for the list of +languages with explicit DSL support. + +[[PHP-AdditionalargumentstoScriptingEngine]] +Additional arguments to ScriptingEngine +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*Available as of Camel 2.8* + +You can provide additional arguments to the `ScriptingEngine` using a +header on the Camel message with the key `CamelScriptArguments`. + + See this example: + +[[PHP-Usingpropertiesfunction]] +Using properties function +^^^^^^^^^^^^^^^^^^^^^^^^^ + +*Available as of Camel 2.9* + +If you need to use the link:properties.html[Properties] component from a +script to lookup property placeholders, then its a bit cumbersome to do +so. + + For example to set a header name myHeader with a value from a property +placeholder, which key is provided in a header named "foo". + +[source,java] +-------------------------------------------------------------------------------------------------------------- +.setHeader("myHeader").groovy("context.resolvePropertyPlaceholders('{{' + request.headers.get('foo') + '}}')") +-------------------------------------------------------------------------------------------------------------- + +From Camel 2.9 onwards you can now use the properties function and the +same example is simpler: + +[source,java] +------------------------------------------------------------------------------- +.setHeader("myHeader").groovy("properties.resolve(request.headers.get('foo'))") +------------------------------------------------------------------------------- + +[[PHP-Loadingscriptfromexternalresource]] +Loading script from external resource +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*Available as of Camel 2.11* + +You can externalize the script and have Camel load it from a resource +such as `"classpath:"`, `"file:"`, or `"http:"`. + + This is done using the following syntax: `"resource:scheme:location"`, +eg to refer to a file on the classpath you can do: + +[source,java] +------------------------------------------------------------------- +.setHeader("myHeader").groovy("resource:classpath:mygroovy.groovy") +------------------------------------------------------------------- + +[[PHP-Howtogettheresultfrommultiplestatementsscript]] +How to get the result from multiple statements script +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*Available as of Camel 2.14* + +As the scripteengine evale method just return a Null if it runs a +multiple statments script. Camel now look up the value of script result +by using the key of "result" from the value set. If you have multiple +statements script, you need to make sure you set the value of result +variable as the script return value. + +[source,text] +------------------------------------------------------------- +bar = "baz"; +# some other statements ... +# camel take the result value as the script evaluation result +result = body * 2 + 1 +------------------------------------------------------------- + +Â + +[[PHP-Dependencies]] +Dependencies +^^^^^^^^^^^^ + +To use scripting languages in your camel routes you need to add the a +dependency on *camel-script* which integrates the JSR-223 scripting +engine. + +If you use maven you could just add the following to your pom.xml, +substituting the version number for the latest & greatest release (see +link:download.html[the download page for the latest versions]). + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-script</artifactId> + <version>x.x.x</version> +</dependency> +---------------------------------------
