YUI 3.x Home -

Site Search (YDN & YUIBlog):

# YUI Library Examples: IO: XML Transaction — Retrieving a Yahoo! Weather RSS (XML) Feed via a Server-Side Proxy

## IO: XML Transaction — Retrieving a Yahoo! Weather RSS (XML) Feed via a Server-Side Proxy

This example demonstrates how to use IO and a PHP proxy — to work around XMLHttpRequest's same-domain policy — to retrieve an XML document from `http://xml.weather.yahoo.com/forecastrss`.

To try out the example, fill in your five-digit US zip code, or Location ID.

View example in new window.

Zip Code or Location ID

Please enter a U.S. Zip Code or a location ID to get the current temperature. The default is Zip Code 94089 for Sunnyvale, California; its location ID is: USCA1116.

## Exploring the Code for This Example

Create a YUI instance, using IO, for this example:

    //Create a YUI instance including support for IO:YUI({base:"../../build/", timeout: 10000}).use("io-base", function(Y) {	// Y is the YUI instance.	// The rest of the following code is encapsulated in this	// anonymous function.} );

    //Create a YUI instance including support for IO:
    YUI({base:"../../build/", timeout: 10000}).use("io-base", function(Y) {
    	// Y is the YUI instance.
    	// The rest of the following code is encapsulated in this
    	// anonymous function.
    } );

//Create a YUI instance including support for IO: YUI({base:"../../build/", timeout: 10000}).use("io-base", function(Y) { // Y is the YUI instance. // The rest of the following code is encapsulated in this // anonymous function. } );

### Callback Object and the Weather RSS

Yahoo! Weather RSS will return an XML document if the transaction is successful. The following `success` callback handlers is used to process the response.

    //Define a function to handle a successful response from//Yahoo! Weather.  The success handler will find the response//object in its second argument:function successHandler(id, o){    Y.log("Success handler called; handler will parse the retrieved XML and insert into DOM.", "info", "example");    var root = o.responseXML.documentElement;    var oTitle = root.getElementsByTagName('description')[0].firstChild.nodeValue;    var oDateTime = root.getElementsByTagName('lastBuildDate')[0].firstChild.nodeValue;    var descriptionNode = root.getElementsByTagName('description')[1].firstChild.nodeValue;     div.set("innerHTML", "<p>" + oTitle + "</p>" + "<p>" + oDateTime + "</p>" + descriptionNode);     Y.log("Success handler is complete.", "info", "example");}

    //Define a function to handle a successful response from
    //Yahoo! Weather.  The success handler will find the response
    //object in its second argument:
    function successHandler(id, o){
        Y.log("Success handler called; handler will parse the retrieved XML and insert into DOM.", "info", "example");
        var root = o.responseXML.documentElement;
        var oTitle = root.getElementsByTagName('description')[0].firstChild.nodeValue;
        var oDateTime = root.getElementsByTagName('lastBuildDate')[0].firstChild.nodeValue;
        var descriptionNode = root.getElementsByTagName('description')[1].firstChild.nodeValue;

        div.set("innerHTML", "<p>" + oTitle + "</p>" + "<p>" + oDateTime + "</p>" + descriptionNode);

        Y.log("Success handler is complete.", "info", "example");
    }

//Define a function to handle a successful response from //Yahoo! Weather. The success handler will find the response //object in its second argument: function successHandler(id, o){ Y.log("Success handler called; handler will parse the retrieved XML and insert into DOM.", "info", "example"); var root = o.responseXML.documentElement; var oTitle = root.getElementsByTagName('description')[0].firstChild.nodeValue; var oDateTime = root.getElementsByTagName('lastBuildDate')[0].firstChild.nodeValue; var descriptionNode = root.getElementsByTagName('description')[1].firstChild.nodeValue; div.set("innerHTML", "<p>" + oTitle + "</p>" + "<p>" + oDateTime + "</p>" + descriptionNode); Y.log("Success handler is complete.", "info", "example"); }

### Assemble the Querystring and Initiate the Transaction

The Yahoo! Weather RSS feed requires a simple HTTP GET request with a base URL and a querystring containing the required information as a name-value pair. In this example, we will use the following parameter:

- `p` — location as U.S. Zip Code or Location ID

The following are some example location IDs (do not include the city name):

- Beijing: CHXX0008
- Helsinki: FIXX0002
- London: UKXX0085
- Moscow: RSXX0063
- Munich: GMXX0087
- Paris: FRXX0076
- Riyadh: SAXX0017
- Tokyo: JAXX0085

For more details on the Yahoo! Weather RSS feed and other location IDs, please visit http://developer.yahoo.com/weather/index.html.

Function `getModule` retrieves the input values for location and creates a querystring:

    //When the Get RSS button is clicked, this function will fire//and compose/dispatch the IO request:function getModule(){    //Get the input value:    var iZip = Y.Node.get('#zip').get("value");     //Create a querystring from the input value:    var queryString = encodeURI('?p=' + iZip);     //The location of our server-side proxy:    var entryPoint = '(assets/)weather.php';     //Compile the full URI for the request:    var sUrl = entryPoint + queryString;     Y.log("Submitting request; zip code: " + iZip, "info", "example");     //Make the reqeust:    var request = Y.io(sUrl, {        method:"GET",        on:            {                success:successHandler,                failure:failureHandler            }        }    );} //Use the Event Utility to wire the Get RSS button//to the getModule function:Y.on("click", getModule, "#getWeather");

    //When the Get RSS button is clicked, this function will fire
    //and compose/dispatch the IO request:
    function getModule(){
        //Get the input value:
        var iZip = Y.Node.get('#zip').get("value");

        //Create a querystring from the input value:
        var queryString = encodeURI('?p=' + iZip);

        //The location of our server-side proxy:
        var entryPoint = '(assets/)weather.php';

        //Compile the full URI for the request:
        var sUrl = entryPoint + queryString;

        Y.log("Submitting request; zip code: " + iZip, "info", "example");

        //Make the reqeust:
        var request = Y.io(sUrl, {
            method:"GET",
            on:
                {
                    success:successHandler,
                    failure:failureHandler
                }
            }
        );
    }

    //Use the Event Utility to wire the Get RSS button
    //to the getModule function:
    Y.on("click", getModule, "#getWeather");

//When the Get RSS button is clicked, this function will fire //and compose/dispatch the IO request: function getModule(){ //Get the input value: var iZip = Y.Node.get('#zip').get("value"); //Create a querystring from the input value: var queryString = encodeURI('?p=' + iZip); //The location of our server-side proxy: var entryPoint = '(assets/)weather.php'; //Compile the full URI for the request: var sUrl = entryPoint + queryString; Y.log("Submitting request; zip code: " + iZip, "info", "example"); //Make the reqeust: var request = Y.io(sUrl, { method:"GET", on: { success:successHandler, failure:failureHandler } } ); } //Use the Event Utility to wire the Get RSS button //to the getModule function: Y.on("click", getModule, "#getWeather");

### Full Script Source

Here is the full JavaScript source for this example:

    YUI({base:"../../build/", timeout: 10000}).use("io", 	function(Y) { 		//Get a Node reference to the div we'll use for displaying		//results:		var div = Y.Node.get('#weatherModule'); 		//Define a function to handle a successful response from		//Yahoo! Weather.  The success handler will find the response		//object in its second argument:		function successHandler(id, o){			Y.log("Success handler called; handler will parse the retrieved XML and insert into DOM.", "info", "example");			var root = o.responseXML.documentElement;			var oTitle = root.getElementsByTagName('description')[0].firstChild.nodeValue;			var oDateTime = root.getElementsByTagName('lastBuildDate')[0].firstChild.nodeValue;			var descriptionNode = root.getElementsByTagName('description')[1].firstChild.nodeValue; 			div.set("innerHTML", "<p>" + oTitle + "</p>" + "<p>" + oDateTime + "</p>" + descriptionNode); 			Y.log("Success handler is complete.", "info", "example");		} 		//Provide a function that can help debug failed		//requests:		function failureHandler(id, o){			Y.log("Failure handler called; http status: " + o.status, "info", "example");			div.set("innerHTML", o.status + " " + o.statusText);		} 		//When the Get RSS button is clicked, this function will fire		//and compose/dispatch the IO request:		function getModule(){			//Get the input value:			var iZip = Y.Node.get('#zip').get("value"); 			//Create a querystring from the input value:			var queryString = encodeURI('?p=' + iZip); 			//The location of our server-side proxy:			var entryPoint = '(assets/)weather.php'; 			//Compile the full URI for the request:			var sUrl = entryPoint + queryString; 			Y.log("Submitting request; zip code: " + iZip, "info", "example"); 			//Make the reqeust:			var request = Y.io(sUrl, {				method:"GET",				on:					{						success:successHandler,						failure:failureHandler					}				}			);		} 		//Use the Event Utility to wire the Get RSS button		//to the getModule function:		Y.on("click", getModule, "#getWeather"); 		Y.log("When you retrieve weather RSS data, relevant steps in the process will be reported here in the logger/console.", "info", "example");	});

    YUI({base:"../../build/", timeout: 10000}).use("io",

    	function(Y) {

    		//Get a Node reference to the div we'll use for displaying
    		//results:
    		var div = Y.Node.get('#weatherModule');

    		//Define a function to handle a successful response from
    		//Yahoo! Weather.  The success handler will find the response
    		//object in its second argument:
    		function successHandler(id, o){
    			Y.log("Success handler called; handler will parse the retrieved XML and insert into DOM.", "info", "example");
    			var root = o.responseXML.documentElement;
    			var oTitle = root.getElementsByTagName('description')[0].firstChild.nodeValue;
    			var oDateTime = root.getElementsByTagName('lastBuildDate')[0].firstChild.nodeValue;
    			var descriptionNode = root.getElementsByTagName('description')[1].firstChild.nodeValue;

    			div.set("innerHTML", "<p>" + oTitle + "</p>" + "<p>" + oDateTime + "</p>" + descriptionNode);

    			Y.log("Success handler is complete.", "info", "example");
    		}

    		//Provide a function that can help debug failed
    		//requests:
    		function failureHandler(id, o){
    			Y.log("Failure handler called; http status: " + o.status, "info", "example");
    			div.set("innerHTML", o.status + " " + o.statusText);
    		}

    		//When the Get RSS button is clicked, this function will fire
    		//and compose/dispatch the IO request:
    		function getModule(){
    			//Get the input value:
    			var iZip = Y.Node.get('#zip').get("value");

    			//Create a querystring from the input value:
    			var queryString = encodeURI('?p=' + iZip);

    			//The location of our server-side proxy:
    			var entryPoint = '(assets/)weather.php';

    			//Compile the full URI for the request:
    			var sUrl = entryPoint + queryString;

    			Y.log("Submitting request; zip code: " + iZip, "info", "example");

    			//Make the reqeust:
    			var request = Y.io(sUrl, {
    				method:"GET",
    				on:
    					{
    						success:successHandler,
    						failure:failureHandler
    					}
    				}
    			);
    		}

    		//Use the Event Utility to wire the Get RSS button
    		//to the getModule function:
    		Y.on("click", getModule, "#getWeather");

    		Y.log("When you retrieve weather RSS data, relevant steps in the process will be reported here in the logger/console.", "info", "example");
    	}
    );

YUI({base:"../../build/", timeout: 10000}).use("io", function(Y) { //Get a Node reference to the div we'll use for displaying //results: var div = Y.Node.get('#weatherModule'); //Define a function to handle a successful response from //Yahoo! Weather. The success handler will find the response //object in its second argument: function successHandler(id, o){ Y.log("Success handler called; handler will parse the retrieved XML and insert into DOM.", "info", "example"); var root = o.responseXML.documentElement; var oTitle = root.getElementsByTagName('description')[0].firstChild.nodeValue; var oDateTime = root.getElementsByTagName('lastBuildDate')[0].firstChild.nodeValue; var descriptionNode = root.getElementsByTagName('description')[1].firstChild.nodeValue; div.set("innerHTML", "<p>" + oTitle + "</p>" + "<p>" + oDateTime + "</p>" + descriptionNode); Y.log("Success handler is complete.", "info", "example"); } //Provide a function that can help debug failed //requests: function failureHandler(id, o){ Y.log("Failure handler called; http status: " + o.status, "info", "example"); div.set("innerHTML", o.status + " " + o.statusText); } //When the Get RSS button is clicked, this function will fire //and compose/dispatch the IO request: function getModule(){ //Get the input value: var iZip = Y.Node.get('#zip').get("value"); //Create a querystring from the input value: var queryString = encodeURI('?p=' + iZip); //The location of our server-side proxy: var entryPoint = '(assets/)weather.php'; //Compile the full URI for the request: var sUrl = entryPoint + queryString; Y.log("Submitting request; zip code: " + iZip, "info", "example"); //Make the reqeust: var request = Y.io(sUrl, { method:"GET", on: { success:successHandler, failure:failureHandler } } ); } //Use the Event Utility to wire the Get RSS button //to the getModule function: Y.on("click", getModule, "#getWeather"); Y.log("When you retrieve weather RSS data, relevant steps in the process will be reported here in the logger/console.", "info", "example"); } );

### Proxy and Response

Once `weather.php` receives the querystring, it will construct and send an HTTP GET using CURL to retrieve the results from the Yahoo! Weather RSS feed. This allows the transaction to succeed while working around XMLHttpRequest's strict security policy.

    //Within a PHP block: // Since the result is an XML document, the Content-type// header must be set to "text/xml" for the data to be// treated as XML and to populate responseXML.header("Content-Type:text/xml"); // io-weather_clean.html is the resource path of the Y! Weather RSS// with the appended querystring of zip code/location id.$url = 'http://xml.weather.yahoo.com/forecastrss?'.getenv('QUERY_STRING'); // This function initializes CURL, sets the necessary CURL// options, executes the request and returns the results.function getResource(io-weather_clean.html){        $ch = curl_init();        curl_setopt($ch, CURLOPT_URL, $url);        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);        $result = curl_exec($ch);        curl_close($ch);         return $result;} // Call getResource to make the request.$feed = getResource($url); // Return the results.echo $feed;

    //Within a PHP block:

    // Since the result is an XML document, the Content-type
    // header must be set to "text/xml" for the data to be
    // treated as XML and to populate responseXML.
    header("Content-Type:text/xml");

    // io-weather_clean.html is the resource path of the Y! Weather RSS
    // with the appended querystring of zip code/location id.
    $url = 'http://xml.weather.yahoo.com/forecastrss?'.getenv('QUERY_STRING');

    // This function initializes CURL, sets the necessary CURL
    // options, executes the request and returns the results.
    function getResource(io-weather_clean.html){
            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, $url);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
            $result = curl_exec($ch);
            curl_close($ch);

            return $result;
    }

    // Call getResource to make the request.
    $feed = getResource($url);

    // Return the results.
    echo $feed;

//Within a PHP block: // Since the result is an XML document, the Content-type // header must be set to "text/xml" for the data to be // treated as XML and to populate responseXML. header("Content-Type:text/xml"); // io-weather_clean.html is the resource path of the Y! Weather RSS // with the appended querystring of zip code/location id. $url = 'http://xml.weather.yahoo.com/forecastrss?'.getenv('QUERY_STRING'); // This function initializes CURL, sets the necessary CURL // options, executes the request and returns the results. function getResource(io-weather_clean.html){ $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $result = curl_exec($ch); curl_close($ch); return $result; } // Call getResource to make the request. $feed = getResource($url); // Return the results. echo $feed;

Copyright © 2009 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings