blob: c49f4fcbc8d57296a918b84919b64dea36a9bf49 (
plain)
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
|
<?php
/**
* @author Robin McCorkell <robin@mccorkell.me.uk>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCA\Files_External\Lib;
/**
* Trait for objects requiring an identifier (and/or identifier aliases)
* Also supports deprecation to a different object, linking the objects
*/
trait IdentifierTrait {
/** @var string */
protected $identifier;
/** @var string[] */
protected $identifierAliases = [];
/** @var IdentifierTrait */
protected $deprecateTo = null;
/**
* @return string
*/
public function getIdentifier() {
return $this->identifier;
}
/**
* @param string $identifier
* @return self
*/
public function setIdentifier($identifier) {
$this->identifier = $identifier;
$this->identifierAliases[] = $identifier;
return $this;
}
/**
* @return string[]
*/
public function getIdentifierAliases() {
return $this->identifierAliases;
}
/**
* @param string $alias
* @return self
*/
public function addIdentifierAlias($alias) {
$this->identifierAliases[] = $alias;
return $this;
}
/**
* @return object|null
*/
public function getDeprecateTo() {
return $this->deprecateTo;
}
/**
* @param object $destinationObject
* @return self
*/
public function deprecateTo($destinationObject) {
$this->deprecateTo = $destinationObject;
return $this;
}
/**
* @return array
*/
public function jsonSerializeIdentifier() {
$data = [
'identifier' => $this->identifier,
'identifierAliases' => $this->identifierAliases,
];
if ($this->deprecateTo) {
$data['deprecateTo'] = $this->deprecateTo->getIdentifier();
}
return $data;
}
}
|
