XML Reference Guide

Mar 14, 2003

␡

⎙ Print

< Back Page 211 of 278 Next >

Now that we've discussed just what it is we can do with Yahoo! Web Services, it's time to actually do it. In this guide section, we'll build, from scratch, a PHP form that builds a Yahoo! query, sends it off, and displays the results based on the type of search.

Our intent is to build a small "module," possibly intended to be displayed on a second page, that displays the top 10 results for a given keyword. To keep things simple, we won't cover local searches, but the ideas are the same.

We'll start with a form that takes the keyword and service information:

   <h3>Yahoo! Results</h3>

   <form action="yahoo.php" method="get">

      Choose a keyword: <input type="text" name="keyword" /><br />
      Choose a service: <select name="service">
         <option value="web">web</option>
         <option value="image">images</option>

         <option value="video">video</option>
         <option value="news">news</option>
      </select>
      <input type="submit" />      
   </form>

The form creates a page much like figure 1:

When we submit the form, the first thing we need to do is extract the submitted information:

<?php

$keyword=$HTTP_GET_VARS["keyword"];
if ($keyword == ""){
?>
   <h3>Yahoo! Results</h3>

   <form action="yahoo.php" method="get">
      Choose a keyword: <input type="text" name="keyword" /><br />
      Choose a service: <select name="service">
         <option value="web">web</option>

         <option value="image">images</option>
         <option value="video">video</option>
         <option value="news">news</option>
      </select>

      <input type="submit" />      
   </form>

<?php
} else {

   $searchService = $HTTP_GET_VARS["service"];
   if ($searchService == "") {
       $searchService = "web";
   }
}
?>

First, we're checking to see whether the form's been submitted, based on whether or not there's a keyword value. If not, we're displaying the form. If so, we're getting the service value. Just to be on the safe side, if one wasn't submitted, we'll use the web search service.

Next we need to build the URL for the request. To do that, we need to take into account that each service has its own "base" URL:

<?php

function getRequestURL($baseURL, $keyword){

   $otherArgs="&appid=InformITXML&results=10";
   return $baseURL."?query=".$keyword.$otherArgs;

}


$keyword=$HTTP_GET_VARS["keyword"];
if ($keyword == ""){
...
} else {

   $searchService = $HTTP_GET_VARS["service"];
   if ($searchService == "") {
       $searchService = "web";
   }
   $baseURLs = array(
       "web" => "http://api.search.yahoo.com/WebSearchService/V1/webSearch", 
       "video" => "http://api.search.yahoo.com/VideoSearchService/V1/videoSearch", 
       "news" => "http://api.search.yahoo.com/NewsSearchService/V1/newsSearch", 
       "image" => "http://api.search.yahoo.com/ImageSearchService/V1/imageSearch");

   $fullURL = getRequestURL($baseURLs[$searchService], $keyword);

}

Let's start at the bottom. The actual request consists of a URL. The URL is made up of a "base" url and various parameters. We can pull that base URL from an array based on the search service. From there we move up to the getRequestURL() function.

The getRequestURL() function builds the complete URL based on the base URL, which we're passing in, the query, or keyword, which we're also passing in, and any additional arguments. In this case, we're passing only the (required) appid and the results parameter, specifying that we only want 10 results. If we were including the Local Search service in our form, we would also have to accomodate the radius and other location-based parameters. Finally, we combine them all and send back the results.

Now we're ready to actually send the request. Fortunately, PHP's Document Object Model implementation makes that part easy:

...
   $fullURL = getRequestURL($baseURLs[$searchService], $keyword);

   $document = domxml_open_file($fullURL);
   $root = $document->document_element();

   $totalResults = 0;
   $thisPageResults = 0;

   if ($root->has_attributes()) {
       $attributesArray = $root->attributes();
       foreach ($attributesArray AS $thisAttribute) {
          $attributeName = $thisAttribute->name();
          if ($attributeName == "totalResultsAvailable") {
              $totalResults = $thisAttribute->value();
          } elseif ($attributeName == "totalResultsReturned"){
              $thisPageResults = $thisAttribute->value();
          }
       }
   }

   echo ("<h3>Top ".$thisPageResults." Yahoo! results for \"".$keyword."\"</h3>");
   echo ("<p>Total Results: ".$totalResults."</p>");

}

PHP's DOM implementation let's us parse a document at an external URL, so we don't need to fool around with making and reading HTTP requests. Instead, we get a reference to the root element, in this case ResultSet. From there, we'll extract the totalResultsAvailable and totalResultsReturned attributes of the ResultSet element so we know whether there are any results to analyze.

Assuming there are, we'll handle that next:

...
   echo ("<h3>Top ".$thisPageResults." Yahoo! results for \"".$keyword."\"</h3>");
   echo ("<p>Total Results: ".$totalResults."</p>");
   
   $thisResult = $root->first_child();
   while ($thisResult){

      $titleElement = $thisResult->get_elements_by_tagname("Title");
      $titleValue = $titleElement[0]->first_child();
      $title = $titleValue->node_value();

      $click_urlElement = $thisResult->get_elements_by_tagname("ClickUrl");
      $click_urlValue = $click_urlElement[0]->first_child();
      $click_url = $click_urlValue->node_value();

      $display_urlElement = $thisResult->get_elements_by_tagname("Url");
      $display_urlValue = $display_urlElement[0]->first_child();
      $display_url = $display_urlValue->node_value();

      $summaryElement = $thisResult->get_elements_by_tagname("Summary");
      $summaryValue = $summaryElement[0]->first_child();
      if ($summaryValue){
           $summary = $summaryValue->node_value();
      }
...
      $thisResult = $thisResult->next_sibling();

   }

}

The actual results come back as Result element children of the ResultSet element, so we'll start by getting the first child of the ResultSet element and analyzing it to pull the Title, ClickUrl (the URL the user should be directed to), Url (the actual URL of the resource, and not a Yahoo! redirect), and the Summary. Some results don't actually have a summary, so we'll check that before we try to access the value.

Finally, we'll move to the next sibling so we don't create an infinite loop; when we run out of children, the while() loop stops.

Once we have the information, we can display it on the page:

...
      $summaryValue = $summaryElement[0]->first_child();
      if ($summaryValue){
           $summary = $summaryValue->node_value();
      }

      if ($searchService == "image"){
          $thumbnailElement = $thisResult->get_elements_by_tagname("Thumbnail");
          $thumbnailURLElement = $thumbnailElement[0]->first_child();
          $thumbnailURLValue = $thumbnailURLElement->first_child();
          $thumbnail = $thumbnailURLValue->node_value();

          echo ("<a href=\"".$click_url."\">");
          echo ("<img src=\"".$thumbnail."\" />");
          echo ("</a><br /><br />");
      } else {

          echo ($title);
          echo ("<br />");
      
          echo ("<a href=\"".$click_url."\">");
          echo ($display_url);
          echo ("</a><br />");

          echo ($summary."<br /><br />");
      }

      $thisResult = $thisResult->next_sibling();

   }
}

How we actually display the information depends on what it is. If we're dealing with an Image Search, we'll want to display the thumbnail, which also means extracting extra information from the Thumbnail element. Otherwise, we're simply displaying the title, URL (both the click and display variety) and the summary.

The results look like Figures 2 and 3:

The implementation in other languages will, of course, be different, but the concept is the same: get the query information, build the URL for the request, and pull the important information out of the results.

< Back Page 211 of 278 Next >

🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Privacy Notice

Overview

Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security

Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children

This site is not directed to children under the age of 13.

Marketing

Pearson may send or direct marketing communications to users, provided that

Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
Such marketing is consistent with applicable law and Pearson's legal obligations.
Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out

Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

As required by law.
With the consent of the individual (or their parent, if the individual is a minor)
In response to a subpoena, court order or legal process, to the extent permitted or required by law
To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
To investigate or address actual or suspected fraud or other illegal activities
To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links

This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020

Email Address