TYPO3 API  SVNRelease
Public Member Functions | Public Attributes
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 ()
 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='')

Public Attributes

 $ext_showPageId = FALSE
 $expandFirst = 0
 $expandAll = 0
 $BE_USER

Detailed Description

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


Member Function Documentation

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:
integerThe ID (page id) of the element
Returns:
boolean Returns true if the IDs matches

Reimplemented from t3lib_pageTree.

Definition at line 100 of file db_new.php.

References $GLOBALS.

localPageTree::ext_isLinkable ( doktype,
uid 
)

Returns true if a doktype can be linked.

Parameters:
integerDoktype value to test
integeruid to test.
Returns:
boolean

Reimplemented in TBE_PageTree.

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

Referenced by wrapTitle().

localPageTree::ext_permsC ( )

Return select permissions.

Returns:
string WHERE query part.

Reimplemented in printAllPageTree.

Definition at line 153 of file index.php.

Referenced by localPageTree().

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

Tree rendering

Parameters:
integerPID value
stringAdditional where clause
Returns:
array Array of tree elements

Definition at line 192 of file index.php.

References t3lib_treeView\$clause, $GLOBALS, $pid, t3lib_div\_GP(), t3lib_iconWorks\getSpriteIconForRecord(), t3lib_treeView\getTree(), t3lib_browseTree\init(), t3lib_div\intExplode(), permsC(), PM_ATagWrap(), t3lib_treeView\reset(), t3lib_iconWorks\skinImg(), and wrapIcon().

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 200 of file index.php.

localPageTree::localPageTree ( )

Initialization

Returns:
void

Definition at line 137 of file index.php.

References t3lib_browseTree\init().

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

Constructor for the local page tree.

Parameters:
objectLocal backend user (not the GLOBALS[] backend user!!)
arrayWebmounts for the backend user.
Returns:
void

Definition at line 139 of file index.php.

References $BE_USER, $WEBMOUNTS, ext_permsC(), and t3lib_browseTree\init().

localPageTree::localPageTree ( )

Constructor. Just calling init()

Returns:
void

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

References t3lib_pageSelect\DOKTYPE_RECYCLER, t3lib_div\getIndpEnv(), and t3lib_browseTree\init().

localPageTree::permsC ( )

Select permissions

Returns:
string SQL where clause

Definition at line 181 of file index.php.

Referenced by ext_tree().

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

Wrapping Plus/Minus icon

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

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 161 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 176 of file index.php.

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

Wrap the plus/minus icon in a link

Parameters:
stringHTML string to wrap, probably an image tag.
stringCommand for 'PM' get var
booleanIf 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 347 of file class.browse_links.php.

Referenced by ext_tree().

localPageTree::printTree ( treeArr = '')

Create the page navigation tree in HTML

Parameters:
arrayTree array
Returns:
string HTML output.

Reimplemented from t3lib_treeView.

Reimplemented in tx_rtehtmlarea_pageTree.

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

References $BACK_PATH, and $GLOBALS.

localPageTree::wrapIcon ( icon,
row 
)

Inserting uid-information in title-text for an icon

Parameters:
stringIcon image
arrayItem row
Returns:
string Wrapping icon image.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 89 of file db_new.php.

References $row, and t3lib_treeView\addTagAttributes().

localPageTree::wrapIcon ( icon,
row 
)

Inserting uid-information in title-text for an icon

Parameters:
stringIcon image
arrayItem row
Returns:
string Wrapping icon image.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 100 of file move_el.php.

References $row, and t3lib_treeView\addTagAttributes().

localPageTree::wrapIcon ( icon,
row 
)

Wrapping Icon

Parameters:
stringIcon HTML
arrayRecord row (page)
Returns:
string Icon HTML

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 172 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:
stringIcon image tag.
arrayRow.
Returns:
string Icon with title attribute added.

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

Definition at line 187 of file index.php.

References $row, t3lib_treeView\$title, t3lib_treeView\addTagAttributes(), and t3lib_BEfunc\getRecordPath().

localPageTree::wrapIcon ( icon,
row 
)

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

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

Reimplemented from t3lib_browseTree.

Reimplemented in printAllPageTree.

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

Referenced by ext_tree().

localPageTree::wrapTitle ( title,
v 
)

Wrapping title from page tree.

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

Definition at line 148 of file index.php.

References $GLOBALS, and t3lib_treeView\$title.

localPageTree::wrapTitle ( str,
row 
)

Wraps the title.

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

Definition at line 164 of file index.php.

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

Wrapping the title in a link, if applicable.

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

Reimplemented from t3lib_treeView.

Reimplemented in TBE_PageTree.

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

References t3lib_treeView\$title, and ext_isLinkable().


Member Data Documentation

localPageTree::$BE_USER

Reimplemented from t3lib_treeView.

Definition at line 130 of file index.php.

Referenced by localPageTree().

localPageTree::$expandAll = 0

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 123 of file index.php.

localPageTree::$expandFirst = 0

Reimplemented from t3lib_treeView.

Reimplemented in printAllPageTree.

Definition at line 122 of file index.php.

localPageTree::$ext_showPageId = FALSE

whether the page ID should be shown next to the title, activate through userTSconfig (options.pageTree.showPageIdWithTitle)

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


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