BreadcrumbLink

API reference › Bootstrap 6 › item › BreadcrumbLink

final readonly class	`yii2\extensions\bootstrap6\item\BreadcrumbLink`
Uses traits	`ItemTrait`
Source	`src/item/BreadcrumbLink.php`

Represents a Breadcrumbs item: a link of the trail, or the active item.

Properties

Property	Type	Description	Defined by
`$active` readonly constructor	`bool\|null`	Whether the item is active, or `null` to make it active when `$url` is `null`. Default: `null`.	`BreadcrumbLink`
`$encode` readonly constructor	`bool\|null`	Whether to HTML-encode `$label`, or `null` to use `Breadcrumbs::$encodeLabels`. Default: `null`.	`BreadcrumbLink`
`$label` readonly constructor	`string\|Stringable`	Label of the `.breadcrumb-link` element.	`BreadcrumbLink`
`$options` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `.breadcrumb-link` element. Default: `[]`.	`BreadcrumbLink`
`$template` readonly constructor	`string\|null`	Template of the item, where `{link}` is replaced by the rendered link, or `null` to use the widget item templates. Default: `null`.	`BreadcrumbLink`
`$url` readonly constructor	`array<array-key, mixed>\|string\|null`	URL processed by `Url::to()`, or `null` for no `href`. Default: `null`.	`BreadcrumbLink`

Methods

Method	Description	Defined by
`fromArray()` static	Creates an item from the array configuration documented in `Breadcrumbs::$links`.	`BreadcrumbLink`
`to()` static	Creates an item.	`BreadcrumbLink`
`withActive()`	Returns a copy with the given active state.	`BreadcrumbLink`
`withEncode()`	Returns a copy with the given encoding flag.	`BreadcrumbLink`
`withLabel()`	Returns a copy with the given label.	`BreadcrumbLink`
`withOptions()`	Returns a copy with the given link attributes.	`BreadcrumbLink`
`withTemplate()`	Returns a copy with the given template.	`BreadcrumbLink`
`withUrl()`	Returns a copy with the given URL.	`BreadcrumbLink`

Method details

fromArray()

public static function fromArray(array<array-key, mixed> $config): self

Creates an item from the array configuration documented in Breadcrumbs::$links.

The active and encode keys, even null, make their value explicit; a url or template of another type is ignored; every other key becomes an attribute of the link.

Parameters

Parameter	Type	Description
`$config`	`array<array-key, mixed>`	Item configuration.

Returns

self

Throws

yii\base\InvalidConfigException: if the item has no string|Stringable label.

to()

public static function to(string|Stringable $label, array<array-key, mixed>|string|null $url = null): self

Creates an item.

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`	Link label.
`$url`	`array<array-key, mixed>\|string\|null`	URL processed by `Url::to()`, or `null` for the active item.

Returns

self

withActive()

public function withActive(bool|null $active): self

Returns a copy with the given active state.

Parameters

Parameter	Type	Description
`$active`	`bool\|null`

Returns

self

withEncode()

public function withEncode(bool|null $encode): self

Returns a copy with the given encoding flag.

Parameters

Parameter	Type	Description
`$encode`	`bool\|null`

Returns

self

withLabel()

public function withLabel(string|Stringable $label): self

Returns a copy with the given label.

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`

Returns

self

withOptions()

public function withOptions(array<array-key, mixed> $options): self

Returns a copy with the given link attributes.

Parameters

Parameter	Type	Description
`$options`	`array<array-key, mixed>`	HTML attributes of the link.

Returns

self

withTemplate()

public function withTemplate(string|null $template): self

Returns a copy with the given template.

Parameters

Parameter	Type	Description
`$template`	`string\|null`

Returns

self

withUrl()

public function withUrl(array<array-key, mixed>|string|null $url): self

Returns a copy with the given URL.

Parameters

Parameter	Type	Description
`$url`	`array<array-key, mixed>\|string\|null`	URL processed by `Url::to()`.

Returns

self