PhpRiot
Become Zend Certified

Prepare for the ZCE exam using our quizzes (web or iPad/iPhone). More info...


When you're ready get 7.5% off your exam voucher using voucher CJQNOV23 at the Zend Store

Common Query Parameters

You can specify parameters to customize queries with Zend_Gdata. Query parameters are specified using subclasses of Zend_Gdata_Query. The Zend_Gdata_Query class includes methods to set all query parameters used throughout GData services. Individual services, such as Spreadsheets, also provide query classes to defined parameters which are custom to the particular service and feeds. Spreadsheets includes a CellQuery class to query the Cell Feed and a ListQuery class to query the List Feed, as different query parameters are applicable to each of those feed types. The GData-wide parameters are described below.

  • The q parameter specifies a full-text query. The value of the parameter is a string.

    Set this parameter with the setQuery() function.

  • The alt parameter specifies the feed type. The value of the parameter can be atom, rss, json, or json-in-script. If you don't specify this parameter, the default feed type is atom. NOTE: Only the output of the atom feed format can be processed using Zend_Gdata. The Zend_Http_Client could be used to retrieve feeds in other formats, using query URLs generated by the Zend_Gdata_Query class and its subclasses.

    Set this parameter with the setAlt() function.

  • The maxResults parameter limits the number of entries in the feed. The value of the parameter is an integer. The number of entries returned in the feed will not exceed this value.

    Set this parameter with the setMaxResults() function.

  • The startIndex parameter specifies the ordinal number of the first entry returned in the feed. Entries before this number are skipped.

    Set this parameter with the setStartIndex() function.

  • The updatedMin and updatedMax parameters specify bounds on the entry date. If you specify a value for updatedMin, no entries that were updated earlier than the date you specify are included in the feed. Likewise no entries updated after the date specified by updatedMax are included.

    You can use numeric timestamps, or a variety of date/time string representations as the value for these parameters.

    Set this parameter with the setUpdatedMin() and setUpdatedMax() functions.

There is a get*() function for each set*() function.

<?php
$query 
= new Zend_Gdata_Query();
$query->setMaxResults(10);
echo 
$query->getMaxResults();   // returns 10

The Zend_Gdata class also implements "magic" getter and setter methods, so you can use the name of the parameter as a virtual member of the class.

<?php
$query 
= new Zend_Gdata_Query();
$query->maxResults 10;
echo 
$query->maxResults;        // returns 10

You can clear all parameters with the resetParameters() function. This is useful to do if you reuse a Zend_Gdata object for multiple queries.

<?php
$query 
= new Zend_Gdata_Query();
$query->maxResults 10;
// ...get feed...

$query->resetParameters();      // clears all parameters
// ...get a different feed...

Zend Framework