abstractpimobject.php
2.52 KB
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
<?php
/**
* ownCloud - Interface for PIM object
*
* @author Thomas Tanghus
* @copyright 2012 Thomas Tanghus (thomas@tanghus.net)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Contacts;
/**
* Subclass this class or implement IPIMObject interface for PIM objects
*/
abstract class AbstractPIMObject implements IPIMObject {
/**
* This variable holds the ID of this object.
* Depending on the backend, this can be either a string
* or an integer, so we treat them all as strings.
*
* @var string
*/
protected $id;
/**
* This variable holds the owner of this object.
*
* @var string
*/
protected $owner;
/**
* This variable holds the parent of this object if any.
*
* @var string|null
*/
protected $parent;
/**
* This variable holds the permissions of this object.
*
* @var integer
*/
protected $permissions;
/**
* @return string
*/
public function getId() {
return $this->id;
}
/**
* @return string|null
*/
function getDisplayName() {
return $this->displayName;
}
/**
* @return string|null
*/
public function getOwner() {
return $this->owner;
}
/**
* If this object is part of a collection return a reference
* to the parent object, otherwise return null.
* @return IPIMObject|null
*/
public function getParent() {
return $this->parent;
}
/** CRUDS permissions (Create, Read, Update, Delete, Share) using a bitmask of
*
* \OCP\PERMISSION_CREATE
* \OCP\PERMISSION_READ
* \OCP\PERMISSION_UPDATE
* \OCP\PERMISSION_DELETE
* \OCP\PERMISSION_SHARE
* or
* \OCP\PERMISSION_ALL
*
* @return integer
*/
public function getPermissions() {
return $this->permissions;
}
/**
* @return AbstractBackend
*/
public function getBackend() {
return $this->backend;
}
/**
* @param integer $permission
* @return boolean
*/
public function hasPermission($permission) {
return $this->getPermissions() & $permission;
}
}