import v2.0.0.0_RC3 | 2012-07-01
https://github.com/lucanos/CommunityID -> http://www.itadmins.net/archives/357
This commit is contained in:
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: EmailListFeed.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: EmailListFeed.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -32,10 +32,10 @@ require_once 'Zend/Gdata/Feed.php';
|
||||
require_once 'Zend/Gdata/Gapps/EmailListEntry.php';
|
||||
|
||||
/**
|
||||
* Data model for a collection of Google Apps email list entries, usually
|
||||
* Data model for a collection of Google Apps email list entries, usually
|
||||
* provided by the Google Apps servers.
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
* Apps service class, Zend_Gdata_Gapps.
|
||||
*
|
||||
* @category Zend
|
||||
@ -46,8 +46,8 @@ require_once 'Zend/Gdata/Gapps/EmailListEntry.php';
|
||||
*/
|
||||
class Zend_Gdata_Gapps_EmailListFeed extends Zend_Gdata_Feed
|
||||
{
|
||||
|
||||
|
||||
protected $_entryClassName = 'Zend_Gdata_Gapps_EmailListEntry';
|
||||
protected $_feedClassName = 'Zend_Gdata_Gapps_EmailListFeed';
|
||||
|
||||
|
||||
}
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: EmailListQuery.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: EmailListQuery.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -27,13 +27,13 @@
|
||||
require_once('Zend/Gdata/Gapps/Query.php');
|
||||
|
||||
/**
|
||||
* Assists in constructing queries for Google Apps email list entries.
|
||||
* Instances of this class can be provided in many places where a URL is
|
||||
* Assists in constructing queries for Google Apps email list 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.
|
||||
*
|
||||
*
|
||||
* @category Zend
|
||||
* @package Zend_Gdata
|
||||
* @subpackage Gapps
|
||||
@ -44,26 +44,26 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
{
|
||||
|
||||
/**
|
||||
* A string which, if not null, indicates which email list should
|
||||
* A string which, if not null, indicates which email list should
|
||||
* be retrieved by this query.
|
||||
*
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $_emailListName = null;
|
||||
|
||||
/**
|
||||
* Create a new instance.
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
* when constructing query URIs.
|
||||
* @param string $emailListName (optional) Value for the emailListName
|
||||
* @param string $emailListName (optional) Value for the emailListName
|
||||
* property.
|
||||
* @param string $recipient (optional) Value for the recipient
|
||||
* @param string $recipient (optional) Value for the recipient
|
||||
* property.
|
||||
* @param string $startEmailListName (optional) Value for the
|
||||
* @param string $startEmailListName (optional) Value for the
|
||||
* startEmailListName property.
|
||||
*/
|
||||
public function __construct($domain = null, $emailListName = null,
|
||||
public function __construct($domain = null, $emailListName = null,
|
||||
$recipient = null, $startEmailListName = null)
|
||||
{
|
||||
parent::__construct($domain);
|
||||
@ -73,11 +73,11 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the email list name to query for. When set, only lists with a name
|
||||
* matching this value will be returned in search results. Set to
|
||||
* Set the email list name to query for. When set, only lists with a name
|
||||
* matching this value will be returned in search results. Set to
|
||||
* null to disable filtering by list name.
|
||||
*
|
||||
* @param string $value The email list name to filter search results by,
|
||||
*
|
||||
* @param string $value The email list name to filter search results by,
|
||||
* or null to disable.
|
||||
*/
|
||||
public function setEmailListName($value)
|
||||
@ -86,9 +86,9 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the email list name to query for. If no name is set, null will be
|
||||
* Get the email list name to query for. If no name is set, null will be
|
||||
* returned.
|
||||
*
|
||||
*
|
||||
* @see setEmailListName
|
||||
* @return string The email list name to filter search results by, or null
|
||||
* if disabled.
|
||||
@ -99,11 +99,11 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the recipient to query for. When set, only subscribers with an
|
||||
* email address matching this value will be returned in search results.
|
||||
* Set the recipient 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.
|
||||
*
|
||||
* @param string $value The recipient email address to filter search
|
||||
*
|
||||
* @param string $value The recipient email address to filter search
|
||||
* results by, or null to disable.
|
||||
*/
|
||||
public function setRecipient($value)
|
||||
@ -117,11 +117,11 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the recipient email address to query for. If no recipient is set,
|
||||
* Get the recipient email address to query for. If no recipient is set,
|
||||
* null will be returned.
|
||||
*
|
||||
*
|
||||
* @see setRecipient
|
||||
* @return string The recipient email address to filter search results by,
|
||||
* @return string The recipient email address to filter search results by,
|
||||
* or null if disabled.
|
||||
*/
|
||||
public function getRecipient()
|
||||
@ -134,10 +134,10 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the first email list which should be displayed when retrieving
|
||||
* Set the first email list which should be displayed when retrieving
|
||||
* a list of email lists.
|
||||
*
|
||||
* @param string $value The first email list to be returned, or null to
|
||||
*
|
||||
* @param string $value The first email list to be returned, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function setStartEmailListName($value)
|
||||
@ -150,10 +150,10 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the first email list which should be displayed when retrieving
|
||||
* Get the first email list which should be displayed when retrieving
|
||||
* a list of email lists.
|
||||
*
|
||||
* @return string The first email list to be returned, or null to
|
||||
*
|
||||
* @return string The first email list to be returned, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function getStartEmailListName()
|
||||
@ -166,15 +166,15 @@ class Zend_Gdata_Gapps_EmailListQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URL generated for this query, based on it's current
|
||||
* 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.
|
||||
* @throws Zend_Gdata_App_InvalidArgumentException
|
||||
*/
|
||||
public function getQueryUrl()
|
||||
{
|
||||
|
||||
|
||||
$uri = $this->getBaseUrl();
|
||||
$uri .= Zend_Gdata_Gapps::APPS_EMAIL_LIST_PATH;
|
||||
if ($this->_emailListName !== null) {
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: EmailListRecipientFeed.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: EmailListRecipientFeed.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -32,10 +32,10 @@ require_once 'Zend/Gdata/Feed.php';
|
||||
require_once 'Zend/Gdata/Gapps/EmailListRecipientEntry.php';
|
||||
|
||||
/**
|
||||
* Data model for a collection of Google Apps email list recipient entries,
|
||||
* Data model for a collection of Google Apps email list recipient entries,
|
||||
* usually provided by the Google Apps servers.
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
* Apps service class, Zend_Gdata_Gapps.
|
||||
*
|
||||
* @category Zend
|
||||
@ -46,8 +46,8 @@ require_once 'Zend/Gdata/Gapps/EmailListRecipientEntry.php';
|
||||
*/
|
||||
class Zend_Gdata_Gapps_EmailListRecipientFeed extends Zend_Gdata_Feed
|
||||
{
|
||||
|
||||
|
||||
protected $_entryClassName = 'Zend_Gdata_Gapps_EmailListRecipientEntry';
|
||||
protected $_feedClassName = 'Zend_Gdata_Gapps_EmailListRecipientFeed';
|
||||
|
||||
|
||||
}
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: EmailListRecipientQuery.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: EmailListRecipientQuery.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -27,13 +27,13 @@
|
||||
require_once('Zend/Gdata/Gapps/Query.php');
|
||||
|
||||
/**
|
||||
* Assists in constructing queries for Google Apps email list recipient
|
||||
* entries. Instances of this class can be provided in many places where a
|
||||
* Assists in constructing queries for Google Apps email list recipient
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @category Zend
|
||||
* @package Zend_Gdata
|
||||
* @subpackage Gapps
|
||||
@ -42,23 +42,23 @@ require_once('Zend/Gdata/Gapps/Query.php');
|
||||
*/
|
||||
class Zend_Gdata_Gapps_EmailListRecipientQuery extends Zend_Gdata_Gapps_Query
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* If not null, specifies the name of the email list which
|
||||
* If not null, specifies the name of the email list which
|
||||
* should be requested by this query.
|
||||
*
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $_emailListName = null;
|
||||
|
||||
/**
|
||||
* Create a new instance.
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
* when constructing query URIs.
|
||||
* @param string $emailListName (optional) Value for the emailListName
|
||||
* @param string $emailListName (optional) Value for the emailListName
|
||||
* property.
|
||||
* @param string $startRecipient (optional) Value for the
|
||||
* @param string $startRecipient (optional) Value for the
|
||||
* startRecipient property.
|
||||
*/
|
||||
public function __construct($domain = null, $emailListName = null,
|
||||
@ -68,13 +68,13 @@ class Zend_Gdata_Gapps_EmailListRecipientQuery extends Zend_Gdata_Gapps_Query
|
||||
$this->setEmailListName($emailListName);
|
||||
$this->setStartRecipient($startRecipient);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the email list name to query for. When set, only lists with a name
|
||||
* matching this value will be returned in search results. Set to
|
||||
* Set the email list name to query for. When set, only lists with a name
|
||||
* matching this value will be returned in search results. Set to
|
||||
* null to disable filtering by list name.
|
||||
*
|
||||
* @param string $value The email list name to filter search results by,
|
||||
*
|
||||
* @param string $value The email list name to filter search results by,
|
||||
* or null to disable.
|
||||
*/
|
||||
public function setEmailListName($value)
|
||||
@ -83,10 +83,10 @@ class Zend_Gdata_Gapps_EmailListRecipientQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the email list name to query for. If no name is set, null will be
|
||||
* Get the email list name to query for. If no name is set, null will be
|
||||
* returned.
|
||||
*
|
||||
* @param string $value The email list name to filter search results by,
|
||||
*
|
||||
* @param string $value The email list name to filter search results by,
|
||||
* or null if disabled.
|
||||
*/
|
||||
public function getEmailListName()
|
||||
@ -95,10 +95,10 @@ class Zend_Gdata_Gapps_EmailListRecipientQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the first recipient which should be displayed when retrieving
|
||||
* Set the first recipient which should be displayed when retrieving
|
||||
* a list of email list recipients.
|
||||
*
|
||||
* @param string $value The first recipient to be returned, or null to
|
||||
*
|
||||
* @param string $value The first recipient to be returned, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function setStartRecipient($value)
|
||||
@ -111,10 +111,10 @@ class Zend_Gdata_Gapps_EmailListRecipientQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the first recipient which should be displayed when retrieving
|
||||
* Get the first recipient which should be displayed when retrieving
|
||||
* a list of email list recipients.
|
||||
*
|
||||
* @return string The first recipient to be returned, or null if
|
||||
*
|
||||
* @return string The first recipient to be returned, or null if
|
||||
* disabled.
|
||||
*/
|
||||
public function getStartRecipient()
|
||||
@ -127,15 +127,15 @@ class Zend_Gdata_Gapps_EmailListRecipientQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URL generated for this query, based on it's current
|
||||
* 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.
|
||||
* @throws Zend_Gdata_App_InvalidArgumentException
|
||||
*/
|
||||
public function getQueryUrl()
|
||||
{
|
||||
|
||||
|
||||
$uri = $this->getBaseUrl();
|
||||
$uri .= Zend_Gdata_Gapps::APPS_EMAIL_LIST_PATH;
|
||||
if ($this->_emailListName !== null) {
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: Error.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: Error.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
|
||||
@ -28,12 +28,12 @@
|
||||
require_once 'Zend/Gdata/App/Base.php';
|
||||
|
||||
/**
|
||||
* Gdata Gapps Error class. This class is used to represent errors returned
|
||||
* within an AppsForYourDomainErrors message received from the Google Apps
|
||||
* Gdata Gapps Error class. This class is used to represent errors returned
|
||||
* within an AppsForYourDomainErrors message received from the Google Apps
|
||||
* servers.
|
||||
*
|
||||
* Several different errors may be represented by this class, determined by
|
||||
* the error code returned by the server. For a list of error codes
|
||||
* Several different errors may be represented by this class, determined by
|
||||
* the error code returned by the server. For a list of error codes
|
||||
* available at the time of this writing, see getErrorCode.
|
||||
*
|
||||
* @category Zend
|
||||
@ -44,10 +44,10 @@ require_once 'Zend/Gdata/App/Base.php';
|
||||
*/
|
||||
class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
{
|
||||
|
||||
// Error codes as defined at
|
||||
|
||||
// Error codes as defined at
|
||||
// http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html#appendix_d
|
||||
|
||||
|
||||
const UNKNOWN_ERROR = 1000;
|
||||
const USER_DELETED_RECENTLY = 1100;
|
||||
const USER_SUSPENDED = 1101;
|
||||
@ -68,34 +68,34 @@ class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
const INVALID_EMAIL_ADDRESS = 1406;
|
||||
const INVALID_QUERY_PARAMETER_VALUE = 1407;
|
||||
const TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = 1500;
|
||||
|
||||
|
||||
protected $_errorCode = null;
|
||||
protected $_reason = null;
|
||||
protected $_invalidInput = null;
|
||||
|
||||
public function __construct($errorCode = null, $reason = null,
|
||||
|
||||
public function __construct($errorCode = null, $reason = null,
|
||||
$invalidInput = null) {
|
||||
parent::__construct("Google Apps error received: $errorCode ($reason)");
|
||||
$this->_errorCode = $errorCode;
|
||||
$this->_reason = $reason;
|
||||
$this->_invalidInput = $invalidInput;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the error code for this exception. For more information about
|
||||
* Set the error code for this exception. For more information about
|
||||
* error codes, see getErrorCode.
|
||||
*
|
||||
*
|
||||
* @see getErrorCode
|
||||
* @param integer $value The new value for the error code.
|
||||
*/
|
||||
public function setErrorCode($value) {
|
||||
$this->_errorCode = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the error code for this exception. Currently valid values are
|
||||
|
||||
/**
|
||||
* Get the error code for this exception. Currently valid values are
|
||||
* available as constants within this class. These values are:
|
||||
*
|
||||
*
|
||||
* UNKNOWN_ERROR (1000)
|
||||
* USER_DELETED_RECENTLY (1100)
|
||||
* USER_SUSPENDED (1101)
|
||||
@ -116,14 +116,14 @@ class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
* INVALID_EMAIL_ADDRESS (1406)
|
||||
* INVALID_QUERY_PARAMETER_VALUE (1407)
|
||||
* TOO_MANY_RECIPIENTS_ON_EMAIL_LIST (1500)
|
||||
*
|
||||
* Numbers in parenthesis indicate the actual integer value of the
|
||||
* constant. This list should not be treated as exhaustive, as additional
|
||||
*
|
||||
* Numbers in parenthesis indicate the actual integer value of the
|
||||
* constant. This list should not be treated as exhaustive, as additional
|
||||
* error codes may be added at any time.
|
||||
*
|
||||
* For more information about these codes and their meaning, please
|
||||
*
|
||||
* For more information about these codes and their meaning, please
|
||||
* see Appendix D of the Google Apps Provisioning API Reference.
|
||||
*
|
||||
*
|
||||
* @link http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html#appendix_d Google Apps Provisioning API Reference: Appendix D - Gdata Error Codes
|
||||
* @see setErrorCode
|
||||
* @return integer The error code returned by the Google Apps server.
|
||||
@ -131,20 +131,20 @@ class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
public function getErrorCode() {
|
||||
return $this->_errorCode;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set human-readable text describing the reason this exception occurred.
|
||||
*
|
||||
*
|
||||
* @see getReason
|
||||
* @param string $value The reason this exception occurred.
|
||||
*/
|
||||
public function setReason($value) {
|
||||
$this->_reason = $value;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get human-readable text describing the reason this exception occurred.
|
||||
*
|
||||
*
|
||||
* @see setReason
|
||||
* @return string The reason this exception occurred.
|
||||
*/
|
||||
@ -154,24 +154,24 @@ class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
|
||||
/**
|
||||
* Set the invalid input which caused this exception.
|
||||
*
|
||||
*
|
||||
* @see getInvalidInput
|
||||
* @param string $value The invalid input that triggered this exception.
|
||||
*/
|
||||
public function setInvalidInput($value) {
|
||||
$this->_invalidInput = $value;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the invalid input which caused this exception.
|
||||
*
|
||||
*
|
||||
* @see setInvalidInput
|
||||
* @return string The reason this exception occurred.
|
||||
*/
|
||||
public function getInvalidInput() {
|
||||
return $this->_invalidInput;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Retrieves a DOMElement which corresponds to this element and all
|
||||
* child properties. This is used to build an entry back into a DOM
|
||||
@ -195,7 +195,7 @@ class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
}
|
||||
return $element;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Given a DOMNode representing an attribute, tries to map the data into
|
||||
* instance members. If no mapping is defined, the name and value are
|
||||
@ -219,10 +219,10 @@ class Zend_Gdata_Gapps_Error extends Zend_Gdata_App_Base
|
||||
parent::takeAttributeFromDOM($attribute);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get a human readable version of this exception.
|
||||
*
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString() {
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: NicknameFeed.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: NicknameFeed.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -32,10 +32,10 @@ require_once 'Zend/Gdata/Feed.php';
|
||||
require_once 'Zend/Gdata/Gapps/NicknameEntry.php';
|
||||
|
||||
/**
|
||||
* Data model for a collection of Google Apps nickname entries, usually
|
||||
* Data model for a collection of Google Apps nickname entries, usually
|
||||
* provided by the Google Apps servers.
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
* Apps service class, Zend_Gdata_Gapps.
|
||||
*
|
||||
* @category Zend
|
||||
@ -46,8 +46,8 @@ require_once 'Zend/Gdata/Gapps/NicknameEntry.php';
|
||||
*/
|
||||
class Zend_Gdata_Gapps_NicknameFeed extends Zend_Gdata_Feed
|
||||
{
|
||||
|
||||
|
||||
protected $_entryClassName = 'Zend_Gdata_Gapps_NicknameEntry';
|
||||
protected $_feedClassName = 'Zend_Gdata_Gapps_NicknameFeed';
|
||||
|
||||
|
||||
}
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: NicknameQuery.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: NicknameQuery.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -27,13 +27,13 @@
|
||||
require_once('Zend/Gdata/Gapps/Query.php');
|
||||
|
||||
/**
|
||||
* Assists in constructing queries for Google Apps nickname entries.
|
||||
* Instances of this class can be provided in many places where a URL is
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @category Zend
|
||||
* @package Zend_Gdata
|
||||
* @subpackage Gapps
|
||||
@ -44,26 +44,26 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
{
|
||||
|
||||
/**
|
||||
* If not null, indicates the name of the nickname entry which
|
||||
* If not null, indicates the name of the nickname entry which
|
||||
* should be returned by this query.
|
||||
*
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $_nickname = null;
|
||||
|
||||
/**
|
||||
* Create a new instance.
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
* when constructing query URIs.
|
||||
* @param string $nickname (optional) Value for the nickname
|
||||
* @param string $nickname (optional) Value for the nickname
|
||||
* property.
|
||||
* @param string $username (optional) Value for the username
|
||||
* @param string $username (optional) Value for the username
|
||||
* property.
|
||||
* @param string $startNickname (optional) Value for the
|
||||
* @param string $startNickname (optional) Value for the
|
||||
* startNickname property.
|
||||
*/
|
||||
public function __construct($domain = null, $nickname = null,
|
||||
public function __construct($domain = null, $nickname = null,
|
||||
$username = null, $startNickname = null)
|
||||
{
|
||||
parent::__construct($domain);
|
||||
@ -73,11 +73,11 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the nickname to query for. When set, only users with a nickname
|
||||
* matching this value will be returned in search results. Set to
|
||||
* 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
|
||||
*
|
||||
* @param string $value The nickname to filter search results by, or null
|
||||
* to disable.
|
||||
*/
|
||||
public function setNickname($value)
|
||||
@ -86,11 +86,11 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the nickname to query for. If no nickname is set, null will be
|
||||
* Get the nickname to query for. If no nickname is set, null will be
|
||||
* returned.
|
||||
*
|
||||
*
|
||||
* @see setNickname
|
||||
* @return string The nickname to filter search results by, or null if
|
||||
* @return string The nickname to filter search results by, or null if
|
||||
* disabled.
|
||||
*/
|
||||
public function getNickname()
|
||||
@ -99,11 +99,11 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the username to query for. When set, only users with a username
|
||||
* matching this value will be returned in search results. Set to
|
||||
* 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
|
||||
*
|
||||
* @param string $value The username to filter search results by, or null
|
||||
* to disable.
|
||||
*/
|
||||
public function setUsername($value)
|
||||
@ -117,11 +117,11 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the username to query for. If no username is set, null will be
|
||||
* Get the username to query for. If no username is set, null will be
|
||||
* returned.
|
||||
*
|
||||
*
|
||||
* @see setUsername
|
||||
* @return string The username to filter search results by, or null if
|
||||
* @return string The username to filter search results by, or null if
|
||||
* disabled.
|
||||
*/
|
||||
public function getUsername()
|
||||
@ -134,10 +134,10 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the first nickname which should be displayed when retrieving
|
||||
* 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
|
||||
*
|
||||
* @param string $value The first nickname to be returned, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function setStartNickname($value)
|
||||
@ -150,10 +150,10 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the first nickname which should be displayed when retrieving
|
||||
* 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
|
||||
*
|
||||
* @return string The first nickname to be returned, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function getStartNickname()
|
||||
@ -166,14 +166,14 @@ class Zend_Gdata_Gapps_NicknameQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URL generated for this query, based on it's current
|
||||
* 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.
|
||||
*/
|
||||
public function getQueryUrl()
|
||||
{
|
||||
|
||||
|
||||
$uri = $this->getBaseUrl();
|
||||
$uri .= Zend_Gdata_Gapps::APPS_NICKNAME_PATH;
|
||||
if ($this->_nickname !== null) {
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: Query.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: Query.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -32,12 +32,12 @@ require_once('Zend/Gdata/Query.php');
|
||||
require_once('Zend/Gdata/Gapps.php');
|
||||
|
||||
/**
|
||||
* Assists in constructing queries for Google Apps entries. This class
|
||||
* Assists in constructing queries for Google Apps entries. This class
|
||||
* provides common methods used by all other Google Apps query classes.
|
||||
*
|
||||
* This class should never be instantiated directly. Instead, instantiate a
|
||||
* This class should never be instantiated directly. Instead, instantiate a
|
||||
* class which inherits from this class.
|
||||
*
|
||||
*
|
||||
* @category Zend
|
||||
* @package Zend_Gdata
|
||||
* @subpackage Gapps
|
||||
@ -46,18 +46,18 @@ require_once('Zend/Gdata/Gapps.php');
|
||||
*/
|
||||
abstract class Zend_Gdata_Gapps_Query extends Zend_Gdata_Query
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* The domain which is being administered via the Provisioning API.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $_domain = null;
|
||||
|
||||
|
||||
/**
|
||||
* Create a new instance.
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
* when constructing query URIs.
|
||||
*/
|
||||
public function __construct($domain = null)
|
||||
@ -65,16 +65,16 @@ abstract class Zend_Gdata_Gapps_Query extends Zend_Gdata_Query
|
||||
parent::__construct();
|
||||
$this->_domain = $domain;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set domain for this service instance. This should be a fully qualified
|
||||
* Set domain for this service instance. 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
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @param string $value The domain to be used for this session.
|
||||
*/
|
||||
public function setDomain($value)
|
||||
@ -83,26 +83,26 @@ abstract class Zend_Gdata_Gapps_Query extends Zend_Gdata_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @see setDomain
|
||||
* @return string The domain to be used for this session, or null if not
|
||||
* @return string The domain to be used for this session, or null if not
|
||||
* set.
|
||||
*/
|
||||
public function getDomain()
|
||||
{
|
||||
return $this->_domain;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns the base URL used to access the Google Apps service, based
|
||||
* on the current domain. The current domain can be temporarily
|
||||
* 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.
|
||||
*
|
||||
* @see setDomain
|
||||
* @param string $domain (optional) A fully-qualified domain to use
|
||||
* @param string $domain (optional) A fully-qualified domain to use
|
||||
* instead of the default domain for this service instance.
|
||||
*/
|
||||
public function getBaseUrl($domain = null)
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: ServiceException.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: ServiceException.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
|
||||
@ -33,11 +33,11 @@ require_once 'Zend/Exception.php';
|
||||
require_once 'Zend/Gdata/Gapps/Error.php';
|
||||
|
||||
/**
|
||||
* Gdata Gapps Exception class. This is thrown when an
|
||||
* AppsForYourDomainErrors message is received from the Google Apps
|
||||
* Gdata Gapps Exception class. This is thrown when an
|
||||
* AppsForYourDomainErrors message is received from the Google Apps
|
||||
* servers.
|
||||
*
|
||||
* Several different errors may be represented by this exception. For a list
|
||||
* Several different errors may be represented by this exception. For a list
|
||||
* of error codes available, see getErrorCode.
|
||||
*
|
||||
* @category Zend
|
||||
@ -48,20 +48,20 @@ require_once 'Zend/Gdata/Gapps/Error.php';
|
||||
*/
|
||||
class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
{
|
||||
|
||||
|
||||
protected $_rootElement = "AppsForYourDomainErrors";
|
||||
|
||||
/**
|
||||
|
||||
/**
|
||||
* Array of Zend_Gdata_Error objects indexed by error code.
|
||||
*
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $_errors = array();
|
||||
|
||||
|
||||
/**
|
||||
* Create a new ServiceException.
|
||||
*
|
||||
* @return array An array containing a collection of
|
||||
* @return array An array containing a collection of
|
||||
* Zend_Gdata_Gapps_Error objects.
|
||||
*/
|
||||
public function __construct($errors = null) {
|
||||
@ -70,32 +70,32 @@ class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
$this->setErrors($errors);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Add a single Error object to the list of errors received by the
|
||||
* Add a single Error object to the list of errors received by the
|
||||
* server.
|
||||
*
|
||||
* @param Zend_Gdata_Gapps_Error $error An instance of an error returned
|
||||
*
|
||||
* @param Zend_Gdata_Gapps_Error $error An instance of an error returned
|
||||
* by the server. The error's errorCode must be set.
|
||||
* @throws Zend_Gdata_App_Exception
|
||||
*/
|
||||
public function addError($error) {
|
||||
// Make sure that we don't try to index an error that doesn't
|
||||
// Make sure that we don't try to index an error that doesn't
|
||||
// contain an index value.
|
||||
if ($error->getErrorCode() == null) {
|
||||
require_once 'Zend/Gdata/App/Exception.php';
|
||||
throw new Zend_Gdata_App_Exception("Error encountered without corresponding error code.");
|
||||
}
|
||||
|
||||
|
||||
$this->_errors[$error->getErrorCode()] = $error;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Set the list of errors as sent by the server inside of an
|
||||
* Set the list of errors as sent by the server inside of an
|
||||
* AppsForYourDomainErrors tag.
|
||||
*
|
||||
* @param array $array An associative array containing a collection of
|
||||
* Zend_Gdata_Gapps_Error objects. All errors must have their
|
||||
*
|
||||
* @param array $array An associative array containing a collection of
|
||||
* Zend_Gdata_Gapps_Error objects. All errors must have their
|
||||
* errorCode value set.
|
||||
* @throws Zend_Gdata_App_Exception
|
||||
*/
|
||||
@ -105,22 +105,22 @@ class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
$this->addError($error);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get the list of errors as sent by the server inside of an
|
||||
* Get the list of errors as sent by the server inside of an
|
||||
* AppsForYourDomainErrors tag.
|
||||
*
|
||||
* @return array An associative array containing a collection of
|
||||
*
|
||||
* @return array An associative array containing a collection of
|
||||
* Zend_Gdata_Gapps_Error objects, indexed by error code.
|
||||
*/
|
||||
public function getErrors() {
|
||||
return $this->_errors;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Return the Error object associated with a specific error code.
|
||||
*
|
||||
* @return Zend_Gdata_Gapps_Error The Error object requested, or null
|
||||
* @return Zend_Gdata_Gapps_Error The Error object requested, or null
|
||||
* if not found.
|
||||
*/
|
||||
public function getError($errorCode) {
|
||||
@ -131,22 +131,22 @@ class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Check whether or not a particular error code was returned by the
|
||||
* Check whether or not a particular error code was returned by the
|
||||
* server.
|
||||
*
|
||||
* @param integer $errorCode The error code to check against.
|
||||
* @return boolean Whether or not the supplied error code was returned
|
||||
* @return boolean Whether or not the supplied error code was returned
|
||||
* by the server.
|
||||
*/
|
||||
public function hasError($errorCode) {
|
||||
return array_key_exists($errorCode, $this->_errors);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Import an AppsForYourDomain error from XML.
|
||||
*
|
||||
*
|
||||
* @param string $string The XML data to be imported
|
||||
* @return Zend_Gdata_Gapps_ServiceException Provides a fluent interface.
|
||||
* @throws Zend_Gdata_App_Exception
|
||||
@ -155,21 +155,21 @@ class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
if ($string) {
|
||||
// Check to see if an AppsForYourDomainError exists
|
||||
//
|
||||
// track_errors is temporarily enabled so that if an error
|
||||
// occurs while parsing the XML we can append it to an
|
||||
// track_errors is temporarily enabled so that if an error
|
||||
// occurs while parsing the XML we can append it to an
|
||||
// exception by referencing $php_errormsg
|
||||
@ini_set('track_errors', 1);
|
||||
$doc = new DOMDocument();
|
||||
$success = @$doc->loadXML($string);
|
||||
@ini_restore('track_errors');
|
||||
|
||||
|
||||
if (!$success) {
|
||||
require_once 'Zend/Gdata/App/Exception.php';
|
||||
// $php_errormsg is automatically generated by PHP if
|
||||
// $php_errormsg is automatically generated by PHP if
|
||||
// an error occurs while calling loadXML(), above.
|
||||
throw new Zend_Gdata_App_Exception("DOMDocument cannot parse XML: $php_errormsg");
|
||||
}
|
||||
|
||||
|
||||
// Ensure that the outermost node is an AppsForYourDomain error.
|
||||
// If it isn't, something has gone horribly wrong.
|
||||
$rootElement = $doc->getElementsByTagName($this->_rootElement)->item(0);
|
||||
@ -177,7 +177,7 @@ class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
require_once 'Zend/Gdata/App/Exception.php';
|
||||
throw new Zend_Gdata_App_Exception('No root <' . $this->_rootElement . '> element found, cannot parse feed.');
|
||||
}
|
||||
|
||||
|
||||
foreach ($rootElement->childNodes as $errorNode) {
|
||||
if (!($errorNode instanceof DOMText)) {
|
||||
$error = new Zend_Gdata_Gapps_Error();
|
||||
@ -190,12 +190,12 @@ class Zend_Gdata_Gapps_ServiceException extends Zend_Exception
|
||||
require_once 'Zend/Gdata/App/Exception.php';
|
||||
throw new Zend_Gdata_App_Exception('XML passed to transferFromXML cannot be null');
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get a human readable version of this exception.
|
||||
*
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString() {
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: UserFeed.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: UserFeed.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -32,10 +32,10 @@ require_once 'Zend/Gdata/Feed.php';
|
||||
require_once 'Zend/Gdata/Gapps/UserEntry.php';
|
||||
|
||||
/**
|
||||
* Data model for a collection of Google Apps user entries, usually
|
||||
* Data model for a collection of Google Apps user entries, usually
|
||||
* provided by the Google Apps servers.
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
*
|
||||
* For information on requesting this feed from a server, see the Google
|
||||
* Apps service class, Zend_Gdata_Gapps.
|
||||
*
|
||||
* @category Zend
|
||||
@ -46,8 +46,8 @@ require_once 'Zend/Gdata/Gapps/UserEntry.php';
|
||||
*/
|
||||
class Zend_Gdata_Gapps_UserFeed extends Zend_Gdata_Feed
|
||||
{
|
||||
|
||||
|
||||
protected $_entryClassName = 'Zend_Gdata_Gapps_UserEntry';
|
||||
protected $_feedClassName = 'Zend_Gdata_Gapps_UserFeed';
|
||||
|
||||
|
||||
}
|
||||
|
@ -18,7 +18,7 @@
|
||||
* @subpackage Gapps
|
||||
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
||||
* @license http://framework.zend.com/license/new-bsd New BSD License
|
||||
* @version $Id: UserQuery.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
||||
* @version $Id: UserQuery.php 18951 2009-11-12 16:26:19Z alexander $
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -27,13 +27,13 @@
|
||||
require_once('Zend/Gdata/Gapps/Query.php');
|
||||
|
||||
/**
|
||||
* Assists in constructing queries for Google Apps user entries.
|
||||
* Instances of this class can be provided in many places where a URL is
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @category Zend
|
||||
* @package Zend_Gdata
|
||||
* @subpackage Gapps
|
||||
@ -44,24 +44,24 @@ class Zend_Gdata_Gapps_UserQuery extends Zend_Gdata_Gapps_Query
|
||||
{
|
||||
|
||||
/**
|
||||
* If not null, specifies the username of the user who should be
|
||||
* If not null, specifies the username of the user who should be
|
||||
* retrieved by this query.
|
||||
*
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $_username = null;
|
||||
|
||||
/**
|
||||
* Create a new instance.
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
*
|
||||
* @param string $domain (optional) The Google Apps-hosted domain to use
|
||||
* when constructing query URIs.
|
||||
* @param string $username (optional) Value for the username
|
||||
* @param string $username (optional) Value for the username
|
||||
* property.
|
||||
* @param string $startUsername (optional) Value for the
|
||||
* @param string $startUsername (optional) Value for the
|
||||
* startUsername property.
|
||||
*/
|
||||
public function __construct($domain = null, $username = null,
|
||||
public function __construct($domain = null, $username = null,
|
||||
$startUsername = null)
|
||||
{
|
||||
parent::__construct($domain);
|
||||
@ -70,12 +70,12 @@ class Zend_Gdata_Gapps_UserQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the username to query for. When set, only users with a username
|
||||
* matching this value will be returned in search results. Set to
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* @see getUsername
|
||||
* @param string $value The username to filter search results by, or null to
|
||||
* @param string $value The username to filter search results by, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function setUsername($value)
|
||||
@ -84,10 +84,10 @@ class Zend_Gdata_Gapps_UserQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the username to query for. If no username is set, null will be
|
||||
* Get the username to query for. If no username is set, null will be
|
||||
* returned.
|
||||
*
|
||||
* @param string $value The username to filter search results by, or
|
||||
*
|
||||
* @param string $value The username to filter search results by, or
|
||||
* null if disabled.
|
||||
*/
|
||||
public function getUsername()
|
||||
@ -96,10 +96,10 @@ class Zend_Gdata_Gapps_UserQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the first username which should be displayed when retrieving
|
||||
* Set the first username which should be displayed when retrieving
|
||||
* a list of users.
|
||||
*
|
||||
* @param string $value The first username to be returned, or null to
|
||||
*
|
||||
* @param string $value The first username to be returned, or null to
|
||||
* disable.
|
||||
*/
|
||||
public function setStartUsername($value)
|
||||
@ -112,11 +112,11 @@ class Zend_Gdata_Gapps_UserQuery extends Zend_Gdata_Gapps_Query
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the first username which should be displayed when retrieving
|
||||
* Get the first username which should be displayed when retrieving
|
||||
* a list of users.
|
||||
*
|
||||
*
|
||||
* @see setStartUsername
|
||||
* @return string The first username to be returned, or null if
|
||||
* @return string The first username to be returned, or null if
|
||||
* disabled.
|
||||
*/
|
||||
public function getStartUsername()
|
||||
@ -130,7 +130,7 @@ class Zend_Gdata_Gapps_UserQuery extends Zend_Gdata_Gapps_Query
|
||||
|
||||
/**
|
||||
* Returns the query URL generated by this query instance.
|
||||
*
|
||||
*
|
||||
* @return string The query URL for this instance.
|
||||
*/
|
||||
public function getQueryUrl()
|
||||
|
Reference in New Issue
Block a user