From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../api/core/files/Gdata.Gapps.GroupQuery.html | 149 +++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 zend/documentation/api/core/files/Gdata.Gapps.GroupQuery.html (limited to 'zend/documentation/api/core/files/Gdata.Gapps.GroupQuery.html') diff --git a/zend/documentation/api/core/files/Gdata.Gapps.GroupQuery.html b/zend/documentation/api/core/files/Gdata.Gapps.GroupQuery.html new file mode 100644 index 0000000..7c0dd39 --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.Gapps.GroupQuery.html @@ -0,0 +1,149 @@ + +Zend Gdata API Documentation

Gdata/Gapps/GroupQuery.php

+ Show: + PublicProtectedPrivateinherited
+ 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_GroupQuery
jump to top

Package: Zend\Gdata\Gapps
Assists in constructing queries for Google Apps group 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

>VPropertyprotectedstring $_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 +   +
>VPropertyprotectedstring $_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 +   +
>VPropertyprotectedstring $_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 +   +
>VPropertyprotectedstring $_groupId = null
If not null, specifies the group id of the group who should be +retrieved by this query.
Default valuenullDetails
Type
string
>VPropertyprotectedarray $_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 +   +
>VPropertyprotectedstring $_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

methodpublic__construct(string $domain = null, string $groupId = null,  $startGroupId = null) : void

Create a new instance.

Parameters
NameTypeDescription
$domainstring

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

+
$groupIdstring

(optional) Value for the groupId property.

+
$startGroupId
methodpublic__get( $name) : void
inherited

Inherited from: + \Zend_Gdata_Query::__get()\Zend_Gdata_Gapps_Query::__get()
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
inherited

Inherited from: + \Zend_Gdata_Query::__set()\Zend_Gdata_Gapps_Query::__set()
Parameters
NameTypeDescription
$name
$val
methodpublicgetAlt() : string
inherited

Inherited from: + \Zend_Gdata_Query::getAlt()\Zend_Gdata_Gapps_Query::getAlt()
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
inherited

Inherited from: + \Zend_Gdata_Query::getAuthor()\Zend_Gdata_Gapps_Query::getAuthor()
Returns
TypeDescription
stringauthor
methodpublicgetBaseUrl(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
NameTypeDescription
$domainstring

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

+
Details
See
\setDomain +   +
methodpublicgetCategory() : void
inherited

Inherited from: + \Zend_Gdata_Query::getCategory()\Zend_Gdata_Gapps_Query::getCategory()
methodpublicgetDirectOnly() : bool

Returns
TypeDescription
bool
Details
See
\setDirectOnly +   +
methodpublicgetDomain() : 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
TypeDescription
stringThe domain to be used for this session, or null if not + set.
Details
See
\setDomain +   +
methodpublicgetGroupId() : void

Get the group id to query for.

If no group id is set, null will be +returned.

methodpublicgetMaxResults() : int
inherited

Inherited from: + \Zend_Gdata_Query::getMaxResults()\Zend_Gdata_Gapps_Query::getMaxResults()
Returns
TypeDescription
intmaxResults
methodpublicgetMember() : string

Get the member email address to query for.

If no member is set, +null will be returned.

Returns
TypeDescription
stringThe member email address to filter search + results by, or null if disabled.
Details
See
\setMember +   +
methodpublicgetParam(string $name) : void
inherited

Inherited from: + \Zend_Gdata_Query::getParam()\Zend_Gdata_Gapps_Query::getParam()
Parameters
NameTypeDescription
$namestring
methodpublicgetPublishedMax() : string
inherited

Inherited from: + \Zend_Gdata_Query::getPublishedMax()\Zend_Gdata_Gapps_Query::getPublishedMax()
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
inherited

Inherited from: + \Zend_Gdata_Query::getPublishedMin()\Zend_Gdata_Gapps_Query::getPublishedMin()
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
inherited

Inherited from: + \Zend_Gdata_Query::getQuery()\Zend_Gdata_Gapps_Query::getQuery()
Returns
TypeDescription
stringquery
methodpublicgetQueryString() : string
inherited

Inherited from: + \Zend_Gdata_Query::getQueryString()\Zend_Gdata_Gapps_Query::getQueryString()
Returns
TypeDescription
stringquerystring
methodpublicgetQueryUrl() : string

Returns the query URL generated by this query instance.

Returns
TypeDescription
stringThe query URL for this instance.
methodpublicgetStartGroupId() : string

Get the first group id which should be displayed when retrieving +a list of groups.

Returns
TypeDescription
stringThe first group id to be returned, or null if + disabled.
Details
See
\setStartGroupId +   +
methodpublicgetStartIndex() : int
inherited

Inherited from: + \Zend_Gdata_Query::getStartIndex()\Zend_Gdata_Gapps_Query::getStartIndex()
Returns
TypeDescription
intstartIndex
methodpublicgetUpdatedMax() : string
inherited

Inherited from: + \Zend_Gdata_Query::getUpdatedMax()\Zend_Gdata_Gapps_Query::getUpdatedMax()
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
inherited

Inherited from: + \Zend_Gdata_Query::getUpdatedMin()\Zend_Gdata_Gapps_Query::getUpdatedMin()
Returns
TypeDescription
stringupdatedMin
methodpublicresetParameters() : void
inherited

Inherited from: + \Zend_Gdata_Query::resetParameters()\Zend_Gdata_Gapps_Query::resetParameters()
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setAlt()\Zend_Gdata_Gapps_Query::setAlt()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setAuthor()\Zend_Gdata_Gapps_Query::setAuthor()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setCategory()\Zend_Gdata_Gapps_Query::setCategory()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetDirectOnly(bool $value) : void

Sets the query parameter directOnly

Parameters
NameTypeDescription
$valuebool
methodpublicsetDomain(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
NameTypeDescription
$valuestring

The domain to be used for this session.

methodpublicsetGroupId(string $value) : void

Set the group id to query for.

When set, only groups with a group id +matching this value will be returned in search results. Set to +null to disable filtering by group id.

Parameters
NameTypeDescription
$valuestring

The group id to filter search results by, or null to + disable.

Details
See
\getGroupId +   +
methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setMaxResults()\Zend_Gdata_Gapps_Query::setMaxResults()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetMember(string $value) : void

Set the member to query for.

When set, only subscribers with an +email address matching this value will be returned in search results. +Set to null to disable filtering by username.

Parameters
NameTypeDescription
$valuestring

The member email address to filter search + results by, or null to disable.

methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setParam()\Zend_Gdata_Gapps_Query::setParam()
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setPublishedMax()\Zend_Gdata_Gapps_Query::setPublishedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setPublishedMin()\Zend_Gdata_Gapps_Query::setPublishedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setQuery()\Zend_Gdata_Gapps_Query::setQuery()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetStartGroupId(string $value) : void

Set the first group id which should be displayed when retrieving +a list of groups.

Parameters
NameTypeDescription
$valuestring

The first group id to be returned, or null to + disable.

methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setStartIndex()\Zend_Gdata_Gapps_Query::setStartIndex()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setUpdatedMax()\Zend_Gdata_Gapps_Query::setUpdatedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: + \Zend_Gdata_Query::setUpdatedMin()\Zend_Gdata_Gapps_Query::setUpdatedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
+ Documentation was generated by + phpDocumentor + 2.0.0a12. + -- cgit v1.2.3