localPageTree Class Reference

Inheritance diagram for localPageTree:

Inheritance graph
[legend]
Collaboration diagram for localPageTree:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 localPageTree ()
 wrapIcon ($icon, &$row)
 wrapStop ($str, $row)
 wrapTitle ($title, $row, $bank=0)
 localPageTree ()
 wrapTitle ($title, $v, $ext_pArrPages='')
 printTree ($treeArr='')
 ext_isLinkable ($doktype, $uid)
 PM_ATagWrap ($icon, $cmd, $bMark='')
 wrapIcon ($icon, $row)
 wrapIcon ($icon, $row)
 expandNext ($id)
 wrapIcon ($icon, $row)
 localPageTree ($BE_USER, $WEBMOUNTS='')
 ext_permsC ()
 wrapTitle ($str, $row)
 PM_ATagWrap ($icon, $cmd, $bMark='')
 wrapIcon ($icon, $row)
 initializePositionSaving ()
 localPageTree ()
 wrapTitle ($title, $v)
 PM_ATagWrap ($icon, $cmd, $bMark='')
 wrapIcon ($icon, $row)
 permsC ()
 ext_tree ($pid, $clause='')
 localPageTree ()
 wrapTitle ($title, $v, $ext_pArrPages='')
 printTree ($treeArr='')
 ext_isLinkable ($doktype, $uid)
 PM_ATagWrap ($icon, $cmd, $bMark='')
 wrapIcon ($icon, $row)

Public Attributes

 $ext_showPageId
 $ext_IconMode
 $expandFirst = 0
 $expandAll = 0

Detailed Description

Definition at line 78 of file alt_db_navframe.php.

Member Function Documentation

localPageTree::localPageTree (  ) 

Calls init functions

Returns:
void

Definition at line 88 of file alt_db_navframe.php.

localPageTree::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 99 of file alt_db_navframe.php.

localPageTree::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 142 of file alt_db_navframe.php.

localPageTree::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.

Reimplemented in TBE_PageTree, and TBE_PageTree.

Definition at line 158 of file alt_db_navframe.php.

localPageTree::localPageTree (  ) 

Constructor. Just calling init()

Returns:
void

Definition at line 267 of file class.browse_links.php.

localPageTree::wrapTitle ( $  title,
$  v,
$  ext_pArrPages = '' 
)

Wrapping the title in a link, if applicable.

Parameters:
string Title, (must be ready for output, that means it must be htmlspecialchars()'ed).
array The record
boolean (Ignore)
Returns:
string Wrapping title string.

Reimplemented from t3lib_treeView.

Reimplemented in TBE_PageTree, and TBE_PageTree.

Definition at line 283 of file class.browse_links.php.

localPageTree::printTree ( $  treeArr = ''  ) 

Create the page navigation tree in HTML

Parameters:
array Tree array
Returns:
string HTML output.

Reimplemented from t3lib_treeView.

Definition at line 298 of file class.browse_links.php.

localPageTree::ext_isLinkable ( $  doktype,
$  uid 
)

Returns true if a doktype can be linked.

Parameters:
integer Doktype value to test
integer uid to test.
Returns:
boolean

Reimplemented in TBE_PageTree, and TBE_PageTree.

Definition at line 349 of file class.browse_links.php.

localPageTree::PM_ATagWrap ( $  icon,
$  cmd,
$  bMark = '' 
)

Wrap the plus/minus icon in a link

Parameters:
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)
Returns:
string Link-wrapped input string

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 363 of file class.browse_links.php.

localPageTree::wrapIcon ( $  icon,
$  row 
)

Wrapping the image tag, $icon, for the row, $row

Parameters:
string The image tag for the icon
array The row for the current element
Returns:
string The processed icon input value.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 380 of file class.browse_links.php.

localPageTree::wrapIcon ( $  icon,
$  row 
)

Inserting uid-information in title-text for an icon

Parameters:
string Icon image
array Item row
Returns:
string Wrapping icon image.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 99 of file db_new.php.

localPageTree::expandNext ( $  id  ) 

Determines whether to expand a branch or not. Here the branch is expanded if the current id matches the global id for the listing/new

Parameters:
integer The ID (page id) of the element
Returns:
boolean Returns true if the IDs matches

Reimplemented from t3lib_pageTree.

Definition at line 110 of file db_new.php.

localPageTree::wrapIcon ( $  icon,
$  row 
)

Inserting uid-information in title-text for an icon

Parameters:
string Icon image
array Item row
Returns:
string Wrapping icon image.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 105 of file move_el.php.

localPageTree::localPageTree ( $  BE_USER,
$  WEBMOUNTS = '' 
)

Constructor for the local page tree.

Parameters:
object Local backend user (not the GLOBALS[] backend user!!)
array Webmounts for the backend user.
Returns:
void

Definition at line 140 of file index.php.

localPageTree::ext_permsC (  ) 

Return select permissions.

Returns:
string WHERE query part.

Reimplemented in printAllPageTree.

Definition at line 154 of file index.php.

localPageTree::wrapTitle ( $  str,
$  row 
)

Wraps the title.

Parameters:
string [See parent]
array [See parent]
Returns:
string

Definition at line 165 of file index.php.

localPageTree::PM_ATagWrap ( $  icon,
$  cmd,
$  bMark = '' 
)

Wraps the plus/minus icon - in this case we just return blank which means we STRIP AWAY the plus/minus icon!

Parameters:
string [See parent]
string [See parent]
string [See parent]
Returns:
string

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 177 of file index.php.

localPageTree::wrapIcon ( $  icon,
$  row 
)

Wrapping the icon of the element/page. Normally a click menu is wrapped around the icon, but in this case only a title parameter is set.

Parameters:
string Icon image tag.
array Row.
Returns:
string Icon with title attribute added.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 188 of file index.php.

localPageTree::initializePositionSaving (  ) 

This will make sure that no position data is acquired from the BE_USER uc variable.

Returns:
void

Reimplemented from t3lib_pageTree.

Definition at line 201 of file index.php.

localPageTree::localPageTree (  ) 

Initialization

Returns:
void

Definition at line 144 of file index.php.

localPageTree::wrapTitle ( $  title,
$  v 
)

Wrapping title from page tree.

Parameters:
string Title to wrap
mixed (See parent class)
Returns:
string Wrapped title

Definition at line 155 of file index.php.

localPageTree::PM_ATagWrap ( $  icon,
$  cmd,
$  bMark = '' 
)

Wrapping Plus/Minus icon

Parameters:
string Icon HTML
mixed (See parent class)
mixed (See parent class)
Returns:
string Icon HTML

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 168 of file index.php.

localPageTree::wrapIcon ( $  icon,
$  row 
)

Wrapping Icon

Parameters:
string Icon HTML
array Record row (page)
Returns:
string Icon HTML

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 179 of file index.php.

localPageTree::permsC (  ) 

Select permissions

Returns:
string SQL where clause

Definition at line 188 of file index.php.

localPageTree::ext_tree ( $  pid,
$  clause = '' 
)

Tree rendering

Parameters:
integer PID value
string Additional where clause
Returns:
array Array of tree elements

Definition at line 199 of file index.php.

localPageTree::localPageTree (  ) 

Constructor. Just calling init()

Returns:
void

Definition at line 250 of file browse_links.php.

localPageTree::wrapTitle ( $  title,
$  v,
$  ext_pArrPages = '' 
)

Wrapping the title in a link, if applicable.

Parameters:
string Title, (must be ready for output, that means it must be htmlspecialchars()'ed).
array The record
boolean (Ignore)
Returns:
string Wrapping title string.

Reimplemented from t3lib_treeView.

Reimplemented in TBE_PageTree, and TBE_PageTree.

Definition at line 263 of file browse_links.php.

localPageTree::printTree ( $  treeArr = ''  ) 

Create the page navigation tree in HTML

Parameters:
array Tree array
Returns:
string HTML output.

Reimplemented from t3lib_treeView.

Definition at line 278 of file browse_links.php.

localPageTree::ext_isLinkable ( $  doktype,
$  uid 
)

Returns true if a doktype can be linked.

Parameters:
integer Doktype value to test
integer uid to test.
Returns:
boolean

Reimplemented in TBE_PageTree, and TBE_PageTree.

Definition at line 327 of file browse_links.php.

localPageTree::PM_ATagWrap ( $  icon,
$  cmd,
$  bMark = '' 
)

Wrap the plus/minus icon in a link

Parameters:
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)
Returns:
string Link-wrapped input string

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 341 of file browse_links.php.

localPageTree::wrapIcon ( $  icon,
$  row 
)

Wrapping the image tag, $icon, for the row, $row

Parameters:
string The image tag for the icon
array The row for the current element
Returns:
string The processed icon input value.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 358 of file browse_links.php.

The documentation for this class was generated from the following files:
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!