[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/Gapps/ -> NicknameQuery.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 186 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Gdata_Gapps_NicknameQuery:: (8 methods):
  __construct()
  setNickname()
  getNickname()
  setUsername()
  getUsername()
  setStartNickname()
  getStartNickname()
  getQueryUrl()


Class: Zend_Gdata_Gapps_NicknameQuery  - X-Ref

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

__construct($domain = null, $nickname = null,$username = null, $startNickname = null)   X-Ref
Create a new instance.

param: string $domain (optional) The Google Apps-hosted domain to use
param: string $nickname (optional) Value for the nickname
param: string $username (optional) Value for the username
param: string $startNickname (optional) Value for the

setNickname($value)   X-Ref
Set the nickname to query for. When set, only users with a nickname
matching this value will be returned in search results. Set to
null to disable filtering by username.

param: string $value The nickname to filter search results by, or null

getNickname()   X-Ref
Get the nickname to query for. If no nickname is set, null will be
returned.

return: string The nickname to filter search results by, or null if

setUsername($value)   X-Ref
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.

param: string $value The username to filter search results by, or null

getUsername()   X-Ref
Get the username to query for. If no username is set, null will be
returned.

return: string The username to filter search results by, or null if

setStartNickname($value)   X-Ref
Set the first nickname which should be displayed when retrieving
a list of nicknames.

param: string $value The first nickname to be returned, or null to

getStartNickname()   X-Ref
Get the first nickname which should be displayed when retrieving
a list of nicknames.

return: string The first nickname to be returned, or null to

getQueryUrl()   X-Ref
Returns the URL generated for this query, based on it's current
parameters.

return: string A URL generated based on the state of this query.



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1