webPageTree Class Reference

Inheritance diagram for webPageTree:

Collaboration diagram for webPageTree:

List of all members.

Public Member Functions
	webPageTree ()
	wrapIcon ($thePageIcon, &$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
	$ext_separateNotinmenuPages
	$ext_alphasortNotinmenuPages
	$ajaxStatus = false

---

Detailed Description

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

---

Member Function Documentation

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 336 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 404 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 298 of file class.webpagetree.php.

References $row.

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 319 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 183 of file class.webpagetree.php.

webPageTree::webPageTree

(

)

Calls init functions

Returns:

void

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

References t3lib_browseTree\init().

webPageTree::wrapIcon	(	$	thePageIcon,
		&$	row
	)

Wrapping icon in browse tree

Parameters:

string	Icon IMG code
array	Data row for element.

Returns:

string Page icon

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

References $GLOBALS, $row, t3lib_iconWorks\getSpriteIcon(), and t3lib_BEfunc\isRecordLocked().

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_browseTree.

Definition at line 139 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 155 of file class.webpagetree.php.

---

Member Data Documentation

webPageTree::$ajaxStatus = false

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

webPageTree::$ext_alphasortNotinmenuPages

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

webPageTree::$ext_IconMode

Reimplemented from t3lib_treeView.

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

webPageTree::$ext_separateNotinmenuPages

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

webPageTree::$ext_showPageId

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

---

The documentation for this class was generated from the following file:

• typo3/class.webpagetree.php