Documentation

Resource
in package

Description of Resource

Tags
author

zozlak

Table of Contents

Constants

STATE_ACTIVE  = 'active'
STATE_DELETED  = 'deleted'
STATE_TOMBSTONE  = 'tombstone'

Properties

$id  : int|null

Methods

__construct()  : mixed
checkCanCreate()  : void
checkCanRead()  : void
checkCanWrite()  : void
delete()  : void
deleteTombstone()  : void
get()  : void
getMetadata()  : void
getUri()  : string
head()  : void
headMetadata()  : void
merge()  : void
Merges the $srcId resource into the current resource.
options()  : void
optionsCollection()  : void
optionsCollectionMetadata()  : void
optionsMetadata()  : void
optionsTombstone()  : void
patchMetadata()  : void
postCollection()  : void
postCollectionMetadata()  : void
put()  : void
checkTransactionState()  : void
deleteCheckReferences()  : void
deleteLockAll()  : void
deleteReferences()  : void
deleteResources()  : void

Constants

STATE_ACTIVE

public mixed STATE_ACTIVE = 'active'

STATE_DELETED

public mixed STATE_DELETED = 'deleted'

STATE_TOMBSTONE

public mixed STATE_TOMBSTONE = 'tombstone'

Properties

Methods

__construct()

public __construct(int|null $id) : mixed
Parameters
$id : int|null

checkCanCreate()

public checkCanCreate() : void

checkCanRead()

public checkCanRead() : void

checkCanWrite()

public checkCanWrite([bool $tombstone = false ]) : void
Parameters
$tombstone : bool = false

deleteTombstone()

public deleteTombstone() : void

getMetadata()

public getMetadata() : void

getUri()

public getUri() : string
Return values
string

headMetadata()

public headMetadata([bool $get = false ]) : void
Parameters
$get : bool = false

merge()

Merges the $srcId resource into the current resource.

public merge(int $srcId) : void

Preserves identifiers and unique properties from both. Non-unique properties are kept from the current resource only.

Parameters
$srcId : int

options()

public options([int $code = 204 ]) : void
Parameters
$code : int = 204

optionsCollection()

public optionsCollection([int $code = 204 ]) : void
Parameters
$code : int = 204

optionsCollectionMetadata()

public optionsCollectionMetadata([int $code = 204 ]) : void
Parameters
$code : int = 204

optionsMetadata()

public optionsMetadata([int $code = 204 ]) : void
Parameters
$code : int = 204

optionsTombstone()

public optionsTombstone([int $code = 204 ]) : void
Parameters
$code : int = 204

patchMetadata()

public patchMetadata() : void

postCollection()

public postCollection() : void

postCollectionMetadata()

public postCollectionMetadata() : void

checkTransactionState()

private checkTransactionState() : void

deleteCheckReferences()

private deleteCheckReferences(int $txId, bool $delRefs) : void
Parameters
$txId : int
$delRefs : bool

deleteLockAll()

private deleteLockAll(int $txId) : void
Parameters
$txId : int

deleteReferences()

private deleteReferences() : void

deleteResources()

private deleteResources(int $txId) : void
Parameters
$txId : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results