ResolveResult extends Result
Table of Contents
Methods
- getActivePage() : CustomSectionPage|null
- Get a page that is active now
- getAvailablePages() : array<string|int, CustomSectionPage>
- Returns pages that should be displayed for the current user
- getComponentToInclude() : Component|null
- Get params of component that should be included on page
- getCustomSection() : CustomSection
- Returns a resolved custom section
- setActivePage() : ResolveResult
- Set a page that is active now
- setAvailablePages() : ResolveResult
- Sets pages that should be displayed for the current user
- setComponentToInclude() : ResolveResult
- Set params of component that should be included on page
- setCustomSection() : ResolveResult
- Set a resolved custom section
Methods
getActivePage()
Get a page that is active now
public
getActivePage() : CustomSectionPage|null
Return values
CustomSectionPage|nullgetAvailablePages()
Returns pages that should be displayed for the current user
public
getAvailablePages() : array<string|int, CustomSectionPage>
Return values
array<string|int, CustomSectionPage>getComponentToInclude()
Get params of component that should be included on page
public
getComponentToInclude() : Component|null
Return values
Component|nullgetCustomSection()
Returns a resolved custom section
public
getCustomSection() : CustomSection
Return values
CustomSectionsetActivePage()
Set a page that is active now
public
setActivePage(CustomSectionPage $activePage) : ResolveResult
Parameters
- $activePage : CustomSectionPage
Return values
ResolveResultsetAvailablePages()
Sets pages that should be displayed for the current user
public
setAvailablePages(array<string|int, CustomSectionPage> $availablePages) : ResolveResult
Parameters
- $availablePages : array<string|int, CustomSectionPage>
Return values
ResolveResultsetComponentToInclude()
Set params of component that should be included on page
public
setComponentToInclude(Component|null $componentToInclude) : ResolveResult
Parameters
- $componentToInclude : Component|null
Return values
ResolveResultsetCustomSection()
Set a resolved custom section
public
setCustomSection(CustomSection $customSection) : ResolveResult
Parameters
- $customSection : CustomSection