TYPO3 API  SVNRelease
Public Member Functions | Protected Member Functions | Protected Attributes
tslib_AdminPanel Class Reference

List of all members.

Public Member Functions

 __construct ()
 initialize ()
 getAdminPanelHeaderData ()
 isAdminModuleEnabled ($key)
 saveConfigOptions ()
 extGetFeAdminValue ($sectionName, $val= '')
 forcePreview ()
 getExtPublishList ()
 isAdminModuleOpen ($pre)
 display ()
 ext_makeToolBar ()

Protected Member Functions

 getHiddenFields ($key, array $val)
 getPreviewModule ()
 getCacheModule ()
 getPublishModule ()
 getEditModule ()
 getTSDebugModule ()
 getInfoModule ()
 extGetHead ($sectionSuffix)
 linkSectionHeader ($sectionSuffix, $sectionTitle, $className= '')
 extGetItem ($title, $content= '', $checkboxContent= '')
 extGetLL ($key)

Protected Attributes

 $extNeedUpdate = false
 $ext_forcePreview = false
 $extPublishList = ''

Detailed Description

Definition at line 39 of file class.tslib_adminpanel.php.


Constructor & Destructor Documentation

tslib_AdminPanel::__construct ( )

Definition at line 62 of file class.tslib_adminpanel.php.

References initialize().


Member Function Documentation

tslib_AdminPanel::display ( )
tslib_AdminPanel::ext_makeToolBar ( )

Creates the tool bar links for the "edit" section of the Admin Panel.

Returns:
string A string containing images wrapped in -tags linking them to proper functions.

Definition at line 750 of file class.tslib_adminpanel.php.

References $GLOBALS, $res, $row, extGetLL(), t3lib_extMgm\extRelPath(), t3lib_div\getIndpEnv(), t3lib_BEfunc\getModTSconfig(), t3lib_BEfunc\getModuleUrl(), t3lib_extMgm\isLoaded(), and t3lib_iconWorks\skinImg().

Referenced by getEditModule().

tslib_AdminPanel::extGetFeAdminValue ( sectionName,
val = '' 
)

Returns the value for a Admin Panel setting. You must specify both the module-key and the internal setting key.

Parameters:
stringModule key
stringSetting key
Returns:
string The setting value

Definition at line 208 of file class.tslib_adminpanel.php.

References $GLOBALS, t3lib_div\callUserFunction(), t3lib_div\deprecationLog(), isAdminModuleEnabled(), and isAdminModuleOpen().

Referenced by getCacheModule(), getInfoModule(), getPublishModule(), getTSDebugModule(), initialize(), and saveConfigOptions().

tslib_AdminPanel::extGetHead ( sectionSuffix) [protected]

Returns a row (with colspan=4) which is a header for a section in the Admin Panel. It will have a plus/minus icon and a label which is linked so that it submits the form which surrounds the whole Admin Panel when clicked, alterting the TSFE_ADMIN_PANEL[display_' . $pre . '] value See the functions get*Module

Parameters:
stringThe suffix to the display_ label. Also selects the label from the LOCAL_LANG array.
Returns:
string HTML table row. private
See also:
extGetItem()

Definition at line 702 of file class.tslib_adminpanel.php.

References $GLOBALS, extGetLL(), and linkSectionHeader().

Referenced by getCacheModule(), getEditModule(), getInfoModule(), getPreviewModule(), getPublishModule(), and getTSDebugModule().

tslib_AdminPanel::extGetItem ( title,
content = '',
checkboxContent = '' 
) [protected]

Returns a row (with 4 columns) for content in a section of the Admin Panel. It will take $pre as a key to a label to display and $element as the content to put into the forth cell.

Parameters:
stringKey to label
stringThe HTML content for the forth table cell.
Returns:
string HTML table row. private
See also:
extGetHead()

Definition at line 738 of file class.tslib_adminpanel.php.

References $content, and extGetLL().

Referenced by getCacheModule(), getEditModule(), getPreviewModule(), getPublishModule(), and getTSDebugModule().

tslib_AdminPanel::extGetLL ( key) [protected]

Returns the label for key, $key. If a translation for the language set in $GLOBALS['BE_USER']->uc['lang'] is found that is returned, otherwise the default value. IF the global variable $LOCAL_LANG is NOT an array (yet) then this function loads the global $LOCAL_LANG array with the content of "sysext/lang/locallang_tsfe.php" so that the values therein can be used for labels in the Admin Panel

FIXME The function should onvert to $TSFE->renderCharset, not to UTF8!

Parameters:
stringKey for a label in the $LOCAL_LANG array of "sysext/lang/locallang_tsfe.php"
Returns:
string The value for the $key

Definition at line 819 of file class.tslib_adminpanel.php.

References $GLOBALS.

Referenced by display(), ext_makeToolBar(), extGetHead(), extGetItem(), getCacheModule(), getEditModule(), and getPublishModule().

tslib_AdminPanel::forcePreview ( )

Enables the force preview option.

Returns:
void

Definition at line 255 of file class.tslib_adminpanel.php.

tslib_AdminPanel::getAdminPanelHeaderData ( )

Obtains header data for the admin panel.

Returns:
string

Definition at line 117 of file class.tslib_adminpanel.php.

References $GLOBALS, and t3lib_div\locationHeaderUrl().

tslib_AdminPanel::getCacheModule ( ) [protected]

Creates the content for the "cache" section ("module") of the Admin Panel

Returns:
string HTML content for the section. Consists of a string with table-rows with four columns.
See also:
display()

Definition at line 467 of file class.tslib_adminpanel.php.

References $GLOBALS, $row, extGetFeAdminValue(), extGetHead(), extGetItem(), extGetLL(), and t3lib_iconWorks\skinImg().

Referenced by display().

tslib_AdminPanel::getEditModule ( ) [protected]

Creates the content for the "edit" section ("module") of the Admin Panel

Returns:
string HTML content for the section. Consists of a string with table-rows with four columns.
See also:
display()

Definition at line 548 of file class.tslib_adminpanel.php.

References $GLOBALS, t3lib_div\_GP(), ext_makeToolBar(), extGetHead(), extGetItem(), extGetLL(), and t3lib_BEfunc\isModuleSetInTBE_MODULES().

Referenced by display().

tslib_AdminPanel::getExtPublishList ( )

Returns the comma-separated list of page UIDs to be published.

Returns:
string

Definition at line 264 of file class.tslib_adminpanel.php.

tslib_AdminPanel::getHiddenFields ( key,
array $  val 
) [protected]

Fetches recursively all GET parameters as hidden fields. Called from display()

Parameters:
stringcurrent key
mixedcurrent value
Returns:
string hidden fields
See also:
display()

Definition at line 410 of file class.tslib_adminpanel.php.

Referenced by display().

tslib_AdminPanel::getInfoModule ( ) [protected]

Creates the content for the "info" section ("module") of the Admin Panel

Returns:
string HTML content for the section. Consists of a string with table-rows with four columns.
See also:
display()

Definition at line 623 of file class.tslib_adminpanel.php.

References $GLOBALS, extGetFeAdminValue(), extGetHead(), and t3lib_div\formatSize().

Referenced by display().

tslib_AdminPanel::getPreviewModule ( ) [protected]

Creates the content for the "preview" section ("module") of the Admin Panel

Returns:
string HTML content for the section. Consists of a string with table-rows with four columns.
See also:
display()

Definition at line 434 of file class.tslib_adminpanel.php.

References $GLOBALS, $res, $row, t3lib_BEfunc\deleteClause(), extGetHead(), and extGetItem().

Referenced by display().

tslib_AdminPanel::getPublishModule ( ) [protected]

Creates the content for the "publish" section ("module") of the Admin Panel

Parameters:
stringOptional start-value; The generated content is added to this variable.
Returns:
string HTML content for the section. Consists of a string with table-rows with four columns.
See also:
display()

Definition at line 509 of file class.tslib_adminpanel.php.

References $GLOBALS, $row, extGetFeAdminValue(), extGetHead(), extGetItem(), extGetLL(), and t3lib_iconWorks\skinImg().

Referenced by display().

tslib_AdminPanel::getTSDebugModule ( ) [protected]

Creates the content for the "tsdebug" section ("module") of the Admin Panel

Returns:
string HTML content for the section. Consists of a string with table-rows with four columns.
See also:
display()

Definition at line 592 of file class.tslib_adminpanel.php.

References $GLOBALS, extGetFeAdminValue(), extGetHead(), and extGetItem().

Referenced by display().

tslib_AdminPanel::initialize ( )

Initializes settings for the admin panel.

Returns:
void

Definition at line 77 of file class.tslib_adminpanel.php.

References $GLOBALS, t3lib_div\_GP(), extGetFeAdminValue(), and saveConfigOptions().

Referenced by __construct().

tslib_AdminPanel::isAdminModuleEnabled ( key)

Checks if a Admin Panel section ("module") is available for the user. If so, true is returned.

Parameters:
stringThe module key, eg. "edit", "preview", "info" etc.
Returns:
boolean

Definition at line 137 of file class.tslib_adminpanel.php.

References $GLOBALS.

Referenced by display(), extGetFeAdminValue(), and saveConfigOptions().

tslib_AdminPanel::isAdminModuleOpen ( pre)

Returns true if admin panel module is open

Parameters:
stringModule key
Returns:
boolean True, if the admin panel is open for the specified admin panel module key.

Definition at line 274 of file class.tslib_adminpanel.php.

References $GLOBALS.

Referenced by extGetFeAdminValue().

tslib_AdminPanel::linkSectionHeader ( sectionSuffix,
sectionTitle,
className = '' 
) [protected]

Wraps a string in a link which will open/close a certain part of the Admin Panel

Parameters:
stringThe code for the display_ label/key
stringInput string
Returns:
string Linked input string private
See also:
extGetHead()

Definition at line 722 of file class.tslib_adminpanel.php.

References $GLOBALS.

Referenced by display(), and extGetHead().

tslib_AdminPanel::saveConfigOptions ( )

Saves any change in settings made in the Admin Panel. Called from index_ts.php right after access check for the Admin Panel

Returns:
void

Definition at line 163 of file class.tslib_adminpanel.php.

References $GLOBALS, t3lib_div\_GP(), t3lib_div\callUserFunction(), t3lib_div\deprecationLog(), extGetFeAdminValue(), and isAdminModuleEnabled().

Referenced by initialize().


Member Data Documentation

tslib_AdminPanel::$ext_forcePreview = false [protected]

Definition at line 53 of file class.tslib_adminpanel.php.

tslib_AdminPanel::$extNeedUpdate = false [protected]

Definition at line 46 of file class.tslib_adminpanel.php.

tslib_AdminPanel::$extPublishList = '' [protected]

Definition at line 60 of file class.tslib_adminpanel.php.


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