webPageTree Class Reference

Inheritance diagram for webPageTree:

Inheritance graph
[legend]
Collaboration diagram for webPageTree:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 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='')

Public Attributes

 $ext_showPageId
 $ext_IconMode
 $ajaxStatus = false


Detailed Description

Definition at line 72 of file class.webpagetree.php.


Member Function Documentation

webPageTree::webPageTree (  ) 

Calls init functions

Returns:
void

Definition at line 83 of file class.webpagetree.php.

webPageTree::wrapIcon ( icon,
&$  row 
)

Wrapping icon in browse tree

Parameters:
string Icon IMG code
array Data row for element.
Returns:
string Page icon

Definition at line 94 of file class.webpagetree.php.

webPageTree::wrapStop ( str,
row 
)

Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set

Parameters:
string Input string, like a page title for the tree
array record row with "php_tree_stop" field
Returns:
string Modified string private

Reimplemented from t3lib_treeView.

Definition at line 132 of file class.webpagetree.php.

webPageTree::wrapTitle ( title,
row,
bank = 0 
)

Wrapping $title in a-tags.

Parameters:
string Title string
string Item record
integer Bank pointer (which mount point number)
Returns:
string private

Reimplemented from t3lib_treeView.

Definition at line 148 of file class.webpagetree.php.

webPageTree::printTree ( treeArr = ''  ) 

Compiles the HTML code for displaying the structure found inside the ->tree array

Parameters:
array "tree-array" - if blank string, the internal ->tree array is used.
Returns:
string The HTML code for the tree

Reimplemented from t3lib_treeView.

Definition at line 167 of file class.webpagetree.php.

webPageTree::PMicon ( row,
a,
c,
nextCount,
exp 
)

Generate the plus/minus icon for the browsable tree.

Parameters:
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.
Returns:
string Image tag with the plus/minus icon. private
See also:
t3lib_pageTree::PMicon()

Reimplemented from t3lib_treeView.

Definition at line 280 of file class.webpagetree.php.

webPageTree::PMiconATagWrap ( icon,
cmd,
isExpand = true 
)

Wrap the plus/minus icon in a link

Parameters:
string HTML string to wrap, probably an image tag.
string Command for 'PM' get var
Returns:
string Link-wrapped input string private

Definition at line 301 of file class.webpagetree.php.

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)

Returns:
string HTML code for the browsable tree

Reimplemented from t3lib_treeView.

Definition at line 318 of file class.webpagetree.php.

webPageTree::getTree ( uid,
depth = 999,
blankLineCode = '',
subCSSclass = '' 
)

Fetches the data for the tree

Parameters:
integer item id for which to select subitems (parent id)
integer Max depth (recursivity limit)
string ? (internal)
Returns:
integer The count of items on the level

Definition at line 383 of file class.webpagetree.php.


The documentation for this class was generated from the following file:
This documentation has been generated automatically from TYPO3 source code using Doxygen and is provided as is by Cast Iron Coding as a courtesy to other TYPO3 developers and users. Please consider Cast Iron Coding — a full-service web development agency in Portland, Oregon specializing in TYPO3 extension development — for all of your TYPO3 development and consulting needs!