Class rex_be_page

Backend Page Class.

Direct known subclasses

rex_be_page_main

Package: redaxo\core\backend
Located at redaxo/src/core/lib/be/page.php

Methods summary

public
# __construct( string $key, string $title )

Constructor.

public string
# getKey( )

Returns the page key.

public string
# getFullKey( )

Returns the full page path.

public
# getTitle( )

Returns the title.

public mixed
# setPopup( boolean|string $popup )

Sets whether the page is a popup page.

public boolean
# isPopup( )

Returns whether the page is a popup.

public mixed
# setHref( string|array $href )

Sets the page href.

public boolean
# hasHref( )

Returns whether the page has a custom href.

public string
# getHref( )

Returns the page href.

public mixed
# setItemAttr( string $name, string $value )

Sets an item attribute.

public string|array
# getItemAttr( string|null $name, string $default = '' )

Returns an item attribute or all item attributes.

public
# removeItemAttr( string $name )

Removes an item attribute.

public mixed
# addItemClass( string $class )

Adds an item class.

public
# removeItemClass( string $class )

Removes an item class.

public mixed
# setLinkAttr( string $name, string $value )

Sets an link attribute.

public
# removeLinkAttr( string $name )

Removes an link attribute.

public string|array
# getLinkAttr( string|null $name, string $default = '' )

Returns an link attribute or all link attributes.

public mixed
# addLinkClass( string $class )

Adds an link class.

public
# removeLinkClass( string $class )

Removes an link class.

public mixed
# setPath( string $path )

Set the page path which will be included directly by the core.

public boolean
# hasPath( )

Returns whether a path is set.

public string
# getPath( )

Returns the path which will be included directly by the core.

public mixed
# setSubPath( string $subPath )

Set the page subpath which should be used by the packages to include this page inside their main page.

public boolean
# hasSubPath( )

Returns whether a subpath is set.

public string
# getSubPath( )

Returns the subpath which should by used by packages to include this page inside their main page.

public mixed
# addSubpage( rex_be_page $subpage )

Adds a subpage.

public mixed
# setSubpages( array $subpages )

Sets all subpages.

public self
# getSubpage( string $key )

Returns the subpage for the given key.

public self[]
# getSubpages( )

Returns all subpages.

public self
# getFirstSubpagesLeaf( )

Returns the first leaf of the subpages tree.

public mixed
# setIsActive( boolean $isActive = true )

Sets whether the page is active.

public boolean
# isActive( )

Returns whether the page is active.

public self|null
# getParent( )

Returns the parent page object.

public mixed
# setHidden( boolean $hidden = true )

Sets whether the page is hidden.

public boolean
# isHidden( )

Returns whether the page is hidden.

public mixed
# setHasLayout( boolean $hasLayout )

Sets whether the page has layout.

public boolean
# hasLayout( )

Returns whether tha page has layout.

public mixed
# setHasNavigation( boolean $hasNavigation )

Sets whether the page has a navigation.

public boolean
# hasNavigation( )

Returns whether the page has a navigation.

public mixed
# setPjax( boolean $pjax = true )

Sets whether the page allows pjax.

public boolean
# allowsPjax( )

Returns whether the page allows pjax.

public mixed
# setIcon( string $icon )

Sets whether the page has an icon.

public
# getIcon( )

Returns the icon.

public boolean
# hasIcon( )

Returns whether the page has an icon.

public mixed
# setRequiredPermissions( array|string $perm )

Sets the required permissions.

public array
# getRequiredPermissions( )

Returns the required permission.

public boolean
# checkPermission( rex_user $rexUser )

Checks whether the given user has permission for the page.