|
1
|
|
|
<?php |
|
2
|
|
|
namespace Dkd\PhpCmis; |
|
3
|
|
|
|
|
4
|
|
|
/* |
|
5
|
|
|
* This file is part of php-cmis-client. |
|
6
|
|
|
* |
|
7
|
|
|
* (c) Sascha Egerer <[email protected]> |
|
8
|
|
|
* |
|
9
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
10
|
|
|
* file that was distributed with this source code. |
|
11
|
|
|
*/ |
|
12
|
|
|
|
|
13
|
|
|
use Dkd\PhpCmis\Data\AclInterface; |
|
14
|
|
|
use Dkd\PhpCmis\Data\ExtensionDataInterface; |
|
15
|
|
|
use Dkd\PhpCmis\Data\ObjectDataInterface; |
|
16
|
|
|
use Dkd\PhpCmis\Data\PropertiesInterface; |
|
17
|
|
|
use Dkd\PhpCmis\Enum\IncludeRelationships; |
|
18
|
|
|
use GuzzleHttp\Stream\StreamInterface; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* Versioning Service interface. |
|
22
|
|
|
* |
|
23
|
|
|
* See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, |
|
24
|
|
|
* parameters, exceptions and the domain model. |
|
25
|
|
|
*/ |
|
26
|
|
|
interface VersioningServiceInterface |
|
27
|
|
|
{ |
|
28
|
|
|
/** |
|
29
|
|
|
* Reverses the effect of a check-out. |
|
30
|
|
|
* |
|
31
|
|
|
* @param string $repositoryId the identifier for the repository |
|
32
|
|
|
* @param string $objectId the identifier for the PWC |
|
33
|
|
|
* @param ExtensionDataInterface|null $extension |
|
34
|
|
|
*/ |
|
35
|
|
|
public function cancelCheckOut($repositoryId, & $objectId, ExtensionDataInterface $extension = null); |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* Checks-in the private working copy (PWC) document. |
|
39
|
|
|
* |
|
40
|
|
|
* @param string $repositoryId the identifier for the repository |
|
41
|
|
|
* @param string $objectId input: the identifier for the PWC, |
|
42
|
|
|
* output: the identifier for the newly created version document |
|
43
|
|
|
* @param boolean $major indicator if the new version should become a major (<code>true</code>) or minor |
|
44
|
|
|
* (<code>false</code>) version |
|
45
|
|
|
* @param PropertiesInterface|null $properties the property values that must be applied to the |
|
46
|
|
|
* newly created document object |
|
47
|
|
|
* @param StreamInterface|null $contentStream the content stream that must be stored |
|
48
|
|
|
* for the newly created document object |
|
49
|
|
|
* @param string|null $checkinComment a version comment |
|
50
|
|
|
* @param string[] $policies a list of policy IDs that must be applied to the newly created document object |
|
51
|
|
|
* @param AclInterface|null $addAces a list of ACEs that must be added to the newly created document object |
|
52
|
|
|
* @param AclInterface|null $removeAces a list of ACEs that must be removed from the newly created document object |
|
53
|
|
|
* @param ExtensionDataInterface|null $extension |
|
54
|
|
|
* @return string|null Versioned object ID of original source if succesful, null otherwise |
|
55
|
|
|
*/ |
|
56
|
|
View Code Duplication |
public function checkIn( |
|
|
|
|
|
|
57
|
|
|
$repositoryId, |
|
58
|
|
|
& $objectId, |
|
59
|
|
|
$major = true, |
|
60
|
|
|
PropertiesInterface $properties = null, |
|
61
|
|
|
StreamInterface $contentStream = null, |
|
62
|
|
|
$checkinComment = null, |
|
63
|
|
|
array $policies = [], |
|
64
|
|
|
AclInterface $addAces = null, |
|
65
|
|
|
AclInterface $removeAces = null, |
|
66
|
|
|
ExtensionDataInterface $extension = null |
|
67
|
|
|
); |
|
68
|
|
|
|
|
69
|
|
|
/** |
|
70
|
|
|
* Create a private working copy of the document. |
|
71
|
|
|
* |
|
72
|
|
|
* @param string $repositoryId the identifier for the repository |
|
73
|
|
|
* @param string $objectId input: the identifier for the document that should be checked out, |
|
74
|
|
|
* output: the identifier for the newly created PWC |
|
75
|
|
|
* @param ExtensionDataInterface|null $extension |
|
76
|
|
|
* @param boolean|null $contentCopied output: indicator if the content of the original |
|
77
|
|
|
* document has been copied to the PWC |
|
78
|
|
|
* @return string|null Versioned object ID of PWC if succesful, null otherwise |
|
79
|
|
|
*/ |
|
80
|
|
|
public function checkOut( |
|
81
|
|
|
$repositoryId, |
|
82
|
|
|
& $objectId, |
|
83
|
|
|
ExtensionDataInterface $extension = null, |
|
84
|
|
|
$contentCopied = null |
|
85
|
|
|
); |
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* Returns the list of all document objects in the specified version series, |
|
89
|
|
|
* sorted by the property "cmis:creationDate" descending. |
|
90
|
|
|
* |
|
91
|
|
|
* @param string $repositoryId the identifier for the repository |
|
92
|
|
|
* @param string $objectId The identifier for the object |
|
93
|
|
|
* @param string $versionSeriesId the identifier for the object |
|
94
|
|
|
* @param string|null $filter a comma-separated list of query names that defines which properties must be |
|
95
|
|
|
* returned by the repository (default is repository specific) |
|
96
|
|
|
* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the allowable |
|
97
|
|
|
* actions for the objects (default is <code>false</code>) |
|
98
|
|
|
* @param ExtensionDataInterface|null $extension |
|
99
|
|
|
* @return ObjectDataInterface[] the complete version history of the version series |
|
100
|
|
|
*/ |
|
101
|
|
|
public function getAllVersions( |
|
102
|
|
|
$repositoryId, |
|
103
|
|
|
$objectId, |
|
104
|
|
|
$versionSeriesId, |
|
105
|
|
|
$filter = null, |
|
106
|
|
|
$includeAllowableActions = false, |
|
107
|
|
|
ExtensionDataInterface $extension = null |
|
108
|
|
|
); |
|
109
|
|
|
|
|
110
|
|
|
/** |
|
111
|
|
|
* Get the latest document object in the version series. |
|
112
|
|
|
* |
|
113
|
|
|
* @param string $repositoryId the identifier for the repository |
|
114
|
|
|
* @param string $objectId The identifier for the object |
|
115
|
|
|
* @param string $versionSeriesId |
|
116
|
|
|
* @param boolean $major If <code>true</code>, then the repository MUST return the properties for the latest major |
|
117
|
|
|
* version object in the version series. |
|
118
|
|
|
* If <code>false</code>, the repository MUST return the properties for the latest |
|
119
|
|
|
* (major or non-major) version object in the version series. |
|
120
|
|
|
* @param string|null $filter a comma-separated list of query names that defines which properties must be |
|
121
|
|
|
* returned by the repository (default is repository specific) |
|
122
|
|
|
* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the allowable |
|
123
|
|
|
* actions for the objects (default is <code>false</code>) |
|
124
|
|
|
* @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects |
|
125
|
|
|
* participate must be returned (default is <code>IncludeRelationships::NONE</code>) |
|
126
|
|
|
* @param string $renditionFilter indicates what set of renditions the repository must return whose kind |
|
127
|
|
|
* matches this filter (default is "cmis:none") |
|
128
|
|
|
* @param boolean $includePolicyIds if <code>true</code>, then the repository must return the policy ids for |
|
129
|
|
|
* the object (default is <code>false</code>) |
|
130
|
|
|
* @param boolean $includeAcl |
|
131
|
|
|
* @param ExtensionDataInterface|null $extension |
|
132
|
|
|
* @return ObjectDataInterface |
|
133
|
|
|
*/ |
|
134
|
|
View Code Duplication |
public function getObjectOfLatestVersion( |
|
|
|
|
|
|
135
|
|
|
$repositoryId, |
|
136
|
|
|
$objectId, |
|
137
|
|
|
$versionSeriesId, |
|
138
|
|
|
$major = false, |
|
139
|
|
|
$filter = null, |
|
140
|
|
|
$includeAllowableActions = false, |
|
141
|
|
|
IncludeRelationships $includeRelationships = null, |
|
142
|
|
|
$renditionFilter = Constants::RENDITION_NONE, |
|
143
|
|
|
$includePolicyIds = false, |
|
144
|
|
|
$includeAcl = false, |
|
145
|
|
|
ExtensionDataInterface $extension = null |
|
146
|
|
|
); |
|
147
|
|
|
|
|
148
|
|
|
/** |
|
149
|
|
|
* Get a subset of the properties for the latest document object in the version series. |
|
150
|
|
|
* |
|
151
|
|
|
* @param string $repositoryId the identifier for the repository |
|
152
|
|
|
* @param string $objectId The identifier for the object |
|
153
|
|
|
* @param string $versionSeriesId The identifier for the version series. |
|
154
|
|
|
* @param boolean $major If <code>true</code>, then the repository MUST return the properties for the latest major |
|
155
|
|
|
* version object in the version series. |
|
156
|
|
|
* If <code>false</code>, the repository MUST return the properties for the latest |
|
157
|
|
|
* (major or non-major) version object in the version series. |
|
158
|
|
|
* @param string|null $filter a comma-separated list of query names that defines which properties must be |
|
159
|
|
|
* returned by the repository (default is repository specific) |
|
160
|
|
|
* @param ExtensionDataInterface|null $extension |
|
161
|
|
|
* @return PropertiesInterface |
|
162
|
|
|
*/ |
|
163
|
|
|
public function getPropertiesOfLatestVersion( |
|
164
|
|
|
$repositoryId, |
|
165
|
|
|
$objectId, |
|
166
|
|
|
$versionSeriesId, |
|
167
|
|
|
$major = false, |
|
168
|
|
|
$filter = null, |
|
169
|
|
|
ExtensionDataInterface $extension = null |
|
170
|
|
|
); |
|
171
|
|
|
} |
|
172
|
|
|
|
dkd /
php-cmis-client
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.