Documentation

ChannelSiteRoute extends ResourceModel
in package

Tags

Table of Contents

$id  : int
$matching  : string
For a given type, which resources should match this route? e.g For a route with the type: “product” and matching: “5” this route would be used for the product with the ID of 5.
$route  : string
The route template that will be used to generate the URL for the requested resource.
$type  : string
__construct()  : mixed
jsonSerialize()  : array<string|int, mixed>

Properties

$matching

For a given type, which resources should match this route? e.g For a route with the type: “product” and matching: “5” this route would be used for the product with the ID of 5.

public string $matching

Depending on the type of resource, this may be an ID (matching a specific item), or a “*” wildcard matching all items of that type.

Tags

$route

The route template that will be used to generate the URL for the requested resource.

public string $route

Supports several tokens:

{id} The ID of the requested item {slug} The slug for the requested item (if available). Note: the slug value may contain / slash {language} The language string that the client is using

Tags

Methods

__construct()

public __construct([stdClass|null $optionObject = null ]) : mixed
Parameters
$optionObject : stdClass|null = null
Tags
Return values
mixed

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

        

Search results