"TYPO3 4.0.1: t3lib_tsfeBeUserAuth Class Reference", "datetime" => "Sat Dec 2 19:26:28 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

t3lib_tsfeBeUserAuth Class Reference

Inheritance diagram for t3lib_tsfeBeUserAuth:

[legend]Collaboration diagram for t3lib_tsfeBeUserAuth:

[legend]List of all members.

Public Member Functions
	extInitFeAdmin ()
	extPrintFeAdminDialog ()
	extPrintFeAdminDialogHiddenFields ($key, &$val)
	extGetCategory_preview ($out='')
	extGetCategory_cache ($out='')
	extGetCategory_publish ($out='')
	extGetCategory_edit ($out='')
	extGetCategory_tsdebug ($out='')
	extGetCategory_info ($out='')
	extGetHead ($pre)
	extItemLink ($pre, $str)
	extGetItem ($pre, $element)
	extFw ($str)
	ext_makeToolBar ()
	checkBackendAccessSettingsFromInitPhp ()
	extPageReadAccess ($pageRec)
	extAdmModuleEnabled ($key)
	extSaveFeAdminConfig ()
	extGetFeAdminValue ($pre, $val='')
	extIsAdmMenuOpen ($pre)
	extGetTreeList ($id, $depth, $begin=0, $perms_clause)
	extGetNumberOfCachedPages ($page_id)
	extGetLL ($key)
	extIsEditAction ()
	extIsFormShown ()
	extEditAction ()
Public Attributes
	$formfield_uname = ''
	$formfield_uident = ''
	$formfield_chalvalue = ''
	$security_level = ''
	$writeStdLog = 0
	$writeAttemptLog = 0
	$auth_include = ''
	$extNeedUpdate = 0
	$extPublishList = ''
	$extPageInTreeInfo = array()
	$ext_forcePreview = 0
	$langSplitIndex = 0
	$extAdmEnabled = 0

---

Detailed Description

Definition at line 103 of file class.t3lib_tsfebeuserauth.php.

---

Member Function Documentation

t3lib_tsfeBeUserAuth::checkBackendAccessSettingsFromInitPhp (   )

Implementing the access checks that the typo3/init.php script does before a user is ever logged in. Used in the frontend. Returns: boolean Returns true if access is OK See also: typo3/init.php, t3lib_beuserauth::backendCheckLogin() Definition at line 672 of file class.t3lib_tsfebeuserauth.php. References t3lib_div::cmpIP(), t3lib_div::getIndpEnv(), and t3lib_userAuthGroup::isAdmin().

t3lib_tsfeBeUserAuth::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 600 of file class.t3lib_tsfebeuserauth.php. References t3lib_userAuth::$id, t3lib_userAuthGroup::check(), t3lib_extMgm::extRelPath(), t3lib_BEfunc::getModTSconfig(), and t3lib_extMgm::isLoaded(). Referenced by extGetCategory_edit().

t3lib_tsfeBeUserAuth::extAdmModuleEnabled (  $  key  )

Checks if a Admin Panel section ("module") is available for the user. If so, true is returned. Parameters: string  The module key, eg. "edit", "preview", "info" etc. Returns: boolean See also: extPrintFeAdminDialog() Definition at line 728 of file class.t3lib_tsfebeuserauth.php. Referenced by extGetFeAdminValue(), extPrintFeAdminDialog(), and extSaveFeAdminConfig().

t3lib_tsfeBeUserAuth::extEditAction (   )

Management of the on-page frontend editing forms and edit panels. Basically taking in the data and commands and passes them on to the proper classes as they should be. Returns: void See also: index_ts.php Definition at line 1005 of file class.t3lib_tsfebeuserauth.php. References t3lib_div::callUserFunction(), extGetFeAdminValue(), t3lib_div::makeInstance(), and t3lib_div::trimExplode().

t3lib_tsfeBeUserAuth::extFw (  $  str  )

Wraps a string in a font-tag with verdana, size 1 and black Parameters: string  The string to wrap Returns: string Definition at line 591 of file class.t3lib_tsfebeuserauth.php. Referenced by extGetCategory_edit(), extGetHead(), extGetItem(), and extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetCategory_cache (  $  out = ''  )

Creates the content for the "cache" section ("module") of the Admin Panel Parameters: string  Optional 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: extPrintFeAdminDialog() Definition at line 315 of file class.t3lib_tsfebeuserauth.php. References extGetFeAdminValue(), extGetHead(), extGetItem(), extGetLL(), extGetNumberOfCachedPages(), extGetTreeList(), and t3lib_userAuthGroup::getPagePermsClause(). Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetCategory_edit (  $  out = ''  )

Creates the content for the "edit" section ("module") of the Admin Panel Parameters: string  Optional 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: extPrintFeAdminDialog() Definition at line 388 of file class.t3lib_tsfebeuserauth.php. References t3lib_div::_GP(), ext_makeToolBar(), extFw(), extGetHead(), extGetItem(), extGetLL(), t3lib_userAuthGroup::getTSConfigVal(), and t3lib_BEfunc::isModuleSetInTBE_MODULES(). Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetCategory_info (  $  out = ''  )

Creates the content for the "info" section ("module") of the Admin Panel Parameters: string  Optional 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: extPrintFeAdminDialog() Definition at line 465 of file class.t3lib_tsfebeuserauth.php. References extGetFeAdminValue(), extGetHead(), and t3lib_div::formatSize(). Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetCategory_preview (  $  out = ''  )

Creates the content for the "preview" section ("module") of the Admin Panel Parameters: string  Optional 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: extPrintFeAdminDialog() Definition at line 282 of file class.t3lib_tsfebeuserauth.php. References extGetHead(), and extGetItem(). Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetCategory_publish (  $  out = ''  )

Creates the content for the "publish" section ("module") of the Admin Panel Parameters: string  Optional 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: extPrintFeAdminDialog() Definition at line 353 of file class.t3lib_tsfebeuserauth.php. References extGetFeAdminValue(), extGetHead(), extGetItem(), extGetLL(), extGetTreeList(), and t3lib_userAuthGroup::getPagePermsClause(). Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetCategory_tsdebug (  $  out = ''  )

Creates the content for the "tsdebug" section ("module") of the Admin Panel Parameters: string  Optional 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: extPrintFeAdminDialog() Definition at line 432 of file class.t3lib_tsfebeuserauth.php. References extGetFeAdminValue(), extGetHead(), and extGetItem(). Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetFeAdminValue (  $  pre, $  val = '' )

Returns the value for a Admin Panel setting. You must specify both the module-key and the internal setting key. Parameters: string  Module key string  Setting key Returns: string The setting value Definition at line 776 of file class.t3lib_tsfebeuserauth.php. References extAdmModuleEnabled(), and extIsAdmMenuOpen(). Referenced by extEditAction(), extGetCategory_cache(), extGetCategory_info(), extGetCategory_publish(), extGetCategory_tsdebug(), extInitFeAdmin(), and extSaveFeAdminConfig().

t3lib_tsfeBeUserAuth::extGetHead (  $  pre  )

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 extGetCategory_* Parameters: string  The 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 538 of file class.t3lib_tsfebeuserauth.php. References extFw(), extGetLL(), and extItemLink(). Referenced by extGetCategory_cache(), extGetCategory_edit(), extGetCategory_info(), extGetCategory_preview(), extGetCategory_publish(), and extGetCategory_tsdebug().

t3lib_tsfeBeUserAuth::extGetItem (  $  pre, $  element )

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: string  Key to label string  The HTML content for the forth table cell. Returns: string HTML table row. private See also: extGetHead() Definition at line 574 of file class.t3lib_tsfebeuserauth.php. References extFw(), and extGetLL(). Referenced by extGetCategory_cache(), extGetCategory_edit(), extGetCategory_preview(), extGetCategory_publish(), and extGetCategory_tsdebug().

t3lib_tsfeBeUserAuth::extGetLL (  $  key  )

Returns the label for key, $key. If a translation for the language set in $this->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 Parameters: string  Key for a label in the $LOCAL_LANG array of "sysext/lang/locallang_tsfe.php" Returns: string The value for the $key Definition at line 923 of file class.t3lib_tsfebeuserauth.php. Referenced by extGetCategory_cache(), extGetCategory_edit(), extGetCategory_publish(), extGetHead(), extGetItem(), and extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extGetNumberOfCachedPages (  $  page_id  )

Returns the number of cached pages for a page id. Parameters: integer  The page id. Returns: integer The number of pages for this page in the table "cache_pages" Definition at line 884 of file class.t3lib_tsfebeuserauth.php. Referenced by extGetCategory_cache().

t3lib_tsfeBeUserAuth::extGetTreeList (  $  id, $  depth, $  begin = 0, $  perms_clause )

Generates a list of Page-uid's from $id. List does not include $id itself The only pages excluded from the list are deleted pages. Parameters: integer  Start page id integer  Depth to traverse down the page tree. integer  $begin is an optional integer that determines at which level in the tree to start collecting uid's. Zero means 'start right away', 1 = 'next level and out' string  Perms clause Returns: string Returns the list with a comma in the end (if any pages selected!) Definition at line 853 of file class.t3lib_tsfebeuserauth.php. References t3lib_userAuth::$id. Referenced by extGetCategory_cache(), extGetCategory_publish(), tx_indexedsearch_modfunc2::extGetTreeList(), and extSaveFeAdminConfig().

t3lib_tsfeBeUserAuth::extInitFeAdmin (   )

Initialize the usage of Admin Panel. Called from index_ts.php if a backend users is correctly logged in. Sets $this->extAdminConfig to the "admPanel" config for the user and $this->extAdmEnabled = 1 IF access is enabled. Returns: void Definition at line 129 of file class.t3lib_tsfebeuserauth.php. References t3lib_div::_POST(), extGetFeAdminValue(), and t3lib_userAuthGroup::getTSConfigProp().

t3lib_tsfeBeUserAuth::extIsAdmMenuOpen (  $  pre  )

Returns true if admin panel module is open Parameters: string  Module key Returns: boolean True, if the admin panel is open for the specified admin panel module key. Definition at line 818 of file class.t3lib_tsfebeuserauth.php. Referenced by extGetFeAdminValue().

t3lib_tsfeBeUserAuth::extIsEditAction (   )

Returns true in an edit-action is sent from the Admin Panel Returns: boolean See also: index_ts.php Definition at line 967 of file class.t3lib_tsfebeuserauth.php.

t3lib_tsfeBeUserAuth::extIsFormShown (   )

Returns true if an edit form is shown on the page. Used from index_ts.php where a true return-value will result in classes etc. being included. Returns: boolean See also: index_ts.php Definition at line 989 of file class.t3lib_tsfebeuserauth.php.

t3lib_tsfeBeUserAuth::extItemLink (  $  pre, $  str )

Wraps a string in a link which will open/close a certain part of the Admin Panel Parameters: string  The code for the display_ label/key string  Input string Returns: string Linked input string private See also: extGetHead() Definition at line 558 of file class.t3lib_tsfebeuserauth.php. Referenced by extGetHead(), and extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extPageReadAccess (  $  pageRec  )

Evaluates if the Backend User has read access to the input page record. The evaluation is based on both read-permission and whether the page is found in one of the users webmounts. Only if both conditions are true will the function return true. Read access means that previewing is allowed etc. Used in index_ts.php Parameters: array  The page record to evaluate for Returns: boolean True if read access Definition at line 717 of file class.t3lib_tsfebeuserauth.php. References t3lib_userAuthGroup::doesUserHaveAccess(), and t3lib_userAuthGroup::isInWebMount().

t3lib_tsfeBeUserAuth::extPrintFeAdminDialog (   )

Creates and returns the HTML code for the Admin Panel in the TSFE frontend. Called from index_ts.php - in the end of the script Returns: string HTML for the Admin Panel See also: index_ts.php Definition at line 154 of file class.t3lib_tsfebeuserauth.php. References t3lib_div::_GET(), extAdmModuleEnabled(), extFw(), extGetCategory_cache(), extGetCategory_edit(), extGetCategory_info(), extGetCategory_preview(), extGetCategory_publish(), extGetCategory_tsdebug(), extGetLL(), extItemLink(), and extPrintFeAdminDialogHiddenFields().

t3lib_tsfeBeUserAuth::extPrintFeAdminDialogHiddenFields (  $  key, &$  val )

Fetches recursively all GET parameters as hidden fields. Called from extPrintFeAdminDialog. Parameters: string  current key mixed  current value Returns: string hidden fields See also: extPrintFeAdminDialog() Definition at line 242 of file class.t3lib_tsfebeuserauth.php. Referenced by extPrintFeAdminDialog().

t3lib_tsfeBeUserAuth::extSaveFeAdminConfig (   )

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 744 of file class.t3lib_tsfebeuserauth.php. References t3lib_div::_GET(), extAdmModuleEnabled(), extGetFeAdminValue(), extGetTreeList(), t3lib_userAuthGroup::getPagePermsClause(), and t3lib_userAuth::writeUC().

---

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

• typo3_src-4.0.1/t3lib/class.t3lib_tsfebeuserauth.php