Documentation

Alias
in package

Table of Contents

$deprecation  : mixed
$id  : mixed
__construct()  : mixed
getDeprecation()  : array<string|int, mixed>
getId()  : string
Returns the target name of this alias.
isDeprecated()  : bool
setDeprecated()  : $this
Whether this alias is deprecated, that means it should not be referenced anymore.
withId()  : static

Properties

$deprecation

private mixed $deprecation = []

Methods

__construct()

public __construct(string $id) : mixed
Parameters
$id : string
Return values
mixed

getDeprecation()

public getDeprecation(string $name) : array<string|int, mixed>
Parameters
$name : string

Route name relying on this alias

Return values
array<string|int, mixed>

getId()

Returns the target name of this alias.

public getId() : string
Return values
string

The target name

isDeprecated()

public isDeprecated() : bool
Return values
bool

setDeprecated()

Whether this alias is deprecated, that means it should not be referenced anymore.

public setDeprecated(string $package, string $version, string $message) : $this
Parameters
$package : string

The name of the composer package that is triggering the deprecation

$version : string

The version of the package that introduced the deprecation

$message : string

The deprecation message to use

Tags
throws
InvalidArgumentException

when the message template is invalid

Return values
$this

withId()

public withId(string $id) : static
Parameters
$id : string
Return values
static

Search results