|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* OpenFireRestAPI is based entirely on official documentation of the REST API |
|
4
|
|
|
* Plugin and you can extend it by following the directives of the documentation |
|
5
|
|
|
* |
|
6
|
|
|
* For the full copyright and license information, please read the LICENSE |
|
7
|
|
|
* file that was distributed with this source code. For the full list of |
|
8
|
|
|
* contributors, visit https://github.com/gnello/PHPOpenFireRestAPI/contributors |
|
9
|
|
|
* |
|
10
|
|
|
* @author Luca Agnello <[email protected]> |
|
11
|
|
|
* @link https://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html |
|
12
|
|
|
*/ |
|
13
|
|
|
|
|
14
|
|
|
namespace Gnello\OpenFireRestAPI\Payloads; |
|
15
|
|
|
|
|
16
|
|
|
/** |
|
17
|
|
|
* Payload of Group related REST Endpoint |
|
18
|
|
|
* Class GroupPayload |
|
19
|
|
|
* @package Gnello\OpenFireRestAPI\Payloads |
|
20
|
|
|
* @link http://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html#group |
|
21
|
|
|
*/ |
|
22
|
|
|
class GroupPayload extends AbstractPayload |
|
23
|
|
|
{ |
|
24
|
|
|
/** |
|
25
|
|
|
* The name of the group |
|
26
|
|
|
* Optional No |
|
27
|
|
|
* @var string |
|
28
|
|
|
*/ |
|
29
|
|
|
private $name; |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* The description of the group |
|
33
|
|
|
* Optional No |
|
34
|
|
|
* @var string |
|
35
|
|
|
*/ |
|
36
|
|
|
private $description; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* A collection with current admins of the group |
|
40
|
|
|
* Optional Yes |
|
41
|
|
|
* @var array |
|
42
|
|
|
*/ |
|
43
|
|
|
private $admins; |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* A collection with current members of the group |
|
47
|
|
|
* Optional Yes |
|
48
|
|
|
* @var array |
|
49
|
|
|
*/ |
|
50
|
|
|
private $members; |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* |
|
54
|
|
|
*/ |
|
55
|
|
|
private $groupname; |
|
56
|
|
|
|
|
57
|
|
|
/** |
|
58
|
|
|
* @param $name |
|
59
|
|
|
*/ |
|
60
|
|
|
public function setName($name) { |
|
61
|
|
|
$this->name = $name; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* @param $description |
|
66
|
|
|
*/ |
|
67
|
|
|
public function setDescription($description) { |
|
68
|
|
|
$this->description = $description; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* @param $admins |
|
73
|
|
|
*/ |
|
74
|
|
|
public function setAdmins($admins) { |
|
75
|
|
|
$this->admins = $admins; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* @param $members |
|
80
|
|
|
*/ |
|
81
|
|
|
public function setMembers($members) { |
|
82
|
|
|
$this->members = $members; |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
/** |
|
86
|
|
|
* @param $groupname |
|
87
|
|
|
*/ |
|
88
|
|
|
public function setGroupname($groupname) { |
|
89
|
|
|
$this->groupname = $groupname; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
/** |
|
93
|
|
|
* @return string |
|
94
|
|
|
*/ |
|
95
|
|
|
public function getName() { |
|
96
|
|
|
return $this->name; |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* @return string |
|
101
|
|
|
*/ |
|
102
|
|
|
public function getDescription() { |
|
103
|
|
|
return $this->description; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* @return array |
|
108
|
|
|
*/ |
|
109
|
|
|
public function getAdmins() { |
|
110
|
|
|
return $this->admins; |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
/** |
|
114
|
|
|
* @return array |
|
115
|
|
|
*/ |
|
116
|
|
|
public function getMembers() { |
|
117
|
|
|
return $this->members; |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
/** |
|
121
|
|
|
* @return string |
|
122
|
|
|
*/ |
|
123
|
|
|
public function getGroupname() { |
|
124
|
|
|
return $this->groupname; |
|
125
|
|
|
} |
|
126
|
|
|
} |
gnello /
php-openfire-restapi
