Skip to content
EN
Log in Sign up
Docs

Class and function reference

Queue

List of public methods of the Zittme\Framework\Queue class. This document was automatically generated from the Zittme core source.

Source: common/framework/Queue.php

Public methods

  • static function addDriver(string $name, Drivers\QueueInterface $driver)
  • Add a custom Queue driver.
  • static function getDriver(string $name)
  • Get a Queue driver instance.
  • static function getDbDriver()
  • Get the DB driver instance, for managing scheduled tasks.
  • static function getSupportedDrivers()
  • Get the list of supported Queue drivers.
  • static function addTask(string $handler, ?object $args = null, ?object $options = null, ?string $priority = null)
  • Add a task to the queue.
  • static function addTaskAt(int $time, string $handler, ?object $args = null, ?object $options = null, ?string $priority = null)
  • Add a task to be executed at a specific time.
  • static function addTaskAtInterval(string $interval, string $handler, ?object $args = null, ?object $options = null)
  • Add a task to be executed at an interval.
  • static function getScheduledTask(int $task_srl)
  • Get information about a scheduled task if it exists.
  • static function cancelScheduledTask(int $task_srl)
  • Cancel a scheduled task.
  • static function checkKey(string $key)
  • Check the process key.
  • static function checkIntervalSyntax(string $interval)
  • Check the interval syntax.
  • static function parseInterval(string $interval, ?int $time)
  • Parse an interval string check it against a timestamp.
  • static function process(int $index, int $count, int $timeout)
  • Process queued and scheduled tasks.
  • static function signalHandler(int $signal, $siginfo)
  • Signal handler.
  • static function signalReceived()
  • Has a signal been received?