FIRST TODOS

Replace all placeholders in the project. They are formatted as

!!.*!!

BEFORE COMMIT

Run below command to fix source code regarding PSR-1 and PSR-2 coding styles.

php php-cs-fixer-v2.phar fix ./ --verbose --show-progress=estimating

Async jobs

Handlers

A custom class implementing AsyncPHP\Doorman\Handler should be created. This handler takes a Task object. Using this object, you can access any information about the task. In addition to getting information from the task, you can implement the handle function in which way you want. For example:

class ReportHandler implements Handler
{
    /**
     * Handles a task.
     *
     * @param Task $task
     */
    public function handle(Task $task)
    {
        $data = $task->getData();
        /**@var Report $report */
        $report = $data["report"];
        $report->create();
    }
}

Tasks

A custom class implementing AsyncPHP\Doorman\Task should be created. These tasks are then run by the handler. For example:

class ReportTask implements Task,Expires, Process
{
    private $report;
    /**
     * @var null|int
     */
    private $id;
    public function __construct(Report $report)
    {
        $this->report = $report;
    }
    /**
     * @return Report
     */
    public function getReport(){
        return $this->report;
    }
    /**
     * String representation of object
     * @link http://php.net/manual/en/serializable.serialize.php
     * @return string the string representation of the object or null
     * @since 5.1.0
     */
    public function serialize()
    {
        return serialize($this->report);
    }
    /**
     * Constructs the object
     * @link http://php.net/manual/en/serializable.unserialize.php
     * @param string $serialized
     * The string representation of the object.
     * 
     * @return void
     * @since 5.1.0
     */
    public function unserialize($serialized)
    {
        $this->report = unserialize($serialized);
    }
    /**
     * Gets the name of the handler class. This class will be used to handle this task.
     *
     * @return string
     */
    public function getHandler()
    {
        return "\\Classes\\Handler\\ReportHandler";
    }
    /**
     * Gets the data collected in this task.
     *
     * @return array
     */
    public function getData()
    {
        return ["report"=>$this->report];
    }
    /**
     * Instructs a manager to ignore any rules that would prevent this task from being immediately
     * handled.
     *
     * @return bool
     */
    public function ignoresRules()
    {
        return false;
    }
    /**
     * Instructs a manager to stop all tasks of the same type before running this task.
     *
     * @return bool
     */
    public function stopsSiblings()
    {
        return false;
    }
    /**
     * Check if this task is able to be run
     *
     * @return bool
     */
    public function canRunTask()
    {
        return true;
    }
    /**
     * @param int $id
     */
    public function setId($id)
    {
        $this->id = $id;
    }
    /**
     * @return null|int
     */
    public function getId()
    {
        return $this->id;
    }
    /**
     * Gets the number of seconds until this task or process expires.
     *
     * @return int
     */
    public function getExpiresIn()
    {
        return -1;
    }
    /**
     * Checks whether a task or process should expire. This is called when a manager thinks a task
     * or process should expire.
     *
     * @param int $startedAt
     *
     * @return bool
     */
    public function shouldExpire($startedAt)
    {
        return false;
    }
}