Session

class Session extends Facade (View source)

Properties

static protected Application	$app	The application instance being facaded.	from Facade
static protected array	$resolvedInstance	The resolved object instances.	from Facade
static protected bool	$cached	Indicates if the resolved instance should be cached.	from Facade

Methods

static void

resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from Facade

static MockInterface

spy()

Convert the facade into a Mockery spy.

from Facade

static MockInterface

partialMock()

Initiate a partial mock on the facade.

from Facade

static Expectation

shouldReceive()

Initiate a mock expectation on the facade.

from Facade

static Expectation

expects()

Initiate a mock expectation on the facade.

from Facade

static MockInterface

createFreshMockInstance()

Create a fresh mock instance for the given class.

from Facade

static MockInterface

createMock()

Create a fresh mock instance for the given class.

from Facade

static bool

isMock()

Determines whether a mock is set as the instance of the facade.

from Facade

static string|null

getMockableClass()

Get the mockable class for the bound instance.

from Facade

static void

swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from Facade

static bool

isFake()

Determines whether a "fake" has been set as the facade instance.

from Facade

static mixed

getFacadeRoot()

Get the root object behind the facade.

from Facade

static string

getFacadeAccessor()

Get the registered name of the component.

static mixed

resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from Facade

static void

clearResolvedInstance(string $name)

Clear a resolved facade instance.

from Facade

static void

clearResolvedInstances()

Clear all of the resolved instances.

from Facade

static Collection

defaultAliases()

Get the application default aliases.

from Facade

static Application

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static bool

shouldBlock()

No description

static string|null

blockDriver()

No description

static array

getSessionConfig()

No description

static string

getDefaultDriver()

No description

static void

setDefaultDriver(string $name)

No description

static mixed

driver(string|null $driver = null)

No description

static SessionManager

extend(string $driver, Closure $callback)

No description

static array

getDrivers()

No description

static Container

getContainer()

No description

static SessionManager

setContainer(Container $container)

No description

static SessionManager

forgetDrivers()

No description

static bool

start()

No description

static void

save()

No description

static void

ageFlashData()

No description

static array

all()

No description

static array

only(array $keys)

No description

static bool

exists(string|array $key)

No description

static bool

missing(string|array $key)

No description

static bool

has(string|array $key)

No description

static mixed

get(string $key, mixed $default = null)

No description

static mixed

pull(string $key, mixed $default = null)

No description

static bool

hasOldInput(string|null $key = null)

No description

static mixed

getOldInput(string|null $key = null, mixed $default = null)

No description

static void

replace(array $attributes)

No description

static void

put(string|array $key, mixed $value = null)

No description

static mixed

remember(string $key, Closure $callback)

No description

static void

push(string $key, mixed $value)

No description

static mixed

increment(string $key, int $amount = 1)

No description

static int

decrement(string $key, int $amount = 1)

No description

static void

flash(string $key, mixed $value = true)

No description

static void

now(string $key, mixed $value)

No description

static void

reflash()

No description

static void

keep(array|mixed $keys = null)

No description

static void

flashInput(array $value)

No description

static mixed

remove(string $key)

No description

static void

forget(string|array $keys)

No description

static void

flush()

No description

static bool

invalidate()

No description

static bool

regenerate(bool $destroy = false)

No description

static bool

migrate(bool $destroy = false)

No description

static bool

isStarted()

No description

static string

getName()

No description

static void

setName(string $name)

No description

static string

getId()

No description

static void

setId(string|null $id)

No description

static bool

isValidId(string|null $id)

No description

static void

setExists(bool $value)

No description

static string

token()

No description

static void

regenerateToken()

No description

static string|null

previousUrl()

No description

static void

setPreviousUrl(string $url)

No description

static void

passwordConfirmed()

No description

static SessionHandlerInterface

getHandler()

No description

static SessionHandlerInterface

setHandler(SessionHandlerInterface $handler)

No description

static bool

handlerNeedsRequest()

No description

static void

setRequestOnHandler(Request $request)

No description

static void

macro(string $name, object|callable $macro)

No description

static void

mixin(object $mixin, bool $replace = true)

No description

static bool

hasMacro(string $name)

No description

static void

flushMacros()

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure

$callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed

$instance

Return Value

void

static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string

$name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string

$name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string	$method
array	$args

Return Value

mixed

Exceptions

RuntimeException

static bool shouldBlock()

No description

Return Value

bool

static string|null blockDriver()

No description

Return Value

string|null

static array getSessionConfig()

No description

Return Value

array

static string getDefaultDriver()

No description

Return Value

string

static void setDefaultDriver(string $name)

No description

Parameters

string

$name

Return Value

void

static mixed driver(string|null $driver = null)

No description

Parameters

string|null

$driver

Return Value

mixed

static SessionManager extend(string $driver, Closure $callback)

No description

Parameters

string	$driver
Closure	$callback

Return Value

SessionManager

static array getDrivers()

No description

Return Value

array

static Container getContainer()

No description

Return Value

Container

static SessionManager setContainer(Container $container)

No description

Parameters

Container

$container

Return Value

SessionManager

static SessionManager forgetDrivers()

No description

Return Value

SessionManager

static bool start()

No description

Return Value

bool

static void save()

No description

Return Value

void

static void ageFlashData()

No description

Return Value

void

static array all()

No description

Return Value

array

static array only(array $keys)

No description

Parameters

array

$keys

Return Value

array

static bool exists(string|array $key)

No description

Parameters

string|array

$key

Return Value

bool

static bool missing(string|array $key)

No description

Parameters

string|array

$key

Return Value

bool

static bool has(string|array $key)

No description

Parameters

string|array

$key

Return Value

bool

static mixed get(string $key, mixed $default = null)

No description

Parameters

string	$key
mixed	$default

Return Value

mixed

static mixed pull(string $key, mixed $default = null)

No description

Parameters

string	$key
mixed	$default

Return Value

mixed

static bool hasOldInput(string|null $key = null)

No description

Parameters

string|null

$key

Return Value

bool

static mixed getOldInput(string|null $key = null, mixed $default = null)

No description

Parameters

string\|null	$key
mixed	$default

Return Value

mixed

static void replace(array $attributes)

No description

Parameters

array

$attributes

Return Value

void

static void put(string|array $key, mixed $value = null)

No description

Parameters

string\|array	$key
mixed	$value

Return Value

void

static mixed remember(string $key, Closure $callback)

No description

Parameters

string	$key
Closure	$callback

Return Value

mixed

static void push(string $key, mixed $value)

No description

Parameters

string	$key
mixed	$value

Return Value

void

static mixed increment(string $key, int $amount = 1)

No description

Parameters

string	$key
int	$amount

Return Value

mixed

static int decrement(string $key, int $amount = 1)

No description

Parameters

string	$key
int	$amount

Return Value

int

static void flash(string $key, mixed $value = true)

No description

Parameters

string	$key
mixed	$value

Return Value

void

static void now(string $key, mixed $value)

No description

Parameters

string	$key
mixed	$value

Return Value

void

static void reflash()

No description

Return Value

void

static void keep(array|mixed $keys = null)

No description

Parameters

array|mixed

$keys

Return Value

void

static void flashInput(array $value)

No description

Parameters

array

$value

Return Value

void

static mixed remove(string $key)

No description

Parameters

string

$key

Return Value

mixed

static void forget(string|array $keys)

No description

Parameters

string|array

$keys

Return Value

void

static void flush()

No description

Return Value

void

static bool invalidate()

No description

Return Value

bool

static bool regenerate(bool $destroy = false)

No description

Parameters

bool

$destroy

Return Value

bool

static bool migrate(bool $destroy = false)

No description

Parameters

bool

$destroy

Return Value

bool

static bool isStarted()

No description

Return Value

bool

static string getName()

No description

Return Value

string

static void setName(string $name)

No description

Parameters

string

$name

Return Value

void

static string getId()

No description

Return Value

string

static void setId(string|null $id)

No description

Parameters

string|null

$id

Return Value

void

static bool isValidId(string|null $id)

No description

Parameters

string|null

$id

Return Value

bool

static void setExists(bool $value)

No description

Parameters

bool

$value

Return Value

void

static string token()

No description

Return Value

string

static void regenerateToken()

No description

Return Value

void

static string|null previousUrl()

No description

Return Value

string|null

static void setPreviousUrl(string $url)

No description

Parameters

string

$url

Return Value

void

static void passwordConfirmed()

No description

Return Value

void

static SessionHandlerInterface getHandler()

No description

Return Value

SessionHandlerInterface

static SessionHandlerInterface setHandler(SessionHandlerInterface $handler)

No description

Parameters

SessionHandlerInterface

$handler

Return Value

SessionHandlerInterface

static bool handlerNeedsRequest()

No description

Return Value

bool

static void setRequestOnHandler(Request $request)

No description

Parameters

Request

$request

Return Value

void

static void macro(string $name, object|callable $macro)

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Session.html