## API Documentation

# Gdata/Gapps/GroupQuery.php

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-2011 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

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.

Extends from
  \Zend_Gdata_Gapps_Query
category
  Zend
copyright
  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
package
  Zend_Gdata
subpackage
  Gapps

### Properties

`string $_groupId= 'null'`

If not null, specifies the group id of the group who should be retrieved by this query.

Default value `null` Details

Type
  string

### Methods

`__construct( string $domain = null, string $groupId = null, $startGroupId = 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.
$startGroupId |  |

`__get( $name ) : void`

Inherited from: \Zend_Gdata_Query::__get()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`__set( $name, $val ) : void`

Inherited from: \Zend_Gdata_Query::__set()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |
$val |  |

`getAlt( ) : string`

Inherited from: \Zend_Gdata_Query::getAlt()
Returns

Type | Description
--- | ---
string | rss or atom

`getAuthor( ) : string`

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns

Type | Description
--- | ---
string | author

`getBaseUrl( string $domain = null ) : void`

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.

Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()
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 from: \Zend_Gdata_Query::getCategory()
`getDirectOnly( ) : bool`

Returns

Type | Description
--- | ---
bool |

Details

see
  \setDirectOnly

`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.

Inherited from: \Zend_Gdata_Gapps_Query::getDomain()
Returns

Type | Description
--- | ---
string | The domain to be used for this session, or null if not set.

Details

see
  \setDomain

`getGroupId( ) : void`

Get the group id to query for. If no group id is set, null will be returned.

`getMaxResults( ) : int`

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns

Type | Description
--- | ---
int | maxResults

`getMember( ) : string`

Get the member email address to query for. If no member is set, null will be returned.

Returns

Type | Description
--- | ---
string | The member email address to filter search results by, or null if disabled.

Details

see
  \setMember

`getParam( string $name ) : void`

Inherited from: \Zend_Gdata_Query::getParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`getPublishedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns

Type | Description
--- | ---
string | publishedMax

`getPublishedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns

Type | Description
--- | ---
string | publishedMin

`getQuery( ) : string`

Inherited from: \Zend_Gdata_Query::getQuery()
Returns

Type | Description
--- | ---
string | query

`getQueryString( ) : string`

Inherited from: \Zend_Gdata_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.

`getStartGroupId( ) : string`

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

Returns

Type | Description
--- | ---
string | The first group id to be returned, or null if disabled.

Details

see
  \setStartGroupId

`getStartIndex( ) : int`

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns

Type | Description
--- | ---
int | startIndex

`getUpdatedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns

Type | Description
--- | ---
string | updatedMax

`getUpdatedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns

Type | Description
--- | ---
string | updatedMin

`resetParameters( ) : void`

Inherited from: \Zend_Gdata_Query::resetParameters()
`setAlt( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_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 from: \Zend_Gdata_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 from: \Zend_Gdata_Query::setCategory()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setDirectOnly( bool $value ) : void`

Sets the query parameter directOnly

Parameters

Name | Type | Description
--- | --- | ---
$value | bool |

`setDomain( string $value ) : void`

Set domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'.

Inherited from: \Zend_Gdata_Gapps_Query::setDomain()

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. 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

Name | Type | Description
--- | --- | ---
$value | string | The group id to filter search results by, or null to disable.

Details

see
  \getGroupId

`setMaxResults( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setMember( 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

Name | Type | Description
--- | --- | ---
$value | string | The member email address to filter search results by, or null to disable.

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

Inherited from: \Zend_Gdata_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 from: \Zend_Gdata_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 from: \Zend_Gdata_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 from: \Zend_Gdata_Query::setQuery()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setStartGroupId( string $value ) : void`

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

Parameters

Name | Type | Description
--- | --- | ---
$value | string | The first group id to be returned, or null to disable.

`setStartIndex( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_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 from: \Zend_Gdata_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 from: \Zend_Gdata_Query::setUpdatedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

Documentation was generated by DocBlox 0.13.3.