Filter API responses with Output Filters for the PHP SDK


Temboo can help you reduce the complexity of API responses. Just specify one or more Output Filters when you call a Choreo.

What's an Output Filter?

It’s a filter that returns only the data that you care about!

Many APIs return a lot of complex JSON or XML data that can be difficult to parse. Let's take a look at how we can use Output Filters with the PHP SDK to make API responses easier to work with.

Before You Begin

Make sure that you've been through the PHP getting started tutorial. In the following steps, we'll build upon that tutorial by adding Output Filters.

FILTERING API RESPONSES

1In the getting started tutorial, we printed out the Latitude and Longitude. To setup our Output Filters, let's print out all of the returned data at once. Go ahead and replace the Latitude and Longitude print statements with the following:

echo "Outputs: " . print_r ($geocodeByAddressResults->get())

2Run the code and take a look at the console. See the XML response? There's a lot of data!

3What if the only information we need for our application is the formatted_address, and a collection of individual address_components that make up that address? Introducing Output Filters will allow us to extract only those data elements by adding just two lines of code. Add the following lines before the $geocodeByAddressResults = $geocodeByAddress->execute($geocodeByAddressInputs)->getResults(); method:

//add an output filter to extract the full address
$geocodeByAddressInputs->addOutputFilter("address", "/GeocodeResponse/result/formatted_address", "Response");
//add an output filter to extract the collection of address long_name components
$geocodeByAddressInputs->addOutputFilter("components", "/GeocodeResponse/result/address_component/long_name", "Response")

4Run the code again and take a look at the console. You should see the full address, as well as a collection of the long_name components from the XML.

Array
(
    [address] => 104 Franklin Street, New York, NY 10013, USA
    [components] => Array
        (
            [0] => 104
            [1] => Franklin Street
            [2] => Lower Manhattan
            [3] => Manhattan
            [4] => New York
            [5] => New York County
            [6] => New York
            [7] => United States
            [8] => 10013
        )

How Did we do it?

Before showing some neat tricks to access the individual elements in the data, let's take a look at how the filter is created. As we saw above, each Output Filter is constructed with three parameters, in the format:

ChoreoInputSet.addOutputFilter(result_label, data_path, choreo_output)

It may look confusing at first, but let’s step through recreating the two Output Filters from scratch to understand what's happening.

1A ChoreoInputSet object is used to specify the inputs that will be passed to the Choreo. Output Filters are also a type of Choreo input, so we'll add our inputs to the ChoreoInputSet object. To find the input set that we used to add the Geocoding Output Filters, just look back at the following line in your code:

// Get an input object for the Choreo
$geocodeByAddressInputs = $geocodeByAddress->newInputs();

After identifying the input that we'd like to filter, add .addOutputFilter as shown below.

$geocodeByAddressInputs.addOutputFilter(result_label, data_path, choreo_output);

2A result_label is anything we want it to be! It can be data123 or apple or Homer, as long as each output filter has a unique result_label of numbers or letters. This is how we tell Temboo to label a piece of result information when it is returned. In our example, we called our collection of address elements “components”. We called the full address "address".

3The data_path is used to identify, via XPath or a JSON path, the location of the particular item(s) that you want your Output Filter to return. For a more in depth explanation of data paths and data types, check out our guide on JSON & XML for Output Filters. Here are the paths that we used when specifying our Output Filters earlier.

 /GeocodeResponse/result/address_component/long_name
 /GeocodeResponse/result/formatted_address

4The Choreo_output is the name of the Choreo output data that we're filtering. These names can be found in each Choreo's output section on our website. In most cases, the relevant Choreo output name will be Response, like in the screenshot below. However, as you can see we can also retrieve Latitude and Longitude in this particular Choreo.

Where to find the Choreo outputs returned by Temboo for a Choreo

5When we combine all of this information, we have two Output Filters. One returns only the full formatted address as a string, and another returns a collection of elements that make up the address as a list.

//add an output filter to extract the full address
$geocodeByAddressInputs->addOutputFilter("address", "/GeocodeResponse/result/formatted_address", "Response");
//add an output filter to extract the collection of address long_name components
$geocodeByAddressInputs->addOutputFilter("components", "/GeocodeResponse/result/address_component/long_name", "Response")

Making use of the data

Previously, we printed all of the filtered outputs together. However, it can be even more useful to access each element individually.

We noted before that the "components" data is a collection of individual elements that make up the address. To access those elements, we'll iterate over a list of elements retrieved from the getResultList("components") method and print each on a new line. Let's give it a try:

1Replace the line that calls echo "Outputs: " . print_r ($geocodeByAddressResults->get()) with the code below:

foreach ($geocodeByAddressResults->getResultList("components") as $value) {
    echo "$value\n";
}

2Since there is only one piece of data contained in the filter "address", we can simply print the data using the getResultString() method. Add the following line, beneath the for loop you created in the last step:

echo "address: " . $geocodeByAddressResults->getResultString("address") . "\n";

3If you run the code and look at the console, you'll see each of the individual elements from our address as well as the full formatted address:

The results of our Output Filters printed to the console

Here's the full code

The complete code takes advantage of two Output Filters. It should look like this:

require 'php-sdk/src/temboo.php';

// Instantiate the Choreo, using a previously instantiated Temboo_Session object, eg:
$session = new Temboo_Session("ACCOUNT_NAME", "APP_NAME", "APP_KEY");

$geocodeByAddress = new Google_Geocoding_GeocodeByAddress($session);

// Get an input object for the Choreo
$geocodeByAddressInputs = $geocodeByAddress->newInputs();

// Set inputs
$geocodeByAddressInputs->setAddress("104 Franklin St., New York NY 10013");

//add an output filter to extract the full address
$geocodeByAddressInputs->addOutputFilter("address", "/GeocodeResponse/result/formatted_address", "Response");
//add an output filter to extract the collection of address long_name components
$geocodeByAddressInputs->addOutputFilter("components", "/GeocodeResponse/result/address_component/long_name", "Response");

// Execute Choreo and get results
$geocodeByAddressResults = $geocodeByAddress->execute($geocodeByAddressInputs)->getResults();

// Print results
foreach ($geocodeByAddressResults->getResultList("components") as $value) {
    echo "$value\n";
}
echo "address: " . $geocodeByAddressResults->getResultString("address") . "\n";

You should now see individual outputs for each of the address "components" as a list, and the full "address" as a string printed to the serial monitor.

What's Next?

We've filtered some data! You can specify as many Output Filters as you need for each Choreo, so why not try adding your own third output filter to this example? If you'd like to try something different, you can try filtering the output from any of our 2000+ Choreos.

Once you've got your code up and running, you're ready to move on and do more. From monitoring your running applications, to moving your generated Temboo code to your preferred development environment and sharing it with colleagues, collaborators and friends - we've got you covered.

Get Live Updates About Your Application

Integrate Temboo with Slack to get up-to-the-second notifications and alerts about your deployed Temboo code.

Commit Code to GitHub

Commit Temboo-generated code directly to GitHub and share with the world. Learn more.

Need Help?

We're always happy to help. Just email us at support@temboo.com, and we'll answer your questions.


Back