master

laravel/framework

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

QueueingFactory.php

TLDR

The provided file, QueueingFactory.php, is an interface file for working with cookies in the Laravel framework. It extends the Factory interface and defines three methods: queue(), unqueue(), and getQueuedCookies().

Methods

queue(...$parameters)

This method is used to queue a cookie to be sent with the next response. It accepts any number of parameters and does not return a value.

unqueue($name, $path = null)

This method is used to remove a cookie from the queue. It accepts the cookie name as the first parameter and an optional path as the second parameter. It does not return a value.

getQueuedCookies()

This method is used to get the cookies that have been queued for the next request. It returns an array of the queued cookies.

<?php

namespace Illuminate\Contracts\Cookie;

interface QueueingFactory extends Factory
{
    /**
     * Queue a cookie to send with the next response.
     *
     * @param  mixed  ...$parameters
     * @return void
     */
    public function queue(...$parameters);

    /**
     * Remove a cookie from the queue.
     *
     * @param  string  $name
     * @param  string|null  $path
     * @return void
     */
    public function unqueue($name, $path = null);

    /**
     * Get the cookies which have been queued for the next request.
     *
     * @return array
     */
    public function getQueuedCookies();
}