Documentation TYPO3 par Ameos |
Public Member Functions | |
init ($clause='', $orderByFields='') | |
setTreeName ($treeName='') | |
addField ($field, $noCheck=0) | |
reset () | |
getBrowsableTree () | |
printTree ($treeArr='') | |
PMicon ($row, $a, $c, $nextCount, $exp) | |
PM_ATagWrap ($icon, $cmd, $bMark='') | |
wrapTitle ($title, $row, $bank=0) | |
wrapIcon ($icon, $row) | |
addTagAttributes ($icon, $attr) | |
wrapStop ($str, $row) | |
expandNext ($id) | |
initializePositionSaving () | |
savePosition () | |
getRootIcon ($rec) | |
getIcon ($row) | |
getTitleStr ($row, $titleLen=30) | |
getTitleAttrib ($row) | |
getId ($row) | |
getJumpToParam ($row) | |
getTree ($uid, $depth=999, $depthData='', $blankLineCode='') | |
getCount ($uid) | |
getRootRecord ($uid) | |
getRecord ($uid) | |
getDataInit ($parentId) | |
getDataCount (&$res) | |
getDataNext (&$res) | |
getDataFree (&$res) | |
setDataFromArray (&$dataArr, $traverse=FALSE, $pid=0) | |
setDataFromTreeArray (&$treeArr, &$treeLookupArr) | |
Public Attributes | |
$expandFirst = 0 | |
$expandAll = 0 | |
$thisScript = '' | |
$titleAttrib = 'title' | |
$ext_IconMode = false | |
$addSelfId = 0 | |
$title = 'no title' | |
$BE_USER = '' | |
$MOUNTS = '' | |
$table = '' | |
$parentField = 'pid' | |
$clause = '' | |
$orderByFields = '' | |
$fieldArray = Array('uid','title') | |
$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id' | |
$treeName = '' | |
$domIdPrefix = 'row' | |
$backPath | |
$iconPath = '' | |
$iconName = 'default.gif' | |
$makeHTML = 1 | |
$setRecs = 0 | |
$subLevelID = '_SUB_LEVEL' | |
$ids = Array() | |
$ids_hierarchy = array() | |
$buffer_idH = array() | |
$specUIDmap = array() | |
$data = false | |
$dataLookup = false | |
$tree = Array() | |
$stored = array() | |
$bank = 0 | |
$recs = array() |
Definition at line 115 of file class.t3lib_treeview.php.
|
Adds a fieldname to the internal array ->fieldArray
Definition at line 312 of file class.t3lib_treeview.php. References t3lib_div::inList(). |
|
Adds attributes to image tag.
Definition at line 528 of file class.t3lib_treeview.php. Referenced by t3lib_folderTree::wrapIcon(), t3lib_browseTree::wrapIcon(), localFolderTree::wrapIcon(), printAllPageTree::wrapIcon(), and localPageTree::wrapIcon(). |
|
Returns true/false if the next level for $id should be expanded - based on data in $this->stored[][] and ->expandAll flag. Extending parent function
Reimplemented in t3lib_pageTree, and localPageTree. Definition at line 568 of file class.t3lib_treeview.php. Referenced by t3lib_folderTree::getFolderTree(), and getTree(). |
|
Will create and return the HTML code for a browsable tree Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)
Reimplemented in t3lib_folderTree. Definition at line 346 of file class.t3lib_treeview.php. References getIcon(), getRecord(), getRootIcon(), getRootRecord(), getTree(), initializePositionSaving(), PM_ATagWrap(), printTree(), and reset(). |
|
Returns the number of records having the parent id, $uid
Reimplemented in t3lib_folderTree. Definition at line 828 of file class.t3lib_treeview.php. References t3lib_BEfunc::deleteClause(), getDataCount(), and getDataInit(). Referenced by getTree(). |
|
Getting the tree data: Counting elements in resource
Definition at line 915 of file class.t3lib_treeview.php. Referenced by getCount(), and getTree(). |
|
Getting the tree data: frees data handle
Definition at line 960 of file class.t3lib_treeview.php. Referenced by getTree(). |
|
Getting the tree data: Selecting/Initializing data pointer to items for a certain parent id. For tables: This will make a database query to select all children to "parent" For arrays: This will return key to the ->dataLookup array
Definition at line 885 of file class.t3lib_treeview.php. References t3lib_BEfunc::deleteClause(), and reset(). Referenced by getCount(), and getTree(). |
|
Getting the tree data: next entry
Definition at line 932 of file class.t3lib_treeview.php. Referenced by getTree(). |
|
Get icon for the row. If $this->iconPath and $this->iconName is set, try to get icon based on those values.
Definition at line 647 of file class.t3lib_treeview.php. References t3lib_iconWorks::getIconImage(), and wrapIcon(). Referenced by getBrowsableTree(), and getTree(). |
|
Returns the id from the record (typ. uid)
Reimplemented in t3lib_folderTree. Definition at line 688 of file class.t3lib_treeview.php. Referenced by getJumpToParam(), and t3lib_browseTree::wrapIcon(). |
|
Returns jump-url parameter value.
Reimplemented in t3lib_folderTree. Definition at line 698 of file class.t3lib_treeview.php. References getId(). Referenced by localPageTree::wrapIcon(), t3lib_browseTree::wrapIcon(), localPageTree::wrapTitle(), and wrapTitle(). |
|
Returns the record for a uid. For tables: Looks up the record in the database. For arrays: Returns the fake record for uid id.
Definition at line 868 of file class.t3lib_treeview.php. Referenced by getBrowsableTree(). |
|
Returns the root icon for a tree/mountpoint (defaults to the globe)
Definition at line 634 of file class.t3lib_treeview.php. References t3lib_iconWorks::skinImg(), and wrapIcon(). Referenced by getBrowsableTree(). |
|
Returns root record for uid (<=0)
Definition at line 855 of file class.t3lib_treeview.php. Referenced by getBrowsableTree(). |
|
Returns the value for the image "title" attribute
Reimplemented in t3lib_browseTree. Definition at line 678 of file class.t3lib_treeview.php. |
|
Returns the title for the input record. If blank, a "no title" labele (localized) will be returned. Do NOT htmlspecialchar the string from this function - has already been done.
Reimplemented in t3lib_folderTree. Definition at line 666 of file class.t3lib_treeview.php. References $title, and t3lib_div::fixed_lgd_cs(). Referenced by printTree(). |
|
Fetches the data for the tree
Definition at line 731 of file class.t3lib_treeview.php. References expandNext(), getCount(), getDataCount(), getDataFree(), getDataInit(), getDataNext(), getIcon(), t3lib_iconWorks::skinImg(), and wrapStop(). Referenced by localPageTree::ext_tree(), and getBrowsableTree(). |
|
Initialize the tree class. Needs to be overwritten Will set ->fieldsArray, ->backPath and ->clause
Definition at line 267 of file class.t3lib_treeview.php. References $clause, $orderByFields, t3lib_div::loadTCA(), and setTreeName(). Referenced by localFolderTree::localFolderTree(). |
|
Get stored tree structure AND updating it if needed according to incoming PM GET var.
Reimplemented in t3lib_folderTree, t3lib_pageTree, localPageTree, and localFolderTree. Definition at line 578 of file class.t3lib_treeview.php. References t3lib_div::_GP(), and savePosition(). Referenced by getBrowsableTree(). |
|
Wrap the plus/minus icon in a link
Reimplemented in localPageTree, localFolderTree, localFolderTree, localPageTree, printAllPageTree, localFolderTree, printAllFolderTree, and localPageTree. Definition at line 482 of file class.t3lib_treeview.php. Referenced by getBrowsableTree(), t3lib_folderTree::getBrowsableTree(), and PMicon(). |
|
Generate the plus/minus icon for the browsable tree.
Reimplemented in t3lib_pageTree. Definition at line 460 of file class.t3lib_treeview.php. References PM_ATagWrap(). |
|
Compiles the HTML code for displaying the structure found inside the ->tree array
Reimplemented in localPageTree, localFolderTree, and localFolderTree. Definition at line 407 of file class.t3lib_treeview.php. References getTitleStr(), and wrapTitle(). Referenced by getBrowsableTree(), and t3lib_folderTree::getBrowsableTree(). |
|
Resets the tree, recs, ids, and ids_hierarchy internal variables. Use it if you need it.
Definition at line 326 of file class.t3lib_treeview.php. Referenced by localPageTree::ext_tree(), getBrowsableTree(), t3lib_folderTree::getBrowsableTree(), getDataInit(), and printAllPageTree_perms::printTree(). |
|
Saves the content of ->stored (keeps track of expanded positions in the tree) $this->treeName will be used as key for BE_USER->uc[] to store it in
Definition at line 605 of file class.t3lib_treeview.php. Referenced by initializePositionSaving(), and t3lib_folderTree::initializePositionSaving(). |
|
Used to initialize class with an array to browse. The array inputted will be traversed and an internal index for lookup is created. The keys of the input array are perceived as "uid"s of records which means that keys GLOBALLY must be unique like uids are. "uid" and "pid" "fakefields" are also set in each record. All other fields are optional.
Definition at line 980 of file class.t3lib_treeview.php. |
|
Sets the internal data arrays
Definition at line 1009 of file class.t3lib_treeview.php. |
|
Sets the tree name which is used to identify the tree Used for JavaScript and other things
Definition at line 298 of file class.t3lib_treeview.php. References $treeName. Referenced by init(), and t3lib_browseTree::init(). |
|
Wrapping the image tag, $icon, for the row, $row (except for mount points)
Reimplemented in t3lib_browseTree, t3lib_folderTree, localPageTree, localPageTree, localPageTree, localPageTree, printAllPageTree, localFolderTree, and localPageTree. Definition at line 517 of file class.t3lib_treeview.php. Referenced by getIcon(), and getRootIcon(). |
|
Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set
Reimplemented in localPageTree. Definition at line 540 of file class.t3lib_treeview.php. Referenced by getTree(). |
|
Wrapping $title in a-tags.
Reimplemented in t3lib_folderTree, localPageTree, localPageTree, and TBE_PageTree. Definition at line 504 of file class.t3lib_treeview.php. References $bank, and getJumpToParam(). Referenced by printTree(). |
|
Back path for icons Definition at line 200 of file class.t3lib_treeview.php. |
|
Needs to be initialized with $GLOBALS['BE_USER'] Done by default in init() Definition at line 130 of file class.t3lib_treeview.php. Referenced by localFolderTree::localFolderTree(), and localPageTree::localPageTree(). |
|
WHERE clause used for selecting records for the tree. Is set by function init. Only makes sense when $this->table is set.
Definition at line 157 of file class.t3lib_treeview.php. Referenced by localPageTree::ext_tree(), init(), t3lib_pageTree::init(), and t3lib_browseTree::init(). |
|
List of other fields which are ALLOWED to set (here, based on the "pages" table!)
Reimplemented in t3lib_pageTree. Definition at line 177 of file class.t3lib_treeview.php. |
|
A prefix for table cell id's which will be wrapped around an item. Can be used for highlighting by JavaScript. Needs to be unique if multiple trees are on one HTML page.
Definition at line 195 of file class.t3lib_treeview.php. |
|
Default set of fields selected from the tree table. 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)
Reimplemented in t3lib_pageTree. Definition at line 171 of file class.t3lib_treeview.php. |
|
Icon file name for item icons. Definition at line 211 of file class.t3lib_treeview.php. |
|
Icon file path. Definition at line 205 of file class.t3lib_treeview.php. |
|
If true, HTML code is also accumulated in ->tree array during rendering of the tree. Definition at line 216 of file class.t3lib_treeview.php. |
|
Needs to be initialized with e.g. $GLOBALS['WEBMOUNTS'] Default setting in init() is 0 => 0 The keys are mount-ids (can be anything basically) and the values are the ID of the root element (COULD be zero or anything else. For pages that would be the uid of the page, zero for the pagetree root.) Definition at line 137 of file class.t3lib_treeview.php. |
|
Field for ORDER BY. Is set by function init. Only makes sense when $this->table is set.
Definition at line 164 of file class.t3lib_treeview.php. Referenced by init(). |
|
Defines the field of $table which is the parent id field (like pid for table pages). Definition at line 150 of file class.t3lib_treeview.php. |
|
If true, records as selected will be stored internally in the ->recs array Reimplemented in t3lib_pageTree. Definition at line 221 of file class.t3lib_treeview.php. |
|
Sets the associative array key which identifies a new sublevel if arrays are used for trees. This value has formerly been "subLevel" and "--sublevel--" Definition at line 227 of file class.t3lib_treeview.php. |
|
Database table to get the tree data from. Leave blank if data comes from an array. Definition at line 145 of file class.t3lib_treeview.php. |
|
Unique name for the tree. Used as key for storing the tree into the BE users settings. Used as key to pass parameters in links. MUST NOT contain underscore chars. etc. Definition at line 187 of file class.t3lib_treeview.php. Referenced by setTreeName(). |