TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Attributes | Private Attributes | List of all members
TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode Class Reference
Inheritance diagram for TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode:
TYPO3\CMS\Backend\Tree\TreeRepresentationNode TYPO3\CMS\Backend\Tree\TreeNode TYPO3\CMS\Backend\Tree\ComparableNodeInterface t3lib_tree_Tca_DatabaseNode

Public Member Functions

 setExpanded ($expanded)
 
 getExpanded ()
 
 setSelectable ($selectable)
 
 getSelectable ()
 
 setSelected ($selected)
 
 getSelected ()
 
 hasChildren ()
 
 setHasChildren ($value)
 
 compareTo ($other)
 
 getSortValue ()
 
 setSortValue ($sortValue)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Tree\TreeRepresentationNode
 setClass ($class)
 
 getClass ()
 
 setIcon ($icon)
 
 getIcon ()
 
 setLabel ($label)
 
 getLabel ()
 
 setType ($type)
 
 getType ()
 
 setCallbackAction ($callbackAction)
 
 getCallbackAction ()
 
 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 Attributes

 $selectable
 
 $selected = FALSE
 
 $expanded = TRUE
 
 $hasChildren = FALSE
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Tree\TreeRepresentationNode
 $label = ''
 
 $type = ''
 
 $class = ''
 
 $icon = ''
 
 $callbackAction = ''
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Tree\TreeNode
 $id = ''
 
 $parentNode = NULL
 
 $childNodes = NULL
 

Private Attributes

 $sortValue
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Represents a node in a TCA database setup

Author
Steffen Ritter info@.nosp@m.stef.nosp@m.fen-r.nosp@m.itte.nosp@m.r.net

Definition at line 21 of file DatabaseTreeNode.php.

Member Function Documentation

◆ compareTo()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::compareTo (   $other)

Compares a node to another one.

Returns: 1 if its greater than the other one -1 if its smaller than the other one 0 if its equal

Parameters
\TYPO3\CMS\Backend\Tree\TreeNode$other
Returns
integer see description above

Implements TYPO3\CMS\Backend\Tree\ComparableNodeInterface.

Definition at line 135 of file DatabaseTreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\equals().

◆ getExpanded()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::getExpanded ( )

Gets the expand state

Returns
boolean

Definition at line 63 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$expanded.

◆ getSelectable()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::getSelectable ( )

Gets the selectable property

Returns
boolean

Definition at line 82 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$selectable.

◆ getSelected()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::getSelected ( )

Gets the select state

Returns
boolean

Definition at line 101 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$selected.

◆ getSortValue()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::getSortValue ( )

Gets the sort value

Returns
mixed

Definition at line 147 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$sortValue.

◆ hasChildren()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::hasChildren ( )

Gets the hasChildren property

Returns
boolean

Definition at line 110 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$hasChildren.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\setHasChildren().

◆ setExpanded()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::setExpanded (   $expanded)

Sets the expand state

Parameters
$expanded
Returns
void

Definition at line 54 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$expanded.

◆ setHasChildren()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::setHasChildren (   $value)

Sets the hasChildren property

Parameters
boolean$value
Returns
void

Definition at line 120 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\hasChildren().

◆ setSelectable()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::setSelectable (   $selectable)

Sets the selectable property

Parameters
boolean$selectable
Returns
void

Definition at line 73 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$selectable.

◆ setSelected()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::setSelected (   $selected)

Sets the select state

Parameters
boolean$selected
Returns
void

Definition at line 92 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$selected.

◆ setSortValue()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::setSortValue (   $sortValue)

Sets the sort value

Parameters
mixed$sortValue
Returns
void

Definition at line 157 of file DatabaseTreeNode.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\$sortValue.

Member Data Documentation

◆ $expanded

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::$expanded = TRUE
protected

Definition at line 36 of file DatabaseTreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\getExpanded(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\setExpanded().

◆ $hasChildren

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::$hasChildren = FALSE
protected

Definition at line 41 of file DatabaseTreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\hasChildren().

◆ $selectable

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::$selectable
protected

Definition at line 26 of file DatabaseTreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\getSelectable(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\setSelectable().

◆ $selected

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::$selected = FALSE
protected

Definition at line 31 of file DatabaseTreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\getSelected(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\setSelected().

◆ $sortValue

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode::$sortValue
private

Definition at line 46 of file DatabaseTreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\getSortValue(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\setSortValue().