TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode:
TYPO3\CMS\Backend\Tree\ExtDirectNode TYPO3\CMS\Backend\Tree\TreeNode TYPO3\CMS\Backend\Tree\ComparableNodeInterface t3lib_tree_pagetree_Node

Public Member Functions

 setBackgroundColor ($backgroundColor)
 
 getBackgroundColor ()
 
 setWorkspaceId ($workspaceId)
 
 getWorkspaceId ()
 
 setMountPoint ($mountPoint)
 
 getMountPoint ()
 
 setIsMountPoint ($isMountPoint)
 
 isMountPoint ()
 
 setReadableRootline ($rootline)
 
 getReadableRootline ()
 
 canBeDisabledAndEnabled ()
 
 canBeCut ()
 
 canBeEdited ()
 
 canBeCopied ()
 
 canCreateNewPages ()
 
 canBeRemoved ()
 
 canBePastedInto ()
 
 canBePastedAfter ()
 
 canShowHistory ()
 
 canBeViewed ()
 
 canShowInfo ()
 
 canBeTemporaryMountPoint ()
 
 isDeleted ()
 
 calculateNodeId ($prefix='p')
 
 toArray ($addChildNodes=TRUE)
 
 dataFromArray ($data)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Tree\ExtDirectNode
 setType ($type)
 
 getType ()
 
 setLeaf ($isLeaf)
 
 isLeafNode ()
 
 setExpandable ($expandable)
 
 isExpandable ()
 
 setExpanded ($expanded)
 
 isExpanded ()
 
 setDraggable ($draggable)
 
 isDraggable ()
 
 setIsDropTarget ($isDropTarget)
 
 isDropTarget ()
 
 setText ($text, $textSourceField='title', $prefix='', $suffix='')
 
 getText ()
 
 setEditableText ($editableText)
 
 getEditableText ()
 
 getTextSourceField ()
 
 setInCopyMode ($inCopyMode)
 
 isInCopyMode ()
 
 setInCutMode ($inCutMode)
 
 isInCutMode ()
 
 getPrefix ()
 
 getSuffix ()
 
 setCls ($class)
 
 getCls ()
 
 setQTip ($qtip)
 
 getQTip ()
 
 setSpriteIconCode ($spriteIcon)
 
 getSpriteIconCode ()
 
 setLabelIsEditable ($labelIsEditable)
 
 isLabelEditable ()
 
 setRecord ($record)
 
 getRecord ()
 
 setContextInfo ($contextInfo)
 
 getContextInfo ()
 
 setChildNodes (\TYPO3\CMS\Backend\Tree\TreeNodeCollection $childNodes)
 
 setAllowChildren ($allowChildren)
 
 canHaveChildren ()
 
 toArray ($addChildNodes=TRUE)
 
 dataFromArray ($data)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Tree\TreeNode
 __construct (array $data=array())
 
 setChildNodes (\TYPO3\CMS\Backend\Tree\TreeNodeCollection $childNodes)
 
 removeChildNodes ()
 
 getChildNodes ()
 
 hasChildNodes ()
 
 setId ($id)
 
 getId ()
 
 setParentNode (\TYPO3\CMS\Backend\Tree\TreeNode $parentNode=NULL)
 
 getParentNode ()
 
 equals (\TYPO3\CMS\Backend\Tree\TreeNode $other)
 
 compareTo ($other)
 
 toArray ($addChildNodes=TRUE)
 
 dataFromArray ($data)
 
 serialize ()
 
 unserialize ($serializedString)
 

Protected Member Functions

 canCreate ()
 
 canEdit ()
 
 canRemove ()
 

Protected Attributes

 $cachedAccessRights = array()
 
 $workspaceId = 0
 
 $mountPoint = 0
 
 $readableRootline = ''
 
 $isMountPoint = FALSE
 
 $backgroundColor = ''
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Tree\ExtDirectNode
 $type = ''
 
 $leaf = TRUE
 
 $expanded = FALSE
 
 $expandable = FALSE
 
 $draggable = TRUE
 
 $isDropTarget = TRUE
 
 $text = ''
 
 $editableText = ''
 
 $prefix = ''
 
 $suffix = ''
 
 $cls = ''
 
 $qtip = ''
 
 $spriteIconCode = ''
 
 $t3TextSourceField = ''
 
 $t3InCopyMode = FALSE
 
 $t3InCutMode = FALSE
 
 $record = array()
 
 $contextInfo = array()
 
 $labelIsEditable = TRUE
 
 $allowChildren = TRUE
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Tree\TreeNode
 $id = ''
 
 $parentNode = NULL
 
 $childNodes = NULL
 

Detailed Description

Node designated for the page tree

Author
Stefan Galinski stefa.nosp@m.n.ga.nosp@m.linsk.nosp@m.i@gm.nosp@m.ail.c.nosp@m.om

Definition at line 24 of file PagetreeNode.php.

Member Function Documentation

◆ calculateNodeId()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::calculateNodeId (   $prefix = 'p')

Returns the calculated id representation of this node

Parameters
string$prefixDefaults to 'p'
Returns
string

Definition at line 348 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\ExtDirectNode\$prefix, TYPO3\CMS\Backend\Tree\TreeNode\getId(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getMountPoint().

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\toArray().

◆ canBeCopied()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeCopied ( )

Checks if the page is allowed to be copied

Returns
boolean

Definition at line 238 of file PagetreeNode.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canCreate(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Tree\TreeNode\equals().

◆ canBeCut()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeCut ( )

Checks if the page is allowed to can be cut

Returns
boolean

Definition at line 216 of file PagetreeNode.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canEdit(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Tree\TreeNode\equals().

◆ canBeDisabledAndEnabled()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeDisabledAndEnabled ( )

Checks if the page can be disabled

Returns
boolean

Definition at line 207 of file PagetreeNode.php.

References $GLOBALS, and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canEdit().

◆ canBeEdited()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeEdited ( )

Checks if the page is allowed to be edited

Returns
boolean

Definition at line 229 of file PagetreeNode.php.

References $GLOBALS, and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canEdit().

◆ canBePastedAfter()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBePastedAfter ( )

Checks if something can be pasted after the node

Returns
boolean

Definition at line 286 of file PagetreeNode.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canCreate(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Tree\TreeNode\equals().

◆ canBePastedInto()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBePastedInto ( )

Checks if something can be pasted into the node

Returns
boolean

Definition at line 273 of file PagetreeNode.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canCreate(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Tree\TreeNode\equals().

◆ canBeRemoved()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeRemoved ( )

Checks if the page is allowed to be removed

Returns
boolean

Definition at line 260 of file PagetreeNode.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canRemove(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Tree\TreeNode\equals().

◆ canBeTemporaryMountPoint()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeTemporaryMountPoint ( )

Checks if the page is allowed to be a temporary mount point

Returns
boolean

Definition at line 326 of file PagetreeNode.php.

◆ canBeViewed()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canBeViewed ( )

Checks if the page is allowed to be viewed

Returns
boolean

Definition at line 308 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\isDeleted().

◆ canCreate()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canCreate ( )
protected

Checks if the user may create pages below the given page

Returns
boolean

Definition at line 168 of file PagetreeNode.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBeCopied(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBePastedAfter(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBePastedInto(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canCreateNewPages().

◆ canCreateNewPages()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canCreateNewPages ( )

Checks if there can be new pages created

Returns
boolean

Definition at line 251 of file PagetreeNode.php.

References $GLOBALS, and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canCreate().

◆ canEdit()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canEdit ( )
protected

Checks if the user has editing rights

Returns
boolean

Definition at line 180 of file PagetreeNode.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBeCut(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBeDisabledAndEnabled(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBeEdited().

◆ canRemove()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canRemove ( )
protected

Checks if the user has the right to delete the page

Returns
boolean

Definition at line 192 of file PagetreeNode.php.

References $GLOBALS, and TYPO3\CMS\Backend\Tree\ExtDirectNode\isLeafNode().

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBeRemoved().

◆ canShowHistory()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canShowHistory ( )

Checks if the page is allowed to show history

Returns
boolean

Definition at line 299 of file PagetreeNode.php.

References $GLOBALS.

◆ canShowInfo()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::canShowInfo ( )

Checks if the page is allowed to show info

Returns
boolean

Definition at line 317 of file PagetreeNode.php.

◆ dataFromArray()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::dataFromArray (   $data)

Sets data of the node by a given data array

Parameters
array$data
Returns
void

Definition at line 379 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setBackgroundColor(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setIsMountPoint(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setMountPoint(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setReadableRootline(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setWorkspaceId().

◆ getBackgroundColor()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::getBackgroundColor ( )

Returns the background color

Returns
string

Definition at line 83 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$backgroundColor.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\toArray().

◆ getMountPoint()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::getMountPoint ( )

Returns the mount point id

Returns
integer

Definition at line 121 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$mountPoint.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\calculateNodeId(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\toArray().

◆ getReadableRootline()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::getReadableRootline ( )

Returns the readable rootline

Returns
string

Definition at line 159 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$readableRootline.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\toArray().

◆ getWorkspaceId()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::getWorkspaceId ( )

Returns the original id of the element

Returns
integer

Definition at line 102 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$workspaceId.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\toArray().

◆ isDeleted()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::isDeleted ( )

Determines whether this node is deleted.

Returns
bool

Definition at line 335 of file PagetreeNode.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, and TYPO3\CMS\Backend\Tree\TreeNode\equals().

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\canBeViewed().

◆ isMountPoint()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::isMountPoint ( )

Returns TRUE if the node is a mount point

Returns
boolean

Definition at line 140 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$isMountPoint.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setIsMountPoint(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\toArray().

◆ setBackgroundColor()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::setBackgroundColor (   $backgroundColor)

Sets the background color

Parameters
string$backgroundColor
Returns
void

Definition at line 74 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$backgroundColor.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\dataFromArray().

◆ setIsMountPoint()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::setIsMountPoint (   $isMountPoint)

Sets the indicator if the node is a mount point

Parameters
boolean$isMountPoint
Returns
void

Definition at line 131 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$isMountPoint, and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\isMountPoint().

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\dataFromArray().

◆ setMountPoint()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::setMountPoint (   $mountPoint)

Sets the mount point id

Parameters
integer$mountPoint
Returns
void

Definition at line 112 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$mountPoint.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\dataFromArray().

◆ setReadableRootline()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::setReadableRootline (   $rootline)

Sets the readable rootline

Parameters
string$rootline
Returns
void

Definition at line 150 of file PagetreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\dataFromArray().

◆ setWorkspaceId()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::setWorkspaceId (   $workspaceId)

Set's the original id of the element

Parameters
integer$workspaceId
Returns
void

Definition at line 93 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\$workspaceId.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\dataFromArray().

◆ toArray()

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::toArray (   $addChildNodes = TRUE)

Returns the node in an array representation that can be used for serialization

Parameters
boolean$addChildNodes
Returns
array

Definition at line 358 of file PagetreeNode.php.

References TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\calculateNodeId(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getBackgroundColor(), TYPO3\CMS\Backend\Tree\TreeNode\getId(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getMountPoint(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getReadableRootline(), TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getWorkspaceId(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\isMountPoint().

Member Data Documentation

◆ $backgroundColor

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::$backgroundColor = ''
protected

Definition at line 66 of file PagetreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getBackgroundColor(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setBackgroundColor().

◆ $cachedAccessRights

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::$cachedAccessRights = array()
protected

Definition at line 31 of file PagetreeNode.php.

◆ $isMountPoint

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::$isMountPoint = FALSE
protected

Definition at line 59 of file PagetreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\isMountPoint(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setIsMountPoint().

◆ $mountPoint

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::$mountPoint = 0
protected

Definition at line 45 of file PagetreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getMountPoint(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setMountPoint().

◆ $readableRootline

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::$readableRootline = ''
protected

Definition at line 52 of file PagetreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getReadableRootline().

◆ $workspaceId

TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode::$workspaceId = 0
protected

Definition at line 38 of file PagetreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\getWorkspaceId(), and TYPO3\CMS\Backend\Tree\Pagetree\PagetreeNode\setWorkspaceId().