TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PagetreeNode Class Reference
Inheritance diagram for PagetreeNode:
ExtDirectNode TreeNode ComparableNodeInterface

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 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 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 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 TreeNode
 $id = ''
 
 $parentNode = null
 
 $childNodes = null
 

Detailed Description

Node designated for the page tree

Definition at line 22 of file PagetreeNode.php.

Member Function Documentation

calculateNodeId (   $prefix = 'p')

Returns the calculated id representation of this node

Parameters
string$prefixDefaults to 'p'
Returns
string

Definition at line 382 of file PagetreeNode.php.

References ExtDirectNode\$prefix, TreeNode\getId(), and PagetreeNode\getMountPoint().

Referenced by PagetreeNode\toArray().

canBeCopied ( )

Checks if the page is allowed to be copied

Returns
bool

Definition at line 262 of file PagetreeNode.php.

References $GLOBALS, PagetreeNode\canCreate(), Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, and TreeNode\equals().

canBeCut ( )

Checks if the page is allowed to can be cut

Returns
bool

Definition at line 238 of file PagetreeNode.php.

References $GLOBALS, PagetreeNode\canEdit(), Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, and TreeNode\equals().

canBeDisabledAndEnabled ( )

Checks if the page can be disabled

Returns
bool

Definition at line 228 of file PagetreeNode.php.

References $GLOBALS, and PagetreeNode\canEdit().

canBeEdited ( )

Checks if the page is allowed to be edited

Returns
bool

Definition at line 252 of file PagetreeNode.php.

References $GLOBALS, and PagetreeNode\canEdit().

canBePastedAfter ( )

Checks if something can be pasted after the node

Returns
bool

Definition at line 314 of file PagetreeNode.php.

References $GLOBALS, PagetreeNode\canCreate(), Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, and TreeNode\equals().

canBePastedInto ( )

Checks if something can be pasted into the node

Returns
bool

Definition at line 300 of file PagetreeNode.php.

References $GLOBALS, PagetreeNode\canCreate(), Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, and TreeNode\equals().

canBeRemoved ( )

Checks if the page is allowed to be removed

Returns
bool

Definition at line 286 of file PagetreeNode.php.

References $GLOBALS, PagetreeNode\canRemove(), Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, and TreeNode\equals().

canBeTemporaryMountPoint ( )

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

Returns
bool

Definition at line 358 of file PagetreeNode.php.

canBeViewed ( )

Checks if the page is allowed to be viewed

Returns
bool

Definition at line 338 of file PagetreeNode.php.

References PagetreeNode\isDeleted().

canCreate ( )
protected

Checks if the user may create pages below the given page

Returns
bool

Definition at line 176 of file PagetreeNode.php.

References $GLOBALS.

Referenced by PagetreeNode\canBeCopied(), PagetreeNode\canBePastedAfter(), PagetreeNode\canBePastedInto(), and PagetreeNode\canCreateNewPages().

canCreateNewPages ( )

Checks if there can be new pages created

Returns
bool

Definition at line 276 of file PagetreeNode.php.

References $GLOBALS, and PagetreeNode\canCreate().

canEdit ( )
protected

Checks if the user has editing rights

Returns
bool

Definition at line 189 of file PagetreeNode.php.

References $GLOBALS.

Referenced by PagetreeNode\canBeCut(), PagetreeNode\canBeDisabledAndEnabled(), and PagetreeNode\canBeEdited().

canRemove ( )
protected

Checks if the user has the right to delete the page

Returns
bool

Definition at line 207 of file PagetreeNode.php.

References $GLOBALS, and ExtDirectNode\isLeafNode().

Referenced by PagetreeNode\canBeRemoved().

canShowHistory ( )

Checks if the page is allowed to show history

Returns
bool

Definition at line 328 of file PagetreeNode.php.

References $GLOBALS.

canShowInfo ( )

Checks if the page is allowed to show info

Returns
bool

Definition at line 348 of file PagetreeNode.php.

dataFromArray (   $data)

Sets data of the node by a given data array

Parameters
array$data
Returns
void

Definition at line 415 of file PagetreeNode.php.

References PagetreeNode\setBackgroundColor(), PagetreeNode\setIsMountPoint(), PagetreeNode\setMountPoint(), PagetreeNode\setReadableRootline(), and PagetreeNode\setWorkspaceId().

getBackgroundColor ( )

Returns the background color

Returns
string

Definition at line 82 of file PagetreeNode.php.

References PagetreeNode\$backgroundColor.

Referenced by PagetreeNode\toArray().

getMountPoint ( )

Returns the mount point id

Returns
int

Definition at line 124 of file PagetreeNode.php.

References PagetreeNode\$mountPoint.

Referenced by PagetreeNode\calculateNodeId(), and PagetreeNode\toArray().

getReadableRootline ( )

Returns the readable rootline

Returns
string

Definition at line 166 of file PagetreeNode.php.

References PagetreeNode\$readableRootline.

Referenced by PagetreeNode\toArray().

getWorkspaceId ( )

Returns the original id of the element

Returns
int

Definition at line 103 of file PagetreeNode.php.

References PagetreeNode\$workspaceId.

Referenced by PagetreeNode\toArray().

isDeleted ( )

Determines whether this node is deleted.

Returns
bool

Definition at line 368 of file PagetreeNode.php.

References Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, and TreeNode\equals().

Referenced by PagetreeNode\canBeViewed().

isMountPoint ( )

Returns TRUE if the node is a mount point

Returns
bool

Definition at line 145 of file PagetreeNode.php.

References PagetreeNode\$isMountPoint.

Referenced by PagetreeNode\setIsMountPoint(), and PagetreeNode\toArray().

setBackgroundColor (   $backgroundColor)

Sets the background color

Parameters
string$backgroundColor
Returns
void

Definition at line 72 of file PagetreeNode.php.

References PagetreeNode\$backgroundColor.

Referenced by PagetreeNode\dataFromArray().

setIsMountPoint (   $isMountPoint)

Sets the indicator if the node is a mount point

Parameters
bool$isMountPoint
Returns
void

Definition at line 135 of file PagetreeNode.php.

References PagetreeNode\$isMountPoint, and PagetreeNode\isMountPoint().

Referenced by PagetreeNode\dataFromArray().

setMountPoint (   $mountPoint)

Sets the mount point id

Parameters
int$mountPoint
Returns
void

Definition at line 114 of file PagetreeNode.php.

References PagetreeNode\$mountPoint.

Referenced by PagetreeNode\dataFromArray().

setReadableRootline (   $rootline)

Sets the readable rootline

Parameters
string$rootline
Returns
void

Definition at line 156 of file PagetreeNode.php.

Referenced by PagetreeNode\dataFromArray().

setWorkspaceId (   $workspaceId)

Set's the original id of the element

Parameters
int$workspaceId
Returns
void

Definition at line 93 of file PagetreeNode.php.

References PagetreeNode\$workspaceId.

Referenced by PagetreeNode\dataFromArray().

toArray (   $addChildNodes = true)

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

Parameters
bool$addChildNodes
Returns
array

Definition at line 393 of file PagetreeNode.php.

References PagetreeNode\calculateNodeId(), PagetreeNode\getBackgroundColor(), TreeNode\getId(), PagetreeNode\getMountPoint(), PagetreeNode\getReadableRootline(), PagetreeNode\getWorkspaceId(), and PagetreeNode\isMountPoint().

Member Data Documentation

$backgroundColor = ''
protected
$cachedAccessRights = array()
protected

Definition at line 29 of file PagetreeNode.php.

$isMountPoint = false
protected

Definition at line 57 of file PagetreeNode.php.

Referenced by PagetreeNode\isMountPoint(), and PagetreeNode\setIsMountPoint().

$mountPoint = 0
protected

Definition at line 43 of file PagetreeNode.php.

Referenced by PagetreeNode\getMountPoint(), and PagetreeNode\setMountPoint().

$readableRootline = ''
protected

Definition at line 50 of file PagetreeNode.php.

Referenced by PagetreeNode\getReadableRootline().

$workspaceId = 0
protected

Definition at line 36 of file PagetreeNode.php.

Referenced by PagetreeNode\getWorkspaceId(), and PagetreeNode\setWorkspaceId().