Gdata/Gapps/OwnerQuery.php
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
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
null
Details- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_category
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_category


string $_defaultFeedUri = null
null
Details- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_defaultFeedUri
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_defaultFeedUri


string $_domain = null
null
Details- Type
- string
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_domain


array $_params = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Gdata_Query::$$_params
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_params


string $_url = null
null
Details- 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.
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. |


getBaseUrl(string $domain = null) : void
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.
Name | Type | Description |
---|---|---|
$domain | string | (optional) A fully-qualified domain to use instead of the default domain for this service instance. |
- See
- \setDomain


getDomain() : string
This should be a fully qualified domain, such as 'foo.example.com'. If no domain is set, null will be returned.
Type | Description |
---|---|
string | The domain to be used for this session, or null if not set. |
- See
- \setDomain


getPublishedMax() : string
Type | Description |
---|---|
string | publishedMax |


getPublishedMin() : string
Type | Description |
---|---|
string | publishedMin |


getQueryString() : string
Type | Description |
---|---|
string | querystring |


getQueryUrl() : string
Returns the query URL generated by this query instance.
Type | Description |
---|---|
string | The query URL for this instance. |


resetParameters() : void


setAlt(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setAuthor(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setCategory(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setDomain(string $value) : void
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.
Name | Type | Description |
---|---|---|
$value | string | The domain to be used for this session. |


setGroupId(string $value) : void
Set the group id to query for.
Name | Type | Description |
---|---|---|
$value | string |
- See
- \getGroupId


setMaxResults(int $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setOwnerEmail(string $value) : void
Set the owner email to query for.
Name | Type | Description |
---|---|---|
$value | string |
- See
- \getOwnerEmail


setParam(string $name, string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$name | string | |
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setPublishedMax(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setPublishedMin(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setQuery(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setStartIndex(int $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setUpdatedMax(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setUpdatedMin(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |