Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 25. PHP (DEPRECATED)

Overview
Copy link

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.

Important

PHP in Apache Camel is deprecated and will be removed in a future release.

Adding the script module
Copy link

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”.

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>
Copy to Clipboard Toggle word wrap

Static import
Copy link

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.*;
Copy to Clipboard Toggle word wrap

Built-in attributes
Copy link

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

Expand
Table 25.1. PHP attributes
AttributeTypeValue

context

org.apache.camel.CamelContext

The Camel Context

exchange

org.apache.camel.Exchange

The current Exchange

request

org.apache.camel.Message

The IN message

response

org.apache.camel.Message

The OUT message

properties

org.apache.camel.builder.script.PropertiesFunction

Function with a resolve method to make it easier to use the properties component inside scripts.

The attributes all set at ENGINE_SCOPE.

Example
Copy link

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

Example 25.2. Route using 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>
Copy to Clipboard Toggle word wrap

Using the properties component
Copy link

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)")
Copy to Clipboard Toggle word wrap

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.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat