RouteConfig

Namespace

IO\Helper

Constants
Type Name Value Description

string

BASKET

'basket'

string

CANCELLATION_RIGHTS

'cancellation-rights'

string

CANCELLATION_FORM

'cancellation-form'

string

CATEGORY

'category'

string

CHANGE_MAIL

'change-mail'

string

CHECKOUT

'checkout'

string

CONFIRMATION

'confirmation'

string

CONTACT

'contact'

string

HOME

'home'

string

ITEM

'item'

string

LEGAL_DISCLOSURE

'legal-disclosure'

string

LOGIN

'login'

string

MY_ACCOUNT

'my-account'

string

NEWSLETTER_OPT_IN

'newsletter-opt-in'

string

NEWSLETTER_OPT_OUT

'newsletter-opt-out'

string

ORDER_DOCUMENT

'order-document'

string

ORDER_PROPERTY_FILE

'order-property-file'

string

ORDER_RETURN

'order-return'

string

ORDER_RETURN_CONFIRMATION

'order-return-confirmation'

string

PASSWORD_RESET

'password-reset'

string

PLACE_ORDER

'place-order'

string

PRIVACY_POLICY

'privacy-policy'

string

REGISTER

'register'

string

SEARCH

'search'

string

TERMS_CONDITIONS

'gtc'

string

WISH_LIST

'wish-list'

string

PAGE_NOT_FOUND

'page-not-found'

string

TAGS

'tags'

array

ALL

['basket','cancellation-rights','cancellation-form','category','change-mail','checkout','confirmation','contact','home','item','legal-disclosure','login','my-account','newsletter-opt-in','newsletter-opt-out','order-document','order-property-file','order-return','order-return-confirmation','password-reset','place-order','privacy-policy','register','search','tags','gtc','wish-list','page-not-found']

Properties
Type Name Description

``

$enabledRoutes

``

$overrides

Methods
public static getEnabledRoutes():array

Get all enabled routes from the plugin config.

public static isActive($route):bool

Check if a route is enabled and no category is linked for this page.

Parameters

Type

Name

Description

string

$route

The route to check active state for.

public static getCategoryId($route):int

Get the id of the category linked to a specific route.

Parameters

Type

Name

Description

string

$route

The route to get the linked category id for.

public static overrideCategoryId($route, $categoryId)

Override the currently linked category id for a specific route.

Parameters

Type

Name

Description

string

$route

The route to override the linked category for.

int

$categoryId

The id of the category to override.

public static passThroughBlogRoutes():bool

Check if blog routes should be recognized by the route service provider or not.