API Documentation

Gdata/Gapps/Query.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
version
$Id: Query.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Gapps_Query

Description

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.

Zend_Gdata_Gapps_Query
jump to top

Extends from
Zend_Gdata_Query
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
Properties
$_domain
Methods
__construct
setDomain
getDomain
getBaseUrl

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.

Properties

$_domain
jump to class

string $_domain = 'null'

The domain which is being administered via the Provisioning API.

Details

$_domain
string
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( string $domain = null ) :

Create a new instance.

Arguments
$domain
string
(optional) The Google Apps-hosted domain to use when constructing query URIs.
Details
visibility
public
final
false
static
false

getBaseUrl
jump to class

getBaseUrl( string $domain = null ) :

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.

Arguments
$domain
string
(optional) A fully-qualified domain to use instead of the default domain for this service instance.
Details
visibility
public
final
false
static
false
see
setDomain

getDomain
jump to class

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.

Output
string
The domain to be used for this session, or null if not set.
Details
visibility
public
final
false
static
false
see
setDomain

setDomain
jump to class

setDomain( string $value ) :

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.

Arguments
$value
string
The domain to be used for this session.
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.