phpDocumentor

PagePosition
in package
implements ContentPositionInterface

Class PagePosition

This class represents the position of a page

Tags
category

System

Interfaces, Classes and Traits

ContentPositionInterface
Interface ContentPositionInterface

Table of Contents

ADDITIONAL  = 'additional'
Additional Page position
INFO  = 'info'
Info position
INFO_BOX  = 'infoBox'
Info box position
MAIN_NAVIGATION  = 'mainNavigation'
Main navigation position
SECONDARY_NAVIGATION  = 'secondaryNavigation'
Secondary navigation position
$position  : string
Page position
createForAdditional()  : PagePosition
Create instance for info box position
createForInfo()  : PagePosition
Create instance for info position
createForInfoBox()  : PagePosition
Create instance for info box position
createForMainNavigation()  : PagePosition
Create instance for main navigation position
createForSecondaryNavigation()  : PagePosition
Create instance for secondary navigation position
createFromString()  : PagePosition
Create instance from a position string
position()  : string
Return the position
__construct()  : mixed
PagePosition constructor

Constants

ADDITIONAL

Additional Page position

public mixed ADDITIONAL = 'additional'

MAIN_NAVIGATION

Main navigation position

public mixed MAIN_NAVIGATION = 'mainNavigation'

SECONDARY_NAVIGATION

Secondary navigation position

public mixed SECONDARY_NAVIGATION = 'secondaryNavigation'

Properties

Methods

createFromString()

Create instance from a position string

public static createFromString(string $position) : PagePosition
Parameters
$position : string

Position as string

Return values
PagePosition

position()

Return the position

public position() : string
Return values
string

__construct()

PagePosition constructor

protected __construct(string $position) : mixed
Parameters
$position : string

Page position

Return values
mixed

Search results