public
|
#
__construct( string $key, string $title )
Constructor.
Parameters
Throws
InvalidArgumentException InvalidArgumentException
|
|
public
string
|
#
getKey( )
Returns the page key.
Returns
string string
|
|
public
string
|
#
getFullKey( )
Returns the full page path.
Returns the full page path.
Returns
string string
|
|
public
|
#
getTitle( )
Returns the title.
Returns
string
|
|
public
mixed
|
#
setHref( string|array $href )
Sets the page href.
Parameters
- $href
- Href string or array of params
Returns
mixed $this
|
|
public
boolean
|
#
hasHref( )
Returns whether the page has a custom href.
Returns whether the page has a custom href.
Returns
boolean bool
|
|
public
string
|
#
getHref( )
Returns the page href.
Returns
string string
|
|
public
mixed
|
#
setItemAttr( string $name, string $value )
Sets an item attribute.
Parameters
Returns
mixed $this
Throws
InvalidArgumentException InvalidArgumentException
|
|
public
string|array
|
#
getItemAttr( string|null $name, string $default = '' )
Returns an item attribute or all item attributes.
Returns an item attribute or all item attributes.
Parameters
Returns
string|array Attribute value for given $name or attribute array if
$name is null
|
|
public
|
#
removeItemAttr( string $name )
Removes an item attribute.
Removes an item attribute.
Parameters
|
|
public
mixed
|
#
addItemClass( string $class )
Adds an item class.
Parameters
Returns
mixed $this
Throws
InvalidArgumentException InvalidArgumentException
|
|
public
|
|
|
public
mixed
|
#
setLinkAttr( string $name, string $value )
Sets an link attribute.
Parameters
Returns
mixed $this
Throws
InvalidArgumentException InvalidArgumentException
|
|
public
|
#
removeLinkAttr( string $name )
Removes an link attribute.
Removes an link attribute.
Parameters
|
|
public
string|array
|
#
getLinkAttr( string|null $name, string $default = '' )
Returns an link attribute or all link attributes.
Returns an link attribute or all link attributes.
Parameters
Returns
string|array Attribute value for given $name or attribute array if
$name is null
|
|
public
mixed
|
#
addLinkClass( string $class )
Adds an link class.
Parameters
Returns
mixed $this
Throws
InvalidArgumentException InvalidArgumentException
|
|
public
|
|
|
public
mixed
|
#
setPath( string $path )
Set the page path which will be included directly by the core.
Set the page path which will be included directly by the core.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
hasPath( )
Returns whether a path is set.
Returns whether a path is set.
Returns
boolean bool
|
|
public
string
|
#
getPath( )
Returns the path which will be included directly by the core.
Returns the path which will be included directly by the core.
Returns
string string
|
|
public
mixed
|
#
setSubPath( string $subPath )
Set the page subpath which should be used by the packages to include this
page inside their main page.
Set the page subpath which should be used by the packages to include this
page inside their main page.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
hasSubPath( )
Returns whether a subpath is set.
Returns whether a subpath is set.
Returns
boolean bool
|
|
public
string
|
#
getSubPath( )
Returns the subpath which should by used by packages to include this page
inside their main page.
Returns the subpath which should by used by packages to include this page
inside their main page.
Returns
string string
|
|
public
mixed
|
|
|
public
mixed
|
#
setSubpages( array $subpages )
Sets all subpages.
Parameters
Returns
mixed $this
|
|
public
self
|
#
getSubpage( string $key )
Returns the subpage for the given key.
Returns the subpage for the given key.
Parameters
Returns
self self
|
|
public
self[]
|
|
|
public
self
|
#
getFirstSubpagesLeaf( )
Returns the first leaf of the subpages tree.
Returns the first leaf of the subpages tree.
Returns
self self
|
|
public
mixed
|
#
setIsActive( boolean $isActive = true )
Sets whether the page is active.
Sets whether the page is active.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
isActive( )
Returns whether the page is active.
Returns whether the page is active.
Returns
boolean bool
|
|
public
self|null
|
#
getParent( )
Returns the parent page object.
Returns the parent page object.
Returns
self|null self|null
|
|
public
mixed
|
#
setHidden( boolean $hidden = true )
Sets whether the page is hidden.
Sets whether the page is hidden.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
isHidden( )
Returns whether the page is hidden.
Returns whether the page is hidden.
Returns
boolean bool
|
|
public
mixed
|
#
setHasLayout( boolean $hasLayout )
Sets whether the page has layout.
Sets whether the page has layout.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
hasLayout( )
Returns whether tha page has layout.
Returns whether tha page has layout.
Returns
boolean bool
|
|
public
mixed
|
#
setHasNavigation( boolean $hasNavigation )
Sets whether the page has a navigation.
Sets whether the page has a navigation.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
hasNavigation( )
Returns whether the page has a navigation.
Returns whether the page has a navigation.
Returns
boolean bool
|
|
public
mixed
|
#
setPjax( boolean $pjax = true )
Sets whether the page allows pjax.
Sets whether the page allows pjax.
Parameters
Returns
mixed $this
|
|
public
boolean
|
#
allowsPjax( )
Returns whether the page allows pjax.
Returns whether the page allows pjax.
Returns
boolean bool
|
|
public
mixed
|
#
setIcon( string $icon )
Sets whether the page has an icon.
Sets whether the page has an icon.
Parameters
Returns
mixed $this
|
|
public
|
#
getIcon( )
Returns the icon.
Returns
string
|
|
public
boolean
|
#
hasIcon( )
Returns whether the page has an icon.
Returns whether the page has an icon.
Returns
boolean bool
|
|
public
mixed
|
#
setRequiredPermissions( array|string $perm )
Sets the required permissions.
Sets the required permissions.
Parameters
Returns
mixed $this
|
|
public
array
|
|
|
public
boolean
|
#
checkPermission( rex_user $rexUser )
Checks whether the given user has permission for the page.
Checks whether the given user has permission for the page.
Parameters
Returns
boolean bool
|
|