Documentation

Claim extends PersistentObject
in package

Application

A worker claims or checks out a message to perform a task. Doing so prevents other workers from attempting to process the same messages.

GRACE_DEFAULT = 43200
LIMIT_DEFAULT = 10
PATCH_CONTENT_TYPE = OpenCloudCommonConstantsMime::JSON_PATCH
TTL_DEFAULT = 43200
$aliases : array<string|int, mixed>: The aliases configure for the properties of the instance.
$json_name : mixed
$metadata : Metadata
$parent : BaseResource
$service : ServiceInterface
$url_resource : mixed
$age : int
$grace : int: The message grace period in seconds. The value of grace must be between 60 and 43200 seconds (12 hours the default, but configurable). The server extends the lifetime of claimed messages to be at least as long as the lifetime of the claim itself, plus a specified grace period to deal with crashed workers (up to 1209600 or 14 days including claim lifetime). If a claimed message would normally live longer than the grace period, it's expiration will not be adjusted.
$href : string: Link.
$id : string
$logger : LoggerInterface: The logger instance
$messages : array<string|int, mixed>
$properties : array<string|int, mixed>: Holds all the properties added by overloading.
$ttl : int: How long the server should wait before releasing the claim in seconds.
__call() : mixed: Intercept non-existent method calls for dynamic getter/setter functionality.
__construct() : mixed
checkExtension() : bool: Check whether an extension is valid
checkJsonError() : mixed: Checks the most recent JSON operation for errors.
create() : mixed
createUrl() : Url
delete() : Response: Delete this resource
findLink() : bool: Find a resource link based on a type
generateUuid() : mixed
getClient() : ClientInterface: Convenience method to return the service's client
getHref() : string
getId() : string
getInstance() : static
getLogger() : LoggerInterface: Returns the Logger object.
getMetadata() : Metadata
getParent() : mixed
getService() : ServiceInterface
getUrl() : mixed: Get this resource's URL
hasLogger() : bool
id() : mixed
jsonCollectionElement() : string: Returns the nested keys that could (rarely) prefix collection items. For example:
jsonCollectionName() : string: Returns the top-level key for collection responses
jsonName() : mixed: Returns the top-level key for the returned response JSON document
makeResourceIteratorOptions() : mixed
name() : string
parseResponse() : mixed: Parse a HTTP response for the required content
populate() : mixed: Populates the current object based on an unknown data type.
refresh() : Response: Refresh the state of a resource
refreshFromLocationUrl() : mixed: Given a `location` URL, refresh this resource
region() : mixed
resourceName() : mixed: Returns the URI path for this resource
setHref() : $this: Set the Href attribute and extrapolate the ID.
setLogger() : $this: Sets the logger.
setMetadata() : $this
setParent() : self
setService() : PersistentObject
status() : string
stripNamespace() : mixed
toCamel() : mixed: Convert a string to camelCase format.
toUnderscores() : mixed: Convert string to underscore format.
update() : mixed: Updates the current Claim. It is recommended that you periodically renew claims during long-running batches of work to avoid losing a claim in the middle of processing a message. This is done by setting a new TTL for the claim (which may be different from the original TTL). The server will then reset the age of the claim and apply the new TTL.
url() : mixed
waitFor() : mixed: A method to repeatedly poll the API resource, waiting for an eventual state change
createJson() : object: Provides JSON for create request body
generateJsonPatch() : string: Generates a JSON Patch representation and return its
getAlias() : string: Returns the alias configured for the given key. If no alias exists it returns the original key.
getJsonHeader() : mixed
getPatchHeaders() : mixed
getProperty() : mixed: Grab value out of the data array.
getUpdateablePropertiesAsArray() : mixed: Returns the object's properties as an array
noCreate() : mixed
noDelete() : mixed
noUpdate() : mixed
primaryKeyField() : string: Returns the primary key field for the object
propertyExists() : bool: Basic check to see whether property exists.
recursivelyAliasPropertyValue() : mixed: Returns the given property value's alias, if configured; Else, the unchanged property value is returned. If the given property value is an array or an instance of \stdClass, it is aliases recursively.
refreshFromParent() : mixed: Causes resource to refresh based on parent's URL
setProperty() : mixed: We can set a property under three conditions:
updateJson() : mixed: Provides JSON for update request body
checkAttributePrefix() : bool: Checks the attribute $property and only permits it if the prefix is in the specified $prefixes array
isAccessible() : bool: Does the property exist in the object variable list (i.e. does it have public or protected visibility?)

GRACE_DEFAULT


    public
    mixed
    GRACE_DEFAULT
    = 43200

LIMIT_DEFAULT


    public
    mixed
    LIMIT_DEFAULT
    = 10

PATCH_CONTENT_TYPE


    public
    mixed
    PATCH_CONTENT_TYPE
    = OpenCloudCommonConstantsMime::JSON_PATCH

TTL_DEFAULT


    public
    mixed
    TTL_DEFAULT
    = 43200

$aliases

The aliases configure for the properties of the instance.


    protected
        array<string|int, mixed>
    $aliases
     = array()

$json_name


    protected
    static    mixed
    $json_name
     = ''

$metadata


    protected
        Metadata
    $metadata

$parent


    protected
        BaseResource
    $parent

$service


    protected
        ServiceInterface
    $service

$url_resource


    protected
    static    mixed
    $url_resource
     = 'claims'

$age


    private
        int
    $age

$grace

The message grace period in seconds. The value of grace must be between 60 and 43200 seconds (12 hours the default, but configurable). The server extends the lifetime of claimed messages to be at least as long as the lifetime of the claim itself, plus a specified grace period to deal with crashed workers (up to 1209600 or 14 days including claim lifetime). If a claimed message would normally live longer than the grace period, it's expiration will not be adjusted.


    private
        int
    $grace

$href

Link.


    private
        string
    $href

$id


    private
        string
    $id

$logger

The logger instance


    private
        LoggerInterface
    $logger

$messages


    private
        array<string|int, mixed>
    $messages

An array of messages.

$properties

Holds all the properties added by overloading.


    private
        array<string|int, mixed>
    $properties
     = array()

$ttl

How long the server should wait before releasing the claim in seconds.


    private
        int
    $ttl

The ttl value must be between 60 and 43200 seconds (12 hours is the default but is configurable).

__call()

Intercept non-existent method calls for dynamic getter/setter functionality.


    public
                __call( $method,  $args) : mixed

Parameters

$method :
$args :

Return values

mixed —

__construct()


    public
                __construct(ServiceInterface $service[,  $data = null ]) : mixed

Parameters

$service : ServiceInterface: The service that this resource belongs to
$data : = null: $data

Return values

mixed —

checkExtension()

Check whether an extension is valid


    public
                checkExtension(mixed $alias) : bool

Parameters

$alias : mixed: The extension name

Return values

bool —

checkJsonError()

Checks the most recent JSON operation for errors.


    public
            static    checkJsonError() : mixed

Return values

mixed —

create()


    public
                create([mixed $params = array() ]) : mixed

Parameters

$params : mixed = array()

Return values

mixed —

createUrl()


    public
                createUrl() : Url

Return values

Url —

delete()

Delete this resource


    public
                delete() : Response

Return values

Response —

findLink()

Find a resource link based on a type


    public
                findLink([string $type = 'self' ]) : bool

Parameters

$type : string = 'self'

Return values

bool —

generateUuid()


    public
            static    generateUuid() : mixed

Return values

mixed —

getClient()

Convenience method to return the service's client


    public
                getClient() : ClientInterface

Return values

ClientInterface —

getHref()


    public
                getHref() : string

Return values

string —

getId()


    public
                getId() : string

Return values

string —

getInstance()


    public
            static    getInstance() : static

Return values

static —

getLogger()

Returns the Logger object.


    public
                getLogger() : LoggerInterface

Return values

LoggerInterface —

getMetadata()


    public
                getMetadata() : Metadata

Return values

Metadata —

getParent()


    public
                getParent() : mixed

Return values

mixed —

getService()


    public
                getService() : ServiceInterface

Return values

ServiceInterface —

getUrl()

Get this resource's URL


    public
                getUrl([null $path = null ][, array<string|int, mixed> $query = array() ]) : mixed

Parameters

$path : null = null: URI path to add on
$query : array<string|int, mixed> = array(): Query to add on

Return values

mixed —

hasLogger()


    public
                hasLogger() : bool

Return values

bool —

id()


    public
                id() : mixed

Return values

mixed —

jsonCollectionElement()

Returns the nested keys that could (rarely) prefix collection items. For example:


    public
            static    jsonCollectionElement() : string

{ "keypairs": [ { "keypair": { "fingerprint": "...", "name": "key1", "public_key": "..." } }, { "keypair": { "fingerprint": "...", "name": "key2", "public_key": "..." } } ] }

In the above example, "keypairs" would be the $json_collection_name and "keypair" would be the $json_collection_element

Return values

string —

jsonCollectionName()

Returns the top-level key for collection responses


    public
            static    jsonCollectionName() : string

Return values

string —

jsonName()

Returns the top-level key for the returned response JSON document


    public
            static    jsonName() : mixed

Return values

mixed —

makeResourceIteratorOptions()


    public
                makeResourceIteratorOptions(mixed $resource) : mixed

Parameters

$resource : mixed

Return values

mixed —

name()


    public
                name() : string

Return values

string —

parseResponse()

Parse a HTTP response for the required content


    public
                parseResponse(Response $response) : mixed

Parameters

$response : Response

Return values

mixed —

populate()

Populates the current object based on an unknown data type.


    public
                populate(mixed $info[, mixed $setObjects = true ]) : mixed

Parameters

$info : mixed
$setObjects : mixed = true

Return values

mixed —

refresh()

Refresh the state of a resource


    public
                refresh([null $id = null ][, null $url = null ]) : Response

Parameters

$id : null = null
$url : null = null

Return values

Response —

refreshFromLocationUrl()

Given a `location` URL, refresh this resource


    public
                refreshFromLocationUrl( $url) : mixed

Parameters

$url :

Return values

mixed —

region()


    public
                region() : mixed

Return values

mixed —

resourceName()

Returns the URI path for this resource


    public
            static    resourceName() : mixed

Return values

mixed —

setHref()

Set the Href attribute and extrapolate the ID.


    public
                setHref( $href) : $this

Parameters

$href :

Return values

$this —

setLogger()

Sets the logger.


    public
                setLogger([LoggerInterface $logger = null ]) : $this

Parameters

$logger : LoggerInterface = null

Return values

$this —

setMetadata()


    public
                setMetadata(mixed $data) : $this

Parameters

$data : mixed

Return values

$this —

setParent()


    public
                setParent(BaseResource $parent) : self

Parameters

$parent : BaseResource

Return values

self —

setService()


    public
                setService(ServiceInterface $service) : PersistentObject

Parameters

$service : ServiceInterface

Return values

PersistentObject —

status()


    public
                status() : string

Return values

string —

stripNamespace()


    public
                stripNamespace(mixed $namespace) : mixed

Parameters

$namespace : mixed

Return values

mixed —

toCamel()

Convert a string to camelCase format.


    public
                toCamel( $string[, bool $capitalise = true ]) : mixed

Parameters

$string :
$capitalise : bool = true: Optional flag which allows for word capitalization.

Return values

mixed —

toUnderscores()

Convert string to underscore format.


    public
                toUnderscores( $string) : mixed

Parameters

$string :

Return values

mixed —

update()

Updates the current Claim. It is recommended that you periodically renew claims during long-running batches of work to avoid losing a claim in the middle of processing a message. This is done by setting a new TTL for the claim (which may be different from the original TTL). The server will then reset the age of the claim and apply the new TTL.


    public
                update([mixed $params = array() ]) : mixed

Parameters

$params : mixed = array()

Return values

mixed —

url()


    public
                url([mixed $path = null ][, array<string|int, mixed> $query = array() ]) : mixed

Parameters

$path : mixed = null
$query : array<string|int, mixed> = array()

Return values

mixed —

waitFor()

A method to repeatedly poll the API resource, waiting for an eventual state change


    public
                waitFor([null $state = null ][, null $timeout = null ][, null $callback = null ][, null $interval = null ]) : mixed

Parameters

$state : null = null: The expected state of the resource
$timeout : null = null: The maximum timeout to wait
$callback : null = null: The callback to use to check the state
$interval : null = null: How long between each refresh request

Return values

mixed —

createJson()

Provides JSON for create request body


    protected
                createJson() : object

Return values

object —

generateJsonPatch()

Generates a JSON Patch representation and return its


    protected
                generateJsonPatch(mixed $updatedProperties) : string

Parameters

$updatedProperties : mixed: Properties of the resource to update

Return values

string —

JSON Patch representation for updates

getAlias()

Returns the alias configured for the given key. If no alias exists it returns the original key.


    protected
                getAlias(string $key) : string

Parameters

$key : string

Return values

string —

getJsonHeader()


    protected
            static    getJsonHeader() : mixed

Return values

mixed —

getPatchHeaders()


    protected
            static    getPatchHeaders() : mixed

Return values

mixed —

getProperty()

Grab value out of the data array.


    protected
                getProperty(string $property) : mixed

Parameters

$property : string

Return values

mixed —

getUpdateablePropertiesAsArray()

Returns the object's properties as an array


    protected
                getUpdateablePropertiesAsArray() : mixed

Return values

mixed —

noCreate()


    protected
                noCreate() : mixed

Return values

mixed —

noDelete()


    protected
                noDelete() : mixed

Return values

mixed —

noUpdate()


    protected
                noUpdate() : mixed

Return values

mixed —

primaryKeyField()

Returns the primary key field for the object


    protected
                primaryKeyField() : string

Return values

string —

propertyExists()

Basic check to see whether property exists.


    protected
                propertyExists(string $property[, bool $allowRetry = true ]) : bool

Parameters

$property : string: The property name being investigated.
$allowRetry : bool = true: If set to TRUE, the check will try to format the name in underscores because there are sometimes discrepancies between camelCaseNames and underscore_names.

Return values

bool —

recursivelyAliasPropertyValue()

Returns the given property value's alias, if configured; Else, the unchanged property value is returned. If the given property value is an array or an instance of \stdClass, it is aliases recursively.


    protected
                recursivelyAliasPropertyValue(mixed $propertyValue) : mixed

Parameters

$propertyValue : mixed: Array or \stdClass instance to alias

Return values

mixed —

Property value, aliased recursively

refreshFromParent()

Causes resource to refresh based on parent's URL


    protected
                refreshFromParent() : mixed

Return values

mixed —

setProperty()

We can set a property under three conditions:


    protected
                setProperty(mixed $property, mixed $value) : mixed

If it has a concrete setter: setProperty()
If the property exists
If the property name's prefix is in an approved list

Parameters

$property : mixed
$value : mixed

Return values

mixed —

updateJson()

Provides JSON for update request body


    protected
                updateJson([mixed $params = array() ]) : mixed

Parameters

$params : mixed = array()

Return values

mixed —

checkAttributePrefix()

Checks the attribute $property and only permits it if the prefix is in the specified $prefixes array


    private
                checkAttributePrefix(string $property) : bool

This is to support extension namespaces in some services.

Parameters

$property : string: the name of the attribute

Return values

bool —

isAccessible()

Does the property exist in the object variable list (i.e. does it have public or protected visibility?)


    private
                isAccessible( $property) : bool

Parameters

$property :

Return values

bool —