LockrequestController
class LockrequestController extends BaseController
Lock request controller handles creating and releasing locks.
Locks are objects in-and-of themselves. So instead of locking a content item, you create a lock for a content item. Thus, literally anything that generates an SRN can be locked.
Properties
| static boolean | $batchMode | Controller is in batch mode | from BaseController |
| static array | $batchedResponses | Stack for batched responses | from BaseController |
Methods
Find lock via its parent content's SRN
Get existing lock
Create a new lock. A valid SRN is required. Lock will be acquired for requesting user. It is not possible to override user.
Delete lock for given UUID. Request must be made from locking user.
Details
in BaseController at line line 60
int
getStatusCode()
Return status code
in BaseController at line line 69
array
getHeaders()
Return current headers
in BaseController at line line 78
string
getPayload()
Return payload
in BaseController at line line 87
setStatusCode(int $code)
Set status code
in BaseController at line line 97
setHeaders(string $key, string $value)
Set header value
in BaseController at line line 106
setPayload(string $payload)
Set payload
in BaseController at line line 294
static
startBatchMode()
Static method to enable batch mode return handling
in BaseController at line line 302
static
endBatchMode()
Static method to disable batch mode return handling
at line line 26
array
getParentAction()
Find lock via its parent content's SRN
at line line 50
array
getAction(string $uuid)
Get existing lock
at line line 74
array
createAction()
Create a new lock. A valid SRN is required. Lock will be acquired for requesting user. It is not possible to override user.
at line line 118
array
deleteAction(string $uuid)
Delete lock for given UUID. Request must be made from locking user.
A lock back be overriden by an Administrator under by sending a JSON object with the DELETE request with the requesting user's UUID under the 'force_override' key
DELETE /v3/lock-request/516e3165-ff12-48eb-aedb-d16dcd4a7476 HTTP/1.1
authorization: Basic ...
content-type: application/json
{"force_override":"XXXX-XXX-XXX-XXX-XXXXX"}