master

laravel/framework

Last updated at: 29/12/2023 09:21

QueueableEntity.php

TLDR

This file defines an interface called QueueableEntity in the Illuminate\Contracts\Queue namespace. The interface includes three methods: getQueueableId(), getQueueableRelations(), and getQueueableConnection().

Methods

getQueueableId

This method returns the queueable identity for the entity. It must return a value of any type.

getQueueableRelations

This method returns the relationships for the entity. It must return an array.

getQueueableConnection

This method returns the connection of the entity. It must return a string value or null.

<?php

namespace Illuminate\Contracts\Queue;

interface QueueableEntity
{
    /**
     * Get the queueable identity for the entity.
     *
     * @return mixed
     */
    public function getQueueableId();

    /**
     * Get the relationships for the entity.
     *
     * @return array
     */
    public function getQueueableRelations();

    /**
     * Get the connection of the entity.
     *
     * @return string|null
     */
    public function getQueueableConnection();
}