Gdata/Gapps/OwnerQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Gapps_OwnerQuery

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:$

\Zend_Gdata_Gapps_OwnerQuery
jump to top

Package: Zend\Gdata\Gapps

Assists in constructing queries for Google Apps owner entries.

Instances of this class can be provided in many places where a URL is required.

For information on submitting queries to a server, see the Google Apps service class, Zend_Gdata_Gapps.

Parent(s): \Zend_Gdata_Gapps_Query < \Zend_Gdata_Query
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_category = null

inherited

Category for the query

Inherited from: \Zend_Gdata_Query::$$_category \Zend_Gdata_Gapps_Query::$$_category

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_category
Inherited_from: \Zend_Gdata_Gapps_Query::$$_category

string $_defaultFeedUri = null

inherited

Default URL

Inherited from: \Zend_Gdata_Query::$$_defaultFeedUri \Zend_Gdata_Gapps_Query::$$_defaultFeedUri

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_defaultFeedUri
Inherited_from: \Zend_Gdata_Gapps_Query::$$_defaultFeedUri

string $_domain = null

inherited

The domain which is being administered via the Provisioning API.

Inherited from: \Zend_Gdata_Gapps_Query::$$_domain

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Gapps_Query::$$_domain

string $_groupId = null

Group owner is refering to

Default valuenullDetails

Type: string

string $_ownerEmail = null

The email of the owner

Default valuenullDetails

Type: string

array $_params = array()

inherited

Query parameters.

Inherited from: \Zend_Gdata_Query::$$_params \Zend_Gdata_Gapps_Query::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_Query::$$_params
Inherited_from: \Zend_Gdata_Gapps_Query::$$_params

string $_url = null

inherited

Base URL TODO: Add setters and getters

Inherited from: \Zend_Gdata_Query::$$_url \Zend_Gdata_Gapps_Query::$$_url

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_url
Inherited_from: \Zend_Gdata_Gapps_Query::$$_url

Methods

__construct(string $domain = null, string $groupId = null, string $ownerEmail = null) : void

Create a new instance.

Parameters

Name	Type	Description
$domain	string	(optional) The Google Apps-hosted domain to use when constructing query URIs.
$groupId	string	(optional) Value for the groupId property.
$ownerEmail	string	(optional) Value for the OwnerEmail property.

__get( $name) : void

inherited

Inherited from: \Zend_Gdata_Query::__get()\Zend_Gdata_Gapps_Query::__get()

Parameters

Name	Type	Description
$name

__set( $name, $val) : void

inherited

Inherited from: \Zend_Gdata_Query::__set()\Zend_Gdata_Gapps_Query::__set()

Parameters

Name	Type	Description
$name
$val

getAlt() : string

inherited

Inherited from: \Zend_Gdata_Query::getAlt()\Zend_Gdata_Gapps_Query::getAlt()

Returns

Type	Description
string	rss or atom

getAuthor() : string

inherited

Inherited from: \Zend_Gdata_Query::getAuthor()\Zend_Gdata_Gapps_Query::getAuthor()

Returns

Type	Description
string	author

getBaseUrl(string $domain = null) : void

inherited

Returns the base URL used to access the Google Apps service, based on the current domain.

Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()

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

getCategory() : void

inherited

Inherited from: \Zend_Gdata_Query::getCategory()\Zend_Gdata_Gapps_Query::getCategory()

getDomain() : string

inherited

Get domain for this service instance.

Inherited from: \Zend_Gdata_Gapps_Query::getDomain()

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

getGroupId() : string

Get the group id to query for.

Returns

Type	Description
string

getMaxResults() : int

inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()\Zend_Gdata_Gapps_Query::getMaxResults()

Returns

Type	Description
int	maxResults

getOwnerEmail() : string

Get the owner email to query for.

Returns

Type	Description
string

getParam(string $name) : void

inherited

Inherited from: \Zend_Gdata_Query::getParam()\Zend_Gdata_Gapps_Query::getParam()

Parameters

Name	Type	Description
$name	string

getPublishedMax() : string

inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()\Zend_Gdata_Gapps_Query::getPublishedMax()

Returns

Type	Description
string	publishedMax

getPublishedMin() : string

inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()\Zend_Gdata_Gapps_Query::getPublishedMin()

Returns

Type	Description
string	publishedMin

getQuery() : string

inherited

Inherited from: \Zend_Gdata_Query::getQuery()\Zend_Gdata_Gapps_Query::getQuery()

Returns

Type	Description
string	query

getQueryString() : string

inherited

Inherited from: \Zend_Gdata_Query::getQueryString()\Zend_Gdata_Gapps_Query::getQueryString()

Returns

Type	Description
string	querystring

getQueryUrl() : string

Returns the query URL generated by this query instance.

Returns

Type	Description
string	The query URL for this instance.

getStartIndex() : int

inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()\Zend_Gdata_Gapps_Query::getStartIndex()

Returns

Type	Description
int	startIndex

getUpdatedMax() : string

inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()\Zend_Gdata_Gapps_Query::getUpdatedMax()

Returns

Type	Description
string	updatedMax

getUpdatedMin() : string

inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()\Zend_Gdata_Gapps_Query::getUpdatedMin()

Returns

Type	Description
string	updatedMin

resetParameters() : void

inherited

Inherited from: \Zend_Gdata_Query::resetParameters()\Zend_Gdata_Gapps_Query::resetParameters()

setAlt(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setAlt()\Zend_Gdata_Gapps_Query::setAlt()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setAuthor(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setAuthor()\Zend_Gdata_Gapps_Query::setAuthor()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setCategory(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setCategory()\Zend_Gdata_Gapps_Query::setCategory()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setDomain(string $value) : void

inherited

Set domain for this service instance.

Inherited from: \Zend_Gdata_Gapps_Query::setDomain()

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.

setGroupId(string $value) : void

Set the group id to query for.

Parameters

Name	Type	Description
$value	string

Details

See: \getGroupId

setMaxResults(int $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()\Zend_Gdata_Gapps_Query::setMaxResults()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setOwnerEmail(string $value) : void

Set the owner email to query for.

Parameters

Name	Type	Description
$value	string

Details

See: \getOwnerEmail

setParam(string $name, string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setParam()\Zend_Gdata_Gapps_Query::setParam()

Parameters

Name	Type	Description
$name	string
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setPublishedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()\Zend_Gdata_Gapps_Query::setPublishedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setPublishedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()\Zend_Gdata_Gapps_Query::setPublishedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setQuery(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setQuery()\Zend_Gdata_Gapps_Query::setQuery()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setStartIndex(int $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()\Zend_Gdata_Gapps_Query::setStartIndex()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUpdatedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()\Zend_Gdata_Gapps_Query::setUpdatedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUpdatedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()\Zend_Gdata_Gapps_Query::setUpdatedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

Gdata/Gapps/OwnerQuery.php

\Zend_Gdata_Gapps_OwnerQueryjump to top

Properties

Methods

\Zend_Gdata_Gapps_OwnerQuery
jump to top