API Documentation

Zend/Gdata/Gapps/Query.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id: Query.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Gapps_Query

Package: Zend\Gdata\Gapps

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.

Parent(s)
\Zend_Gdata_Query
Children
\Zend_Gdata_Gapps_OwnerQuery
\Zend_Gdata_Gapps_MemberQuery
\Zend_Gdata_Gapps_EmailListQuery
\Zend_Gdata_Gapps_UserQuery
\Zend_Gdata_Gapps_NicknameQuery
\Zend_Gdata_Gapps_EmailListRecipientQuery
\Zend_Gdata_Gapps_GroupQuery
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_domain= 'null'

The domain which is being administered via the Provisioning API.

Default valuenullDetails
Type
string

Methods

methodpublic__construct( string $domain = null ) : void

Create a new instance.

Parameters
Name Type Description
$domain string

(optional) The Google Apps-hosted domain to use when constructing query URIs.

methodpublicgetBaseUrl( string $domain = null ) : void

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.

Parameters
Name Type Description
$domain string

(optional) A fully-qualified domain to use instead of the default domain for this service instance.

Details
See
\setDomain  
methodpublicgetDomain( ) : string

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.

Returns
Type Description
string The domain to be used for this session, or null if not set.
Details
See
\setDomain  
methodpublicsetDomain( string $value ) : void

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.

Parameters
Name Type Description
$value string

The domain to be used for this session.

Documentation was generated by DocBlox 0.15.1.