BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Model
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Utility
    • Core
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Validation
      • ORM
        • Locator
      • Utility

Classes

  • Annotation
  • Application
  • AsyncJob
  • AuthProvider
  • Category
  • DateRange
  • ExternalAuth
  • History
  • Link
  • Location
  • ObjectCategory
  • ObjectPermission
  • ObjectProperty
  • ObjectRelation
  • ObjectTag
  • Profile
  • Property
  • PropertyType
  • Publication
  • Relation
  • RelationType
  • Role
  • RolesUser
  • Tag
  • Translation
  • Tree
  • UserToken

Traits

  • JsonApiAdminTrait
  • JsonApiModelTrait

Class AsyncJob

Asynchronous Job Entity

Cake\ORM\Entity
Extended by BEdita\Core\Model\Entity\AsyncJob implements BEdita\Core\Utility\JsonApiSerializable uses BEdita\Core\Model\Entity\JsonApiAdminTrait
Namespace: BEdita\Core\Model\Entity
Since: 4.0.0
Located at Core/src/Model/Entity/AsyncJob.php

Methods summary

protected string
# _getStatus( )

Magic getter for status.

Magic getter for status.

Returns

string
public boolean
# run( array $options = [] )

Run this asynchronous job.

Run this asynchronous job.

Parameters

$options
Additional options.

Returns

boolean

Throws

BadMethodCallException
Throws an exception if job hasn't been locked.

Methods inherited from BEdita\Core\Utility\JsonApiSerializable

jsonApiSerialize(), routeNamePrefix()

Methods used from BEdita\Core\Model\Entity\JsonApiAdminTrait

getRelationships(), routeNamePrefix()

Properties summary

protected array $_accessible

Inheritdoc

# [ 'uuid' => true, 'service' => true, 'priority' => true, 'payload' => true, 'scheduled_from' => true, 'expires' => true, 'max_attempts' => true, ]
protected array $_virtual

Inheritdoc

# [ 'status', ]

Magic properties

public string $uuid
public string $service
public integer $priority
public array $payload
public Cake\I18n\Time $scheduled_from
public Cake\I18n\Time $expires
public integer $max_attempts
public Cake\I18n\Time $locked_until
public Cake\I18n\Time $created
public Cake\I18n\Time $modified
public Cake\I18n\Time $completed
public string $status
BEdita API doc | 4-cactus API documentation generated by ApiGen