Öffentliche Methoden | |
| webPageTree () | |
| wrapIcon ($icon, &$row) | |
| wrapStop ($str, $row) | |
| wrapTitle ($title, $row, $bank=0) | |
| printTree ($treeArr= '') | |
| PMicon ($row, $a, $c, $nextCount, $exp) | |
| PMiconATagWrap ($icon, $cmd, $isExpand=true) | |
| getBrowsableTree () | |
| getTree ($uid, $depth=999, $blankLineCode='', $subCSSclass='') | |
| init ($clause='') | |
| init ($clause='', $orderByFields='') | |
| getTitleAttrib ($row) | |
| wrapIcon ($icon, $row) | |
| getTitleStr ($row, $titleLen=30) | |
| setTreeName ($treeName='') | |
| addField ($field, $noCheck=0) | |
| reset () | |
| PM_ATagWrap ($icon, $cmd, $bMark='') | |
| addTagAttributes ($icon, $attr) | |
| expandNext ($id) | |
| initializePositionSaving () | |
| savePosition () | |
| getRootIcon ($rec) | |
| getIcon ($row) | |
| getId ($row) | |
| getJumpToParam ($row) | |
| getTree ($uid, $depth=999, $depthData='', $blankLineCode='', $subCSSclass='') | |
| getCount ($uid) | |
| getRootRecord ($uid) | |
| getRecord ($uid) | |
| getDataInit ($parentId, $subCSSclass='') | |
| getDataCount (&$res) | |
| getDataNext (&$res, $subCSSclass='') | |
| getDataFree (&$res) | |
| setDataFromArray (&$dataArr, $traverse=FALSE, $pid=0) | |
| setDataFromTreeArray (&$treeArr, &$treeLookupArr) | |
Öffentliche Attribute | |
| $ext_showPageId | |
| $ext_IconMode | |
| $ext_separateNotinmenuPages | |
| $ext_alphasortNotinmenuPages | |
| $ajaxStatus = false | |
| $expandFirst = 0 | |
| $expandAll = 0 | |
| $thisScript = '' | |
| $titleAttrib = 'title' | |
| $addSelfId = 0 | |
| $title = 'no title' | |
| $showDefaultTitleAttribute = FALSE | |
| $highlightPagesWithVersions = TRUE | |
| $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() | |
| $orig_ids_hierarchy = array() | |
| $buffer_idH = array() | |
| $specUIDmap = array() | |
| $data = false | |
| $dataLookup = false | |
| $tree = Array() | |
| $stored = array() | |
| $bank = 0 | |
| $recs = array() | |
| t3lib_treeView::addField | ( | $ | field, | |
| $ | noCheck = 0 | |||
| ) | [inherited] |
Adds a fieldname to the internal array ->fieldArray
| string | Field name to | |
| boolean | If set, the fieldname will be set no matter what. Otherwise the field name must either be found as key in $TCA[$table]['columns'] or in the list ->defaultList |
| t3lib_treeView::addTagAttributes | ( | $ | icon, | |
| $ | attr | |||
| ) | [inherited] |
Adds attributes to image tag.
| string | Icon image tag | |
| string | Attributes to add, eg. ' border="0"' |
| t3lib_treeView::expandNext | ( | $ | id | ) | [inherited] |
Returns true/false if the next level for $id should be expanded - based on data in $this->stored[][] and ->expandAll flag. Extending parent function
| integer | record id/key |
Erneute Implementation in t3lib_pageTree und localPageTree.
| webPageTree::getBrowsableTree | ( | ) |
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)
Erneute Implementation von t3lib_treeView.
| t3lib_treeView::getCount | ( | $ | uid | ) | [inherited] |
Returns the number of records having the parent id, $uid
| integer | id to count subitems for |
Erneute Implementation in t3lib_folderTree.
| t3lib_treeView::getDataCount | ( | &$ | res | ) | [inherited] |
Getting the tree data: Counting elements in resource
| mixed | data handle |
| t3lib_treeView::getDataFree | ( | &$ | res | ) | [inherited] |
Getting the tree data: frees data handle
| mixed | data handle |
| t3lib_treeView::getDataInit | ( | $ | parentId, | |
| $ | subCSSclass = '' | |||
| ) | [inherited] |
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
| integer | parent item id | |
| string | Class for sub-elements. |
| t3lib_treeView::getDataNext | ( | &$ | res, | |
| $ | subCSSclass = '' | |||
| ) | [inherited] |
Getting the tree data: next entry
| mixed | data handle | |
| string | CSS class for sub elements (workspace related) |
| t3lib_treeView::getIcon | ( | $ | row | ) | [inherited] |
Get icon for the row. If $this->iconPath and $this->iconName is set, try to get icon based on those values.
| array | Item row. |
| t3lib_treeView::getId | ( | $ | row | ) | [inherited] |
Returns the id from the record (typ. uid)
| array | Record array |
Erneute Implementation in t3lib_folderTree.
| t3lib_treeView::getJumpToParam | ( | $ | row | ) | [inherited] |
Returns jump-url parameter value.
| array | The record array. |
Erneute Implementation in t3lib_folderTree.
| t3lib_treeView::getRecord | ( | $ | uid | ) | [inherited] |
Returns the record for a uid. For tables: Looks up the record in the database. For arrays: Returns the fake record for uid id.
| integer | UID to look up |
| t3lib_treeView::getRootIcon | ( | $ | rec | ) | [inherited] |
Returns the root icon for a tree/mountpoint (defaults to the globe)
| array | Record for root. |
| t3lib_treeView::getRootRecord | ( | $ | uid | ) | [inherited] |
Returns root record for uid (<=0)
| integer | uid, <= 0 (normally, this does not matter) |
| t3lib_browseTree::getTitleAttrib | ( | $ | row | ) | [inherited] |
Creates title attribute content for pages. Uses API function in t3lib_BEfunc which will retrieve lots of useful information for pages.
| array | The table row. |
Erneute Implementation von t3lib_treeView.
| t3lib_browseTree::getTitleStr | ( | $ | row, | |
| $ | titleLen = 30 | |||
| ) | [inherited] |
Returns the title for the input record. If blank, a "no title" label (localized) will be returned. Do NOT htmlspecialchar the string from this function - has already been done.
| array | The input row array (where the key "title" is used for the title) | |
| integer | Title length (30) |
Erneute Implementation von t3lib_treeView.
| t3lib_treeView::getTree | ( | $ | uid, | |
| $ | depth = 999, |
|||
| $ | depthData = '', |
|||
| $ | blankLineCode = '', |
|||
| $ | subCSSclass = '' | |||
| ) | [inherited] |
Fetches the data for the tree
| integer | item id for which to select subitems (parent id) | |
| integer | Max depth (recursivity limit) | |
| string | HTML-code prefix for recursive calls. | |
| string | ? (internal) | |
| string | CSS class to use for |
sub-elements
| webPageTree::getTree | ( | $ | uid, | |
| $ | depth = 999, |
|||
| $ | blankLineCode = '', |
|||
| $ | subCSSclass = '' | |||
| ) |
Fetches the data for the tree
| integer | item id for which to select subitems (parent id) | |
| integer | Max depth (recursivity limit) | |
| string | ? (internal) |
| t3lib_treeView::init | ( | $ | clause = '', |
|
| $ | orderByFields = '' | |||
| ) | [inherited] |
Initialize the tree class. Needs to be overwritten Will set ->fieldsArray, ->backPath and ->clause
| string | record WHERE clause | |
| string | record ORDER BY field |
| t3lib_browseTree::init | ( | $ | clause = '' |
) | [inherited] |
Initialize, setting what is necessary for browsing pages. Using the current user.
| string | Additional clause for selecting pages. |
| t3lib_treeView::initializePositionSaving | ( | ) | [inherited] |
Get stored tree structure AND updating it if needed according to incoming PM GET var.
Erneute Implementation in t3lib_folderTree und t3lib_pageTree.
| t3lib_treeView::PM_ATagWrap | ( | $ | icon, | |
| $ | cmd, | |||
| $ | bMark = '' | |||
| ) | [inherited] |
Wrap the plus/minus icon in a link
| string | HTML string to wrap, probably an image tag. | |
| string | Command for 'PM' get var | |
| boolean | If set, the link will have a anchor point (=$bMark) and a name attribute (=$bMark) |
Erneute Implementation in localPageTree und localFolderTree.
| webPageTree::PMicon | ( | $ | row, | |
| $ | a, | |||
| $ | c, | |||
| $ | nextCount, | |||
| $ | exp | |||
| ) |
Generate the plus/minus icon for the browsable tree.
| array | record for the entry | |
| integer | The current entry number | |
| integer | The total number of entries. If equal to $a, a "bottom" element is returned. | |
| integer | The number of sub-elements to the current element. | |
| boolean | The element was expanded to render subelements if this flag is set. |
Erneute Implementation von t3lib_treeView.
| webPageTree::PMiconATagWrap | ( | $ | icon, | |
| $ | cmd, | |||
| $ | isExpand = true | |||
| ) |
Wrap the plus/minus icon in a link
| string | HTML string to wrap, probably an image tag. | |
| string | Command for 'PM' get var |
| webPageTree::printTree | ( | $ | treeArr = '' |
) |
Compiles the HTML code for displaying the structure found inside the ->tree array
| array | "tree-array" - if blank string, the internal ->tree array is used. |
Erneute Implementation von t3lib_treeView.
| t3lib_treeView::reset | ( | ) | [inherited] |
Resets the tree, recs, ids, ids_hierarchy and orig_ids_hierarchy internal variables. Use it if you need it.
| t3lib_treeView::savePosition | ( | ) | [inherited] |
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
| t3lib_treeView::setDataFromArray | ( | &$ | dataArr, | |
| $ | traverse = FALSE, |
|||
| $ | pid = 0 | |||
| ) | [inherited] |
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.
| array | The input array, see examples below in this script. | |
| boolean | Internal, for recursion. | |
| integer | Internal, for recursion. |
| t3lib_treeView::setDataFromTreeArray | ( | &$ | treeArr, | |
| &$ | treeLookupArr | |||
| ) | [inherited] |
Sets the internal data arrays
| array | Content for $this->data | |
| array | Content for $this->dataLookup |
| t3lib_treeView::setTreeName | ( | $ | treeName = '' |
) | [inherited] |
Sets the tree name which is used to identify the tree Used for JavaScript and other things
| string | Default is the table name. Underscores are stripped. |
| webPageTree::webPageTree | ( | ) |
Calls init functions
| t3lib_browseTree::wrapIcon | ( | $ | icon, | |
| $ | row | |||
| ) | [inherited] |
Wrapping the image tag, $icon, for the row, $row (except for mount points)
| string | The image tag for the icon | |
| array | The row for the current element |
Erneute Implementation von t3lib_treeView.
Erneute Implementation in localPageTree, localPageTree und localPageTree.
| webPageTree::wrapIcon | ( | $ | icon, | |
| &$ | row | |||
| ) |
Wrapping icon in browse tree
| string | Icon IMG code | |
| array | Data row for element. |
| webPageTree::wrapStop | ( | $ | str, | |
| $ | row | |||
| ) |
Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set
| string | Input string, like a page title for the tree | |
| array | record row with "php_tree_stop" field |
Erneute Implementation von t3lib_treeView.
| webPageTree::wrapTitle | ( | $ | title, | |
| $ | row, | |||
| $ | bank = 0 | |||
| ) |
Wrapping $title in a-tags.
| string | Title string | |
| string | Item record | |
| integer | Bank pointer (which mount point number) |
Erneute Implementation von t3lib_treeView.
t3lib_treeView::$backPath [inherited] |
Back path for icons
t3lib_treeView::$clause = '' [inherited] |
WHERE clause used for selecting records for the tree. Is set by function init. Only makes sense when $this->table is set.
t3lib_treeView::$defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id' [inherited] |
List of other fields which are ALLOWED to set (here, based on the "pages" table!)
Erneute Implementation in t3lib_pageTree.
t3lib_treeView::$domIdPrefix = 'row' [inherited] |
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.
t3lib_treeView::$fieldArray = Array('uid','title') [inherited] |
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)
Erneute Implementation in t3lib_pageTree.
t3lib_treeView::$iconName = 'default.gif' [inherited] |
Icon file name for item icons.
t3lib_treeView::$iconPath = '' [inherited] |
Icon file path.
t3lib_treeView::$makeHTML = 1 [inherited] |
If true, HTML code is also accumulated in ->tree array during rendering of the tree. If 2, then also the icon prefix code (depthData) is stored
t3lib_treeView::$MOUNTS = '' [inherited] |
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.)
t3lib_treeView::$orderByFields = '' [inherited] |
Field for ORDER BY. Is set by function init. Only makes sense when $this->table is set.
t3lib_treeView::$parentField = 'pid' [inherited] |
Defines the field of $table which is the parent id field (like pid for table pages).
t3lib_treeView::$setRecs = 0 [inherited] |
If true, records as selected will be stored internally in the ->recs array
Erneute Implementation in t3lib_pageTree.
t3lib_treeView::$subLevelID = '_SUB_LEVEL' [inherited] |
Sets the associative array key which identifies a new sublevel if arrays are used for trees. This value has formerly been "subLevel" and "--sublevel--"
t3lib_treeView::$table = '' [inherited] |
Database table to get the tree data from. Leave blank if data comes from an array.
t3lib_treeView::$treeName = '' [inherited] |
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.
1.6.1
