PHP is a widely-used general-purpose scripting language that is especially suited for Web development. The PHP support is part of the camel-script module.

To use PHP in your routes you need to add a dependency on camel-script to your project as shown in Example 25.1, “Adding the camel-script dependency”.

<!-- Maven POM File -->
...
<dependencies>
  ...
  <dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-script</artifactId>
    <version>${camel-version}</version>
  </dependency>
  ...
</dependencies>

To use the php() static method in your application code, include the following import statement in your Java source files:

import static org.apache.camel.builder.script.ScriptBuilder.*;

Table 25.1, “PHP attributes” lists the built-in attributes that are accessible when using PHP.

The attributes all set at ENGINE_SCOPE.

Example 25.2, “Route using PHP” shows a route that uses PHP.

<camelContext>
  <route>
    <from uri="direct:start"/>
    <choice>
      <when>
        <language language="php">strpos(request.headers.get('user'), 'admin')!== FALSE</language>
        <to uri="seda:adminQueue"/>
      </when>
      <otherwise>
        <to uri="seda:regularQueue"/>
      </otherwise>
    </choice>
  </route>
</camelContext>

To access a property value from the properties component, invoke the resolve method on the built-in properties attribute, as follows:

.setHeader("myHeader").php("properties.resolve(PropKey)")

Where PropKey is the key of the property you want to resolve, where the key value is of String type.

For more details about the properties component, see Properties in the Apache Camel Component Reference Guide.