Gdata/Gapps/Query.php
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-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id: Query.php 23775 2011-03-01 17:25:24Z ralph $
\Zend_Gdata_Gapps_Query
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.
- Extends from
- \Zend_Gdata_Query
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
Properties



string $_domain=
'null'
The domain which is being administered
via the Provisioning API.
Default valuenull
Details
- Type
- string
Methods



__construct( string $domain = null ) : void
Parameters
Name |
Type |
Description |
$domain |
string |
(optional) The Google Apps-hosted domain to use when
constructing query URIs.
|



getBaseUrl( 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



getDomain( ) : 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



setDomain( 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. |