TYPO3 - the Enterprise Open Source CMS: Documentation: Developer API (Developer API)

1.5. Section 3 - BackEnd

About this section

Functions for backend development.

All of those functions are only available in a backend context. They also all need the API class to be instantiated, as they will use the internal variable $pObj.

Do not try to use them out of a backend context, and without the API class instantiated.

be_buildRecordIcons

Build action icons.

This function creates the icon(s) associated with an action to do on a record. Compatible with Typo3 skinning functions.

Parameters

Parameter:	Default value:	Description:
$actions		The action(s) to produce, as a comma list (can be 'show', 'edit' or 'delete' at the moment).
$table		The table of the record.
$uid		The record uid.

Return

The record icons

be_buildPageTreeSelect

Build a select menu representing the page tree.

This function creates a select menu containing the page tree from a specified page ID.

Parameters

Parameter:	Default value:	Description:
$name		The name of the select.
$treeStartingPoint	0	The starting point for the page tree.
$size	'1'	The size of the select.
$multiple	false	Allow multiple selection.
$pageIcons	1	Render page icons in option tags.

Return

A select menu with the page tree

be_getSelectStyleRecordIcon

Build CSS styles for select menu items.

This function creates the CSS styles to correctly display a record icon inside an option tag of a select menu.

Parameters

Parameter:	Default value:	Description:
$table		The table.
$rec		The record row (array).
$backPath		The back path to typo3 (usually $GLOBALS['BACK_PATH']).

Return

CSS styles ready to be included in a style parameter

be_initCSM

Init CSM.

This function initialize the Contenxt Sensitive Menu (CSM), in order to use it in a backend module.

Return

Void

be_getRecordCSMIcon

Get CSM menu for a record.

This function creates an icon of the requested record with aContext Sensitive Menu (CSM).

Parameters

Parameter:	Default value:	Description:
$table		The table of the record.
$rec		The record row.
$backPath		The back path to typo3 (usually $GLOBALS['BACK_PATH']).
$align	top	The align parameter of the IMG tag.

Return

The icon with CSM menu