JobQueued.php

TLDR

This file contains the JobQueued class in the Illuminate\Queue\Events namespace. The class represents an event that is fired when a job is queued. It holds information about the connection name, job ID, job instance, and job payload. The class provides a method to retrieve the decoded job payload.

Classes

JobQueued

The JobQueued class represents an event that is fired when a job is queued. It has the following properties:

• $connectionName (string): The connection name.
• $id (string|int|null): The job ID.
• $job (\Closure|string|object): The job instance.
• $payload (string|null): The job payload.

The class provides the following methods:

• __construct($connectionName, $id, $job, $payload = null): Creates a new instance of the JobQueued event.
• payload(): Retrieves the decoded job payload. If no payload was provided, a RuntimeException is thrown.

<?php

namespace Illuminate\Queue\Events;

use RuntimeException;

class JobQueued
{
    /**
     * The connection name.
     *
     * @var string
     */
    public $connectionName;

    /**
     * The job ID.
     *
     * @var string|int|null
     */
    public $id;

    /**
     * The job instance.
     *
     * @var \Closure|string|object
     */
    public $job;

    /**
     * The job payload.
     *
     * @var string|null
     */
    public $payload;

    /**
     * Create a new event instance.
     *
     * @param  string  $connectionName
     * @param  string|int|null  $id
     * @param  \Closure|string|object  $job
     * @param  string|null  $payload
     * @return void
     */
    public function __construct($connectionName, $id, $job, $payload = null)
    {
        $this->connectionName = $connectionName;
        $this->id = $id;
        $this->job = $job;
        $this->payload = $payload;
    }

    /**
     * Get the decoded job payload.
     *
     * @return array
     */
    public function payload()
    {
        if ($this->payload === null) {
            throw new RuntimeException('The job payload was not provided when the event was dispatched.');
        }

        return json_decode($this->payload, true, flags: JSON_THROW_ON_ERROR);
    }
}