Route
extends Route
in package
Uses
EnumResolverTrait
This is the Route class for the Routes that are not generated by the API.
Extends SDKRoute and overrides some methods.
Tags
Table of Contents
| UNDEFINED | = 'undefined' | |
|---|---|---|
| __construct() | Route constructor. | : mixed |
| getDevice() | This method returns the device. | : string |
| getId() | Overrides getId() in SDKRoute Analizes if the Route type is page and pageType is RouteType::CATEGORY for return the category Id | : int |
| getOS() | This method returns the OS. | : string |
| getPage() | This method returns the page. | : Page|null |
| getStatus() | {@inheritdoc} | : int |
| getType() | Overrides getType() in SDKRoute Analizes if the Route type is page for return the pageType as type | : string |
Constants
UNDEFINED
public
mixed
UNDEFINED
= 'undefined'
Methods
__construct()
Route constructor.
public
__construct([array<string|int, mixed> $data = [] ][, Page $page = null ]) : mixed
Overrides __construct() in SDKRoute
Parameters
- $data : array<string|int, mixed> = []
-
Array that contains all the values to initialize the Route object.
- $page : Page = null
-
Page to be set to the Route object.
Tags
Return values
mixed —getDevice()
This method returns the device.
public
static getDevice() : string
Return values
string —getId()
Overrides getId() in SDKRoute Analizes if the Route type is page and pageType is RouteType::CATEGORY for return the category Id
public
getId() : int
Tags
Return values
int —getOS()
This method returns the OS.
public
static getOS() : string
Return values
string —getPage()
This method returns the page.
public
getPage() : Page|null
Return values
Page|null —getStatus()
{@inheritdoc}
public
getStatus() : int
Tags
Return values
int —getType()
Overrides getType() in SDKRoute Analizes if the Route type is page for return the pageType as type
public
getType() : string