API Documentation

Gdata/Gapps/UserQuery.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
version
$Id: UserQuery.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Gapps_UserQuery

Description

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.

Zend_Gdata_Gapps_UserQuery
jump to top

Extends from
Zend_Gdata_Gapps_Query
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
Properties
$_username
Methods
__construct
setUsername
getUsername
setStartUsername
getStartUsername
getQueryUrl

Description

Assists in constructing queries for Google Apps user 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.

Properties

$_username
jump to class

string $_username = 'null'

If not null, specifies the username of the user who should be retrieved by this query.

Details

$_username
string
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( string $domain = null, string $username = null, string $startUsername = null ) :

Create a new instance.

Arguments
$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.
Details
visibility
public
final
false
static
false

getQueryUrl
jump to class

getQueryUrl( ) : string

Returns the query URL generated by this query instance.

Output
string
The query URL for this instance.
Details
visibility
public
final
false
static
false

getStartUsername
jump to class

getStartUsername( ) : string

Get the first username which should be displayed when retrieving a list of users.

Output
string
The first username to be returned, or null if disabled.
Details
visibility
public
final
false
static
false
see
setStartUsername

getUsername
jump to class

getUsername( ) :

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

Details
visibility
public
final
false
static
false

setStartUsername
jump to class

setStartUsername( string $value ) :

Set the first username which should be displayed when retrieving a list of users.

Arguments
$value
string
The first username to be returned, or null to disable.
Details
visibility
public
final
false
static
false

setUsername
jump to class

setUsername( string $value ) :

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

Arguments
$value
string
The username to filter search results by, or null to disable.
Details
visibility
public
final
false
static
false
see
getUsername
Documentation was generated by DocBlox.