Documentation

Queue extends DAOEntity
in package
uses ManagedEntity

Track a list of durable/scannable queues.

Registering a queue in this table (and setting is_auto=1) can allow it to execute tasks automatically in the background.

Tags
searchable

secondary

since
5.47

Table of Contents

Methods

__callStatic()  : AbstractAction
Magic method to return the action object for an api.
autocomplete()  : AutocompleteAction
checkAccess()  : CheckAccessAction
claimItems()  : ClaimItems
Claim some items from the queue. Returns zero or more items.
create()  : DAOCreateAction
delete()  : DAODeleteAction
export()  : ExportAction
get()  : DAOGetAction
getActions()  : GetActions
getEntityName()  : string
Get entity name from called class
getFields()  : DAOGetFieldsAction
getInfo()  : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
Reflection function called by Entity::get()
getLinks()  : GetLinks
permissions()  : array<string|int, mixed>
Returns a list of permissions needed to access the various actions in this api.
replace()  : BasicReplaceAction
revert()  : BasicBatchAction
run()  : Run
Run a series of items from a queue.
runItems()  : RunItems
Run some items from the queue.
save()  : DAOSaveAction
update()  : DAOUpdateAction
getDaoName()  : CRM_Core_DAO|string|null
getEntityTitle()  : string
Overridable function to return a localized title for this entity.

Methods

claimItems()

Claim some items from the queue. Returns zero or more items.

public static claimItems([bool $checkPermissions = TRUE ]) : ClaimItems

Note: This is appropriate for persistent, auto-run queues.

The number of items depends on the specific queue. Most notably, batch sizes are influenced by queue-driver support (BatchQueueInterface) and queue-configuration (civicrm_queue.batch_limit).

Parameters
$checkPermissions : bool = TRUE
Return values
ClaimItems

getEntityName()

Get entity name from called class

public static getEntityName() : string
Return values
string

getInfo()

Reflection function called by Entity::get()

public static getInfo() : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
Tags
see
Get
Return values
array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}

getLinks()

public static getLinks([bool $checkPermissions = TRUE ]) : GetLinks
Parameters
$checkPermissions : bool = TRUE
Return values
GetLinks

permissions()

Returns a list of permissions needed to access the various actions in this api.

public static permissions() : array<string|int, mixed>
Return values
array<string|int, mixed>

run()

Run a series of items from a queue.

public static run([bool $checkPermissions = TRUE ]) : Run

This is a lightweight main-loop for development/testing. It may have some limited utility for sysadmins who want to fine-tune runners on a specific queue. See the class docblock for more information.

Parameters
$checkPermissions : bool = TRUE
Return values
Run

runItems()

Run some items from the queue.

public static runItems([bool $checkPermissions = TRUE ]) : RunItems

Note: This is appropriate for persistent, auto-run queues.

The number of items depends on the specific queue. Most notably, batch sizes are influenced by queue-driver support (BatchQueueInterface) and queue-configuration (civicrm_queue.batch_limit).

Parameters
$checkPermissions : bool = TRUE
Return values
RunItems

getEntityTitle()

Overridable function to return a localized title for this entity.

protected static getEntityTitle([bool $plural = FALSE ]) : string
Parameters
$plural : bool = FALSE

Whether to return a plural title.

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results