FileAccess Orion

Alias
in package

Table of Contents

$defaultDeprecationTemplate  : mixed
$deprecated  : mixed
$deprecationTemplate  : mixed
$id  : mixed
$private  : mixed
$public  : mixed
__construct()  : mixed
__toString()  : string
Returns the Id of this alias.
getDeprecationMessage()  : string
isDeprecated()  : bool
isPrivate()  : bool
Whether this alias is private.
isPublic()  : bool
Checks if this DI Alias should be public or not.
setDeprecated()  : $this
Whether this alias is deprecated, that means it should not be referenced anymore.
setPrivate()  : $this
Sets if this Alias is private.
setPublic()  : $this
Sets if this Alias is public.

Properties

$defaultDeprecationTemplate

private static mixed $defaultDeprecationTemplate = 'The "%alias_id%" service alias is deprecated. You should stop using it, as it will be removed in the future.'

$deprecated

private mixed $deprecated

$deprecationTemplate

private mixed $deprecationTemplate

$private

private mixed $private

$public

private mixed $public

Methods

__construct()

public __construct(string $id[, bool $public = true ]) : mixed
Parameters
$id : string
$public : bool = true
Return values
mixed —

__toString()

Returns the Id of this alias.

public __toString() : string
Return values
string —

The alias id

getDeprecationMessage()

public getDeprecationMessage(string $id) : string
Parameters
$id : string
Return values
string —

isDeprecated()

public isDeprecated() : bool
Return values
bool —

isPrivate()

Whether this alias is private.

public isPrivate() : bool
Return values
bool —

isPublic()

Checks if this DI Alias should be public or not.

public isPublic() : bool
Return values
bool —

setDeprecated()

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

public setDeprecated([bool $status = true ][, string $template = null ]) : $this
Parameters
$status : bool = true

Whether this alias is deprecated, defaults to true

$template : string = null

Optional template message to use if the alias is deprecated

Tags
throws
InvalidArgumentException

when the message template is invalid

Return values
$this —

setPrivate()

Sets if this Alias is private.

public setPrivate(bool $boolean) : $this

When set, the "private" state has a higher precedence than "public". In version 3.4, a "private" alias always remains publicly accessible, but triggers a deprecation notice when accessed from the container, so that the alias can be made really private in 4.0.

Parameters
$boolean : bool
Return values
$this —

setPublic()

Sets if this Alias is public.

public setPublic(bool $boolean) : $this
Parameters
$boolean : bool
Return values
$this —

Search results