AbstractTreeView

abstract class \TYPO3\CMS\Backend\Tree\View\AbstractTreeView

Base class for creating a browsable array/page/folder tree in HTML

Table of Contents

Properties

$BE_USER  : BackendUserAuthentication|string
Needs to be initialized with $GLOBALS['BE_USER'] Done by default in init()
$buffer_idH  : array
$clause  : string
WHERE clause used for selecting records for the tree. Is set by function init.
$defaultList  : string
List of other fields which are ALLOWED to set (here, based on the "pages" table!)
$fieldArray  : array
Default set of fields selected from the tree table.
$ids  : array
$ids_hierarchy  : array
$makeHTML  : int
If 1, HTML code is also accumulated in ->tree array during rendering of the tree
$orderByFields  : string
Field for ORDER BY. Is set by function init.
$orig_ids_hierarchy  : array
$parentField  : string
Defines the field of $table which is the parent id field (like pid for table pages).
$table  : string
Database table to get the tree data from.
$thisScript  : string
$title  : string
$tree  : array

Methods

__construct()  : mixed
Constructor
addField()  : mixed
Adds a fieldname to the internal array ->fieldArray
addTagAttributes()  : string
Adds attributes to image tag.
expandNext()  : bool
Returns TRUE/FALSE if the next level for $id should be expanded - based on data in $this->stored[][] and ->expandAll flag.
getCount()  : int
Returns the number of records having the parent id, $uid
getDataCount()  : int
Getting the tree data: Counting elements in resource
getDataFree()  : mixed
Getting the tree data: frees data handle
getDataInit()  : mixed
Getting the tree data: Selecting/Initializing data pointer to items for a certain parent id.
getDataNext()  : array|bool
Getting the tree data: next entry
getIcon()  : string
Get the icon markup for the row
getRootIcon()  : string
Returns the root icon for a tree/mountpoint (defaults to the globe)
getRootRecord()  : array
Returns root record for uid (<=0)
getTitleAttrib()  : string
Returns the value for the image "title" attribute
getTitleStr()  : string
Returns the title for the input record. If blank, a "no title" label (localized) will be returned.
getTree()  : int
Fetches the data for the tree
init()  : mixed
Initialize the tree class. Needs to be overwritten
PM_ATagWrap()  : string
Wrap the plus/minus icon in a link
PMicon()  : string
Generate the plus/minus icon for the browsable tree.
reset()  : mixed
Resets the tree, recs, ids, ids_hierarchy and orig_ids_hierarchy internal variables. Use it if you need it.
determineScriptUrl()  : mixed
Sets the script url depending on being a module or script request
getBackendUser()  : BackendUserAuthentication
getLanguageService()  : LanguageService
getThisScript()  : string

Properties

$clause

WHERE clause used for selecting records for the tree. Is set by function init.

public string $clause = ''

Tags

see
init()

$defaultList

List of other fields which are ALLOWED to set (here, based on the "pages" table!)

public string $defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,p…
Show the full value'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id'

Tags

see
addField()

$fieldArray

Default set of fields selected from the tree table.

public array $fieldArray = ['uid', 'pid', 'title', 'is_siteroot', 'doktype', 'nav_title…
Show the full value['uid', 'pid', 'title', 'is_siteroot', 'doktype', 'nav_title', 'mount_pid', 'php_tree_stop', 't3ver_state', 'hidden', 'starttime', 'endtime', 'fe_group', 'module', 'extendToSubpages', 'nav_hide', 't3ver_wsid']

Make SURE that these fields names listed herein are actually possible to select from $this->table (if that variable is set to a TCA table name)

Tags

see
addField()

$ids_hierarchy

public array $ids_hierarchy = []

$makeHTML

If 1, HTML code is also accumulated in ->tree array during rendering of the tree

public int $makeHTML = 1

$orderByFields

Field for ORDER BY. Is set by function init.

public string $orderByFields = ''

Tags

see
init()

$orig_ids_hierarchy

public array $orig_ids_hierarchy = []

$parentField

Defines the field of $table which is the parent id field (like pid for table pages).

public string $parentField = 'pid'

$table

Database table to get the tree data from.

public string $table = 'pages'

Leave blank if data comes from an array.

Methods

__construct()

Constructor

public __construct() : mixed

addField()

Adds a fieldname to the internal array ->fieldArray

public addField(string $field[, bool $noCheck = false ]) : mixed

Parameters

$field : string

Field name to

$noCheck : bool = false

If set, the fieldname will be set no matter what. Otherwise the field name must either be found as key in $GLOBALS['TCA'][$table]['columns'] or in the list ->defaultList

addTagAttributes()

Adds attributes to image tag.

public addTagAttributes(string $icon, string $attr) : string

Parameters

$icon : string

Icon image tag

$attr : string

Attributes to add, eg. ' border="0"'

Return values

string —

Image tag, modified with $attr attributes added.

expandNext()

Returns TRUE/FALSE if the next level for $id should be expanded - based on data in $this->stored[][] and ->expandAll flag.

public expandNext(int $id) : bool

Used in subclasses

Parameters

$id : int

Record id/key

Tags

see
PageTreeView::expandNext()

Return values

bool

getCount()

Returns the number of records having the parent id, $uid

public getCount(int $uid) : int

Parameters

$uid : int

Id to count subitems for

Return values

int

getDataCount()

Getting the tree data: Counting elements in resource

public getDataCount(mixed &$res) : int

Parameters

$res : mixed

Data handle

Tags

see
getDataInit()

Return values

int —

number of items

getDataFree()

Getting the tree data: frees data handle

public getDataFree(mixed &$res) : mixed

Parameters

$res : mixed

Data handle

getDataInit()

Getting the tree data: Selecting/Initializing data pointer to items for a certain parent id.

public getDataInit(int $parentId) : mixed

For tables: This will make a database query to select all children to "parent" For arrays: This will return key to the ->dataLookup array

Parameters

$parentId : int

parent item id

Return values

mixed —

Data handle (Tables: An sql-resource, arrays: A parentId integer. -1 is returned if there were NO subLevel.)

getDataNext()

Getting the tree data: next entry

public getDataNext(mixed &$res) : array|bool

Parameters

$res : mixed

Data handle

Tags

see
getDataInit()

Return values

array|bool —

item data array OR FALSE if end of elements.

getIcon()

Get the icon markup for the row

public getIcon(array $row) : string

Parameters

$row : array

The row to get the icon for

Return values

string —

The icon markup, wrapped into a span tag, with the records title as title attribute

getRootIcon()

Returns the root icon for a tree/mountpoint (defaults to the globe)

public getRootIcon(array $rec) : string

Parameters

$rec : array

Record for root.

Return values

string —

Icon image tag.

getRootRecord()

Returns root record for uid (<=0)

public getRootRecord() : array

Return values

array —

Array with title/uid keys with values of $this->title/0 (zero)

getTitleAttrib()

Returns the value for the image "title" attribute

public getTitleAttrib(array $row) : string

Parameters

$row : array

The input row array (where the key "title" is used for the title)

Return values

string —

The attribute value (is htmlspecialchared() already)

getTitleStr()

Returns the title for the input record. If blank, a "no title" label (localized) will be returned.

public getTitleStr(array $row[, int $titleLen = 30 ]) : string

Do NOT htmlspecialchar the string from this function - has already been done.

Parameters

$row : array

The input row array (where the key "title" is used for the title)

$titleLen : int = 30

Title length (30)

Return values

string —

The title.

getTree()

Fetches the data for the tree

public getTree(int $uid[, int $depth = 999 ][, string $depthData = '' ]) : int

Parameters

$uid : int

item id for which to select subitems (parent id)

$depth : int = 999

Max depth (recursivity limit)

$depthData : string = ''

HTML-code prefix for recursive calls.

Return values

int —

The count of items on the level

init()

Initialize the tree class. Needs to be overwritten

public init([string $clause = '' ][, string $orderByFields = '' ]) : mixed

Parameters

$clause : string = ''

Record WHERE clause

$orderByFields : string = ''

Record ORDER BY field

PM_ATagWrap()

Wrap the plus/minus icon in a link

public PM_ATagWrap([string $bMark = '' ][, bool $isOpen = false ]) : string

Parameters

$bMark : string = ''

If set, the link will have an anchor point (=$bMark) and a name attribute (=$bMark)

$isOpen : bool = false

Return values

string —

Link-wrapped input string

PMicon()

Generate the plus/minus icon for the browsable tree.

public PMicon(array $row, int $a, int $c, int $nextCount, bool $isOpen) : string

Parameters

$row : array

Record for the entry

$a : int

The current entry number

$c : int

The total number of entries. If equal to $a, a "bottom" element is returned.

$nextCount : int

The number of sub-elements to the current element.

$isOpen : bool

The element was expanded to render subelements if this flag is set.

Tags

see
PageTreeView::PMicon()

Return values

string —

Image tag with the plus/minus icon.

reset()

Resets the tree, recs, ids, ids_hierarchy and orig_ids_hierarchy internal variables. Use it if you need it.

public reset() : mixed

determineScriptUrl()

Sets the script url depending on being a module or script request

protected determineScriptUrl() : mixed

getThisScript()

protected getThisScript() : string

Return values

string
On this page