195 lines
5.3 KiB
PHP
195 lines
5.3 KiB
PHP
<?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
|
|
* @package Zend_Gdata
|
|
* @subpackage Gapps
|
|
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
* @version $Id:$
|
|
*/
|
|
|
|
/**
|
|
* @see Zend_Gdata_Gapps_Query
|
|
*/
|
|
require_once('Zend/Gdata/Gapps/Query.php');
|
|
|
|
/**
|
|
* Assists in constructing queries for Google Apps member 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
|
|
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
*/
|
|
class Zend_Gdata_Gapps_MemberQuery extends Zend_Gdata_Gapps_Query
|
|
{
|
|
|
|
/**
|
|
* If not null, specifies the group id
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $_groupId = null;
|
|
|
|
/**
|
|
* If not null, specifies the member id of the user who should be
|
|
* retrieved by this query.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $_memberId = null;
|
|
|
|
/**
|
|
* Create a new instance.
|
|
*
|
|
* @param string $domain (optional) The Google Apps-hosted domain to use
|
|
* when constructing query URIs.
|
|
* @param string $groupId (optional) Value for the groupId property.
|
|
* @param string $memberId (optional) Value for the memberId property.
|
|
* @param string $startMemberId (optional) Value for the
|
|
* startMemberId property.
|
|
*/
|
|
public function __construct($domain = null, $groupId = null, $memberId = null,
|
|
$startMemberId = null)
|
|
{
|
|
parent::__construct($domain);
|
|
$this->setGroupId($groupId);
|
|
$this->setMemberId($memberId);
|
|
$this->setStartMemberId($startMemberId);
|
|
}
|
|
|
|
/**
|
|
* Set the group id to query for.
|
|
*
|
|
* @see getGroupId
|
|
* @param string $value The group id to filter search results by, or null to
|
|
* disable.
|
|
*/
|
|
public function setGroupId($value)
|
|
{
|
|
$this->_groupId = $value;
|
|
}
|
|
|
|
/**
|
|
* Get the group id to query for. If no group id is set, null will be
|
|
* returned.
|
|
*
|
|
* @param string $value The group id to filter search results by, or
|
|
* null if disabled.
|
|
* @return string The group id
|
|
*/
|
|
public function getGroupId()
|
|
{
|
|
return $this->_groupId;
|
|
}
|
|
|
|
|
|
/**
|
|
* Set the member id to query for. When set, only users with a member id
|
|
* matching this value will be returned in search results. Set to
|
|
* null to disable filtering by member id.
|
|
*
|
|
* @see getMemberId
|
|
* @param string $value The member id to filter search results by, or null to
|
|
* disable.
|
|
*/
|
|
public function setMemberId($value)
|
|
{
|
|
$this->_memberId = $value;
|
|
}
|
|
|
|
/**
|
|
* Get the member id to query for. If no member id is set, null will be
|
|
* returned.
|
|
*
|
|
* @param string $value The member id to filter search results by, or
|
|
* null if disabled.
|
|
* @return The member id
|
|
*/
|
|
public function getMemberId()
|
|
{
|
|
return $this->_memberId;
|
|
}
|
|
|
|
/**
|
|
* Set the first member id which should be displayed when retrieving
|
|
* a list of members.
|
|
*
|
|
* @param string $value The first member id to be returned, or null to
|
|
* disable.
|
|
*/
|
|
public function setStartMemberId($value)
|
|
{
|
|
if ($value !== null) {
|
|
$this->_params['start'] = $value;
|
|
} else {
|
|
unset($this->_params['start']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
* disabled.
|
|
*/
|
|
public function getStartMemberId()
|
|
{
|
|
if (array_key_exists('start', $this->_params)) {
|
|
return $this->_params['start'];
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the query URL generated by this query instance.
|
|
*
|
|
* @return string The query URL for this instance.
|
|
*/
|
|
public function getQueryUrl()
|
|
{
|
|
|
|
$uri = Zend_Gdata_Gapps::APPS_BASE_FEED_URI;
|
|
$uri .= Zend_Gdata_Gapps::APPS_GROUP_PATH;
|
|
$uri .= '/' . $this->_domain;
|
|
if ($this->_groupId !== null) {
|
|
$uri .= '/' . $this->_groupId;
|
|
} else {
|
|
require_once 'Zend/Gdata/App/InvalidArgumentException.php';
|
|
throw new Zend_Gdata_App_InvalidArgumentException(
|
|
'groupId must not be null');
|
|
}
|
|
|
|
$uri .= '/member';
|
|
|
|
if ($this->_memberId !== null) {
|
|
$uri .= '/' . $this->_memberId;
|
|
}
|
|
$uri .= $this->getQueryString();
|
|
return $uri;
|
|
}
|
|
|
|
}
|