PageLocator
in package
Class PageLocator
Tags
Table of Contents
- $defaultLanguage : string
- Default language
- $language : string
- Current language
- $themeInfo : ThemeInfo
- Theme info service
- $types : array<string|int, mixed>
- Types/formats of content
- __construct() : mixed
- Page constructor.
- determineTemplateAndRenderer() : array<string|int, mixed>|null
- Try to find template information about desired page
- generateTemplateFromPattern() : string
- Generate a template from a file search pattern. Examples: - %pathPrefix%/%pageName%{_%language%} => content/help_en - %pathPrefix%/%language%/%pageName% => HelpTranslations/en/search
- getTemplateOptionsFromPattern() : Generator
- Try to find a template using 1) Current language 2) Default language 3) No language
Properties
$defaultLanguage
Default language
protected
string
$defaultLanguage
$language
Current language
protected
string
$language
$themeInfo
Theme info service
protected
ThemeInfo
$themeInfo
$types
Types/formats of content
protected
array<string|int, mixed>
$types
= ['phtml', 'md']
Methods
__construct()
Page constructor.
public
__construct(ThemeInfo $themeInfo, string $language, string $defaultLanguage) : mixed
Parameters
- $themeInfo : ThemeInfo
-
Theme information service
- $language : string
-
Current language
- $defaultLanguage : string
-
Main configuration
Return values
mixed —determineTemplateAndRenderer()
Try to find template information about desired page
public
determineTemplateAndRenderer(string $pathPrefix, string $pageName[, string $pattern = null ]) : array<string|int, mixed>|null
Parameters
- $pathPrefix : string
-
Subdirectory where the template should be located
- $pageName : string
-
Template name
- $pattern : string = null
-
Optional filesystem pattern
Return values
array<string|int, mixed>|null —Null if template is not found or array with keys renderer (type of template), path (full path of template), relativePath (relative path within the templates directory), page (page name), theme, matchType (see getTemplateOptionsFromPattern)
generateTemplateFromPattern()
Generate a template from a file search pattern. Examples: - %pathPrefix%/%pageName%{_%language%} => content/help_en - %pathPrefix%/%language%/%pageName% => HelpTranslations/en/search
protected
generateTemplateFromPattern(string $pathPrefix, string $pageName, string $pattern[, string $language = '' ]) : string
Parameters
- $pathPrefix : string
-
Subdirectory where the template should be located
- $pageName : string
-
Page name
- $pattern : string
-
Filesystem pattern
- $language : string = ''
-
Language
Return values
string —getTemplateOptionsFromPattern()
Try to find a template using 1) Current language 2) Default language 3) No language
protected
getTemplateOptionsFromPattern(string $pathPrefix, string $pageName, string $pattern) : Generator
Parameters
- $pathPrefix : string
-
Subdirectory where the template should be located
- $pageName : string
-
Template name
- $pattern : string
-
Filesystem pattern
Return values
Generator —Array generator with template options (key equals matchType)