1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<?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-2014 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 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.
*
* @category Zend
* @package Zend_Gdata
* @subpackage Gapps
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Gdata_Gapps_GroupQuery extends Zend_Gdata_Gapps_Query
{
/**
* If not null, specifies the group id of the group who should be
* retrieved by this query.
*
* @var string
*/
protected $_groupId = 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 $startGroupName (optional) Value for the
* startGroupName property.
*/
public function __construct($domain = null, $groupId = null,
$startGroupId = null)
{
parent::__construct($domain);
$this->setGroupId($groupId);
$this->setStartGroupId($startGroupId);
}
/**
* 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.
*
* @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.
*/
public function getGroupId()
{
return $this->_groupId;
}
/**
* 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.
*
* @param string $value The member email address to filter search
* results by, or null to disable.
*/
public function setMember($value)
{
if ($value !== null) {
$this->_params['member'] = $value;
}
else {
unset($this->_params['member']);
}
}
/**
* Get the member email address to query for. If no member is set,
* null will be returned.
*
* @see setMember
* @return string The member email address to filter search
* results by, or null if disabled.
*/
public function getMember()
{
if (array_key_exists('member', $this->_params)) {
return $this->_params['member'];
} else {
return null;
}
}
/**
* Sets the query parameter directOnly
* @param bool $value
*/
public function setDirectOnly($value)
{
if ($value !== null) {
if($value == true) {
$this->_params['directOnly'] = 'true';
} else {
$this->_params['directOnly'] = 'false';
}
} else {
unset($this->_params['directOnly']);
}
}
/**
*
* @see setDirectOnly
* @return bool
*/
public function getDirectOnly()
{
if (array_key_exists('directOnly', $this->_params)) {
if($this->_params['directOnly'] == 'true') {
return true;
} else {
return false;
}
} else {
return null;
}
}
/**
* Set the first group id which should be displayed when retrieving
* a list of groups.
*
* @param string $value The first group id to be returned, or null to
* disable.
*/
public function setStartGroupId($value)
{
if ($value !== null) {
$this->_params['start'] = $value;
} else {
unset($this->_params['start']);
}
}
/**
* Get the first group id which should be displayed when retrieving
* a list of groups.
*
* @see setStartGroupId
* @return string The first group id to be returned, or null if
* disabled.
*/
public function getStartGroupId()
{
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;
}
if(array_key_exists('member', $this->_params)) {
$uri .= '/';
}
$uri .= $this->getQueryString();
return $uri;
}
}
|
