Abstract Class Zend_Gdata_Gapps_Query

Description

Assists in constructing queries for Google Apps entries. This class provides common methods used by all other Google Apps query classes.

This class should never be instantiated directly. Instead, instantiate a class which inherits from this class.

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • abstract:
  • license: New BSD License

Located in /Gdata/Gapps/Query.php (line 47)

Zend_Gdata_Query
   |
   --Zend_Gdata_Gapps_Query
Direct descendents
Class Description
 class Zend_Gdata_Gapps_EmailListRecipientQuery Assists in constructing queries for Google Apps email list recipient entries. Instances of this class can be provided in many places where a URL is required.
 class Zend_Gdata_Gapps_EmailListQuery Assists in constructing queries for Google Apps email list entries.
 class Zend_Gdata_Gapps_UserQuery Assists in constructing queries for Google Apps user entries.
 class Zend_Gdata_Gapps_NicknameQuery Assists in constructing queries for Google Apps nickname entries.
Variable Summary
 string $_domain
Method Summary
 Zend_Gdata_Gapps_Query __construct ([string $domain = null])
 void getBaseUrl ([string $domain = null])
 string getDomain ()
 void setDomain (string $value)
Variables
string $_domain = null (line 55)

The domain which is being administered via the Provisioning API.

  • access: protected

Inherited Variables

Inherited from Zend_Gdata_Query

Zend_Gdata_Query::$_category
Zend_Gdata_Query::$_defaultFeedUri
Zend_Gdata_Query::$_params
Zend_Gdata_Query::$_url
Methods
Constructor __construct (line 63)

Create a new instance.

  • access: public
Zend_Gdata_Gapps_Query __construct ([string $domain = null])
  • string $domain: (optional) The Google Apps-hosted domain to use when constructing query URIs.

Redefinition of:
Zend_Gdata_Query::__construct()
Create Gdata_Query object

Redefined in descendants as:
getBaseUrl (line 108)

Returns the base URL used to access the Google Apps service, based on the current domain. The current domain can be temporarily overridden by providing a fully qualified domain as $domain.

void getBaseUrl ([string $domain = null])
  • string $domain: (optional) A fully-qualified domain to use instead of the default domain for this service instance.
getDomain (line 94)

Get domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'. If no domain is set, null will be returned.

string getDomain ()
setDomain (line 80)

Set domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'.

This value is used when calculating URLs for retrieving and posting entries. If no value is specified, a URL will have to be manually constructed prior to using any methods which interact with the Google Apps provisioning service.

  • access: public
void setDomain (string $value)
  • string $value: The domain to be used for this session.

Inherited Methods

Inherited From Zend_Gdata_Query

 Zend_Gdata_Query::__construct()
 Zend_Gdata_Query::getAlt()
 Zend_Gdata_Query::getAuthor()
 Zend_Gdata_Query::getCategory()
 Zend_Gdata_Query::getMaxResults()
 Zend_Gdata_Query::getParam()
 Zend_Gdata_Query::getPublishedMax()
 Zend_Gdata_Query::getPublishedMin()
 Zend_Gdata_Query::getQuery()
 Zend_Gdata_Query::getQueryString()
 Zend_Gdata_Query::getQueryUrl()
 Zend_Gdata_Query::getStartIndex()
 Zend_Gdata_Query::getUpdatedMax()
 Zend_Gdata_Query::getUpdatedMin()
 Zend_Gdata_Query::resetParameters()
 Zend_Gdata_Query::setAlt()
 Zend_Gdata_Query::setAuthor()
 Zend_Gdata_Query::setCategory()
 Zend_Gdata_Query::setMaxResults()
 Zend_Gdata_Query::setParam()
 Zend_Gdata_Query::setPublishedMax()
 Zend_Gdata_Query::setPublishedMin()
 Zend_Gdata_Query::setQuery()
 Zend_Gdata_Query::setStartIndex()
 Zend_Gdata_Query::setUpdatedMax()
 Zend_Gdata_Query::setUpdatedMin()
 Zend_Gdata_Query::__get()
 Zend_Gdata_Query::__set()

Documentation generated on Mon, 21 Jun 2010 15:40:29 -0400 by phpDocumentor 1.4.3