Gdata/Gapps/UserQuery.php
inherited
+ Classes
+ 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: UserQuery.php 24593 2012-01-05 20:35:02Z matthew $ + +
\Zend_Gdata_Gapps_UserQuery
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 = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_category + +
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_category + +
string $_defaultFeedUri = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_defaultFeedUri + +
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_defaultFeedUri + +
string $_domain = nullnullDetails- 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 = nullnullDetails- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_url + +
- Inherited_from
- \Zend_Gdata_Gapps_Query::$$_url + +
string $_username = nullnullDetails- Type
- string
Methods
__construct(string $domain = null, string $username = null, string $startUsername = null) : voidCreate a new instance.
| Name | Type | Description |
|---|---|---|
| $domain | string | (optional) The Google Apps-hosted domain to use + when constructing query URIs. + |
| $username | string | (optional) Value for the username + property. + |
| $startUsername | string | (optional) Value for the + startUsername property. + |
__get( $name) : void| Name | Type | Description |
|---|---|---|
| $name |
__set( $name, $val) : void| Name | Type | Description |
|---|---|---|
| $name | ||
| $val |
getAlt() : string| Type | Description |
|---|---|
| string | rss or atom |
getAuthor() : string| Type | Description |
|---|---|
| string | author |
getBaseUrl(string $domain = null) : voidReturns 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 + +
getCategory() : voidgetDomain() : stringGet 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.
| Type | Description |
|---|---|
| string | The domain to be used for this session, or null if not + set. |
- See
- \setDomain + +
getMaxResults() : int| Type | Description |
|---|---|
| int | maxResults |
getParam(string $name) : void| Name | Type | Description |
|---|---|---|
| $name | string |
getPublishedMax() : string| Type | Description |
|---|---|
| string | publishedMax |
getPublishedMin() : string| Type | Description |
|---|---|
| string | publishedMin |
getQuery() : string| Type | Description |
|---|---|
| string | query |
getQueryString() : string| Type | Description |
|---|---|
| string | querystring |
getQueryUrl() : stringReturns the query URL generated by this query instance.
| Type | Description |
|---|---|
| string | The query URL for this instance. |
getStartIndex() : int| Type | Description |
|---|---|
| int | startIndex |
getStartUsername() : stringGet the first username which should be displayed when retrieving +a list of users.
| Type | Description |
|---|---|
| string | The first username to be returned, or null if + disabled. |
- See
- \setStartUsername + +
getUpdatedMax() : string| Type | Description |
|---|---|
| string | updatedMax |
getUpdatedMin() : string| Type | Description |
|---|---|
| string | updatedMin |
getUsername() : voidGet the username to query for.
If no username is set, null will be +returned.
resetParameters() : voidsetAlt(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) : voidSet 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.
| Name | Type | Description |
|---|---|---|
| $value | string | The domain to be used for this session. |
setMaxResults(int $value) : \Zend_Gdata_Query| Name | Type | Description |
|---|---|---|
| $value | int |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
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 |
setStartUsername(string $value) : voidSet the first username which should be displayed when retrieving +a list of users.
| Name | Type | Description |
|---|---|---|
| $value | string | The first username to be returned, or null to + disable. |
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 |
setUsername(string $value) : voidSet the username to query for.
When set, only users with a username +matching this value will be returned in search results. Set to +null to disable filtering by username.
| Name | Type | Description |
|---|---|---|
| $value | string | The username to filter search results by, or null to + disable. |
- See
- \getUsername + +