Static Public Member Functions
static	deleteClause ($table, $tableAlias= '')
static	getRecord ($table, $uid, $fields= '*', $where= '', $useDeleteClause=TRUE)
static	getRecordWSOL ($table, $uid, $fields= '*', $where= '', $useDeleteClause=TRUE, $unsetMovePointers=FALSE)
static	getRecordRaw ($table, $where= '', $fields= '*')
static	getRecordsByField ($theTable, $theField, $theValue, $whereClause= '', $groupBy= '', $orderBy= '', $limit= '', $useDeleteClause=TRUE)
static	splitTable_Uid ($str)
static	getSQLselectableList ($in_list, $tablename, $default_tablename)
static	BEenableFields ($table, $inv=0)
static	getRecordLocalization ($table, $uid, $language, $andWhereClause= '')
static	BEgetRootLine ($uid, $clause= '', $workspaceOL=FALSE)
static	openPageTree ($pid, $clearExpansion)
static	getRecordPath ($uid, $clause, $titleLimit, $fullTitleLimit=0)
static	getExcludeFields ()
static	getExplicitAuthFieldValues ()
static	getSystemLanguages ()
static	isTableLocalizable ($table)
static	getInlineLocalizationMode ($table, $fieldOrConfig)
static	readPageAccess ($id, $perms_clause)
static	getTCAtypes ($table, $rec, $useFieldNameAsKey=0)
static	getTCAtypeValue ($table, $rec)
static	getSpecConfParts ($str, $defaultExtras)
static	getSpecConfParametersFromArray ($pArr)
static	getFlexFormDS ($conf, $row, $table, $fieldName= '', $WSOL=TRUE, $newRecordPidValue=0)
static	getRegisteredFlexForms ($table= 'tt_content')
static	storeHash ($hash, $data, $ident)
static	getHash ($hash, $expTime=0)
static	getPagesTSconfig ($id, $rootLine= '', $returnPartArray=0)
static	updatePagesTSconfig ($id, $pageTS, $TSconfPrefix, $impParams= '')
static	implodeTSParams ($p, $k= '')
static	getUserNames ($fields= 'username, usergroup, usergroup_cached_list, uid', $where= '')
static	getGroupNames ($fields= 'title, uid', $where= '')
static	getListGroupNames ($fields= 'title, uid')
static	blindUserNames ($usernames, $groupArray, $excludeBlindedFlag=0)
static	blindGroupNames ($groups, $groupArray, $excludeBlindedFlag=0)
static	daysUntil ($tstamp)
static	date ($tstamp)
static	datetime ($value)
static	time ($value, $withSeconds=TRUE)
static	calcAge ($seconds, $labels= 'min\|hrs\|days\|yrs')
static	dateTimeAge ($tstamp, $prefix=1, $date= '')
static	titleAltAttrib ($content)
static	thumbCode ($row, $table, $field, $backPath, $thumbScript= '', $uploaddir=NULL, $abs=0, $tparams= '', $size= '')
static	getThumbNail ($thumbScript, $theFile, $tparams= '', $size= '')
static	titleAttribForPages ($row, $perms_clause= '', $includeAttrib=1)
static	getRecordIconAltText ($row, $table= 'pages')
static	getLabelFromItemlist ($table, $col, $key)
static	getItemLabel ($table, $col, $printAllWrap= '')
static	getRecordTitle ($table, $row, $prep=FALSE, $forceResult=TRUE)
static	getRecordTitlePrep ($title, $titleLength=0)
static	getNoRecordTitle ($prep=FALSE)
static	getProcessedValue ($table, $col, $value, $fixed_lgd_chars=0, $defaultPassthrough=0, $noRecordLookup=FALSE, $uid=0, $forceResult=TRUE)
static	getProcessedValueExtra ($table, $fN, $fV, $fixed_lgd_chars=0, $uid=0, $forceResult=TRUE)
static	getFileIcon ($ext)
static	getCommonSelectFields ($table, $prefix= '', $fields=array())
static	makeConfigForm ($configArray, $defaults, $dataPrefix)
static	helpTextIcon ($table, $field, $BACK_PATH, $force=0)
static	helpTextArray ($table, $field)
static	helpText ($table, $field, $BACK_PATH= '', $styleAttrib= '')
static	wrapInHelp ($table, $field, $text= '', array $overloadHelpText=array())
static	cshItem ($table, $field, $BACK_PATH, $wrap= '', $onlyIconMode=FALSE, $styleAttrib= '')
static	editOnClick ($params, $backPath= '', $requestUri= '')
static	viewOnClick ($pageUid, $backPath= '', $rootLine= '', $anchorSection= '', $alternativeUrl= '', $additionalGetVars= '', $switchFocus=TRUE)
static	getViewDomain ($pageId, $rootLine=NULL)
static	getModTSconfig ($id, $TSref)
static	getFuncMenu ($mainParams, $elementName, $currentValue, $menuItems, $script= '', $addparams= '')
static	getFuncCheck ($mainParams, $elementName, $currentValue, $script= '', $addparams= '', $tagParams= '')
static	getFuncInput ($mainParams, $elementName, $currentValue, $size=10, $script="", $addparams="")
static	unsetMenuItems ($modTSconfig, $itemArray, $TSref)
static	setUpdateSignal ($set= '', $params= '')
static	getUpdateSignalCode ()
static	getModuleData ($MOD_MENU, $CHANGED_SETTINGS, $modName, $type= '', $dontValidateList= '', $setDefaultList= '')
static	getModuleUrl ($moduleName, $urlParameters=array(), $backPathOverride=FALSE, $returnAbsoluteUrl=FALSE)
static	getListViewLink ($urlParameters=array(), $linkTitle= '', $linkText= '')
static	getUrlToken ($formName= 'securityToken', $tokenName= 'formToken')
static	compilePreviewKeyword ($getVarsStr, $beUserUid, $ttl=172800, $fullWorkspace=NULL)
static	lockRecords ($table= '', $uid=0, $pid=0)
static	isRecordLocked ($table, $uid)
static	exec_foreign_table_where_query ($fieldValue, $field= '', $TSconfig=array(), $prefix= '')
static	getTCEFORM_TSconfig ($table, $row)
static	getTSconfig_pidValue ($table, $uid, $pid)
static	getPidForModTSconfig ($table, $uid, $pid)
static	getTSCpid ($table, $uid, $pid)
static	firstDomainRecord ($rootLine)
static	getDomainStartPage ($domain, $path= '')
static	RTEsetup ($RTEprop, $table, $field, $type= '')
static &	RTEgetObj ()
static &	softRefParserObj ($spKey)
static	explodeSoftRefParserList ($parserList)
static	isModuleSetInTBE_MODULES ($modName)
static	referenceCount ($table, $ref, $msg= '', $count=NULL)
static	translationCount ($table, $ref, $msg= '')
static	selectVersionsOfRecord ($table, $uid, $fields= '*', $workspace=0, $includeDeletedRecords=FALSE, $row=NULL)
static	fixVersioningPid ($table, &$rr, $ignoreWorkspaceMatch=FALSE)
static	workspaceOL ($table, &$row, $wsid=-99, $unsetMovePointers=FALSE)
static	movePlhOL ($table, &$row)
static	getWorkspaceVersionOfRecord ($workspace, $table, $uid, $fields= '*')
static	getLiveVersionOfRecord ($table, $uid, $fields= '*')
static	getLiveVersionIdOfRecord ($table, $uid)
static	isPidInVersionizedBranch ($pid, $table= '', $returnStage=FALSE)
static	versioningPlaceholderClause ($table)
static	getWorkspaceWhereClause ($table, $workspaceId=NULL)
static	countVersionsOfRecordsOnPage ($workspace, $pageId, $allTables=FALSE)
static	wsMapId ($table, $uid)
static	getMovePlaceholder ($table, $uid, $fields= '*')
static	typo3PrintError ($header, $text, $js= '', $head=1)
static	TYPO3_copyRightNotice ()
static	displayWarningMessages ()
static	getPathType_web_nonweb ($path)
static	ADMCMD_previewCmds ($pageinfo)
static	processParams ($params)
static	getBackendScript ($interface= '')
static	isTableWorkspaceEnabled ($table)
static	getTcaFieldConfiguration ($table, $field)
Static Protected Member Functions
static	getPageForRootline ($uid, $clause, $workspaceOL)

Detailed Description

Definition at line 183 of file class.t3lib_befunc.php.

Member Function Documentation

static t3lib_BEfunc::ADMCMD_previewCmds ( $ pageinfo ) [static]

Creates ADMCMD parameters for the "viewpage" extension / "cms" frontend Usage: 1

Parameters:

array Page record

Returns:: string Query-parameters

Definition at line 4538 of file class.t3lib_befunc.php.

References $GLOBALS.

static t3lib_BEfunc::BEenableFields	(	$	table,
		$	inv = `0`
	)		`[static]`

Backend implementation of enableFields() Notice that "fe_groups" is not selected for - only disabled, starttime and endtime. Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition. $GLOBALS["SIM_ACCESS_TIME"] is used for date. Usage: 5

Parameters:

string	$table	is the table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $TCA.
boolean	$inv	means that the query will select all records NOT VISIBLE records (inverted selection)

Returns:: string WHERE clause part

Definition at line 389 of file class.t3lib_befunc.php.

References $GLOBALS, and $query.

Referenced by Tx_Extbase_Persistence_Storage_Typo3DbBackend\addEnableFieldsStatement(), tx_rtehtmlarea_acronym\buildJSAcronymArray(), tx_scheduler_Module\checkSchedulerUser(), tx_indexedsearch_crawler\crawler_execute_type1(), tx_rtehtmlarea_pi2\drawRTE(), tx_rtehtmlarea_base\drawRTE(), t3lib_tree_pagetree_Commands\getDomainName(), tx_rtehtmlarea_language\getLanguages(), tx_linkvalidator_Processor\getLinkStatistics(), SC_db_layout\getNumberOfHiddenElements(), SC_index\getSystemNews(), tx_cms_layout\getTable_tt_content(), SC_db_layout\renderQuickEdit(), and SC_mod_user_setup_index\simulateUser().

static t3lib_BEfunc::BEgetRootLine	(	$	uid,
		$	clause = `''`,
		$	workspaceOL = `FALSE`
	)		`[static]`

Returns what is called the 'RootLine'. That is an array with information about the page records from a page id ($uid) and back to the root. By default deleted pages are filtered. This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found. Usage: 1

Parameters:

	integer	Page id for which to create the root line.
string	$clause	can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
	boolean	If true, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!

Returns:: array Root line array, all the way to the page tree root (or as far as $clause allows!)

Definition at line 461 of file class.t3lib_befunc.php.

References $pid, $row, and getPageForRootline().

Referenced by tx_version_cm1\adminLinks(), tx_sysaction_task\checkRootline(), tx_cms_treelistCacheUpdate\clearCacheForAllParents(), clickMenu\DB_view(), t3lib_matchCondition_backend\determineRootline(), tx_linkvalidator_linktype_Internal\getBrokenUrl(), localRecordList\getButtons(), SC_mod_web_info_index\getButtons(), SC_mod_web_func_index\getButtons(), SC_mod_web_ts_index\getButtons(), SC_db_new\getButtons(), tx_version_cm1\getButtons(), SC_mod_web_perm_index\getButtons(), SC_mod_tools_log_index\getButtons(), SC_db_layout\getButtons(), t3lib_tree_pagetree_Commands\getMountPointPath(), getPagesTSconfig(), getRecordPath(), tx_cms_BackendLayout\getSelectedBackendLayout(), tx_cms_layout\getSelectedBackendLayoutUid(), tx_cms_layout\getTable_tt_content(), getTCEFORM_TSconfig(), getViewDomain(), wslib_gui\getWorkspaceOverview(), SC_alt_doc\init(), t3lib_userAuthGroup\isInWebMount(), isPidInVersionizedBranch(), SC_mod_web_ts_index\main(), SC_mod_web_view_index\main(), SC_wizard_rte\main(), SC_db_layout\main(), openPageTree(), and template\viewPageIcon().

static t3lib_BEfunc::blindGroupNames	(	$	groups,
		$	groupArray,
		$	excludeBlindedFlag = `0`
	)		`[static]`

Corresponds to blindUserNames but works for groups instead Usage: 2 (module web_perm)

Parameters:

array	Group names
array	Group names (reference)
boolean	If $excludeBlindedFlag is set, then these records are unset from the array $usernames

Returns:: array

Definition at line 1561 of file class.t3lib_befunc.php.

References $row, and t3lib_div\inArray().

Referenced by SC_mod_web_perm_index\doEdit(), and user_SC_mod_user_ws_workspaceForms\processUserAndGroups().

static t3lib_BEfunc::blindUserNames	(	$	usernames,
		$	groupArray,
		$	excludeBlindedFlag = `0`
	)		`[static]`

Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!). If $excludeBlindedFlag is set, then these records are unset from the array $usernames Takes $usernames (array made by t3lib_BEfunc::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input Usage: 8

Parameters:

array	User names
array	Group names
boolean	If $excludeBlindedFlag is set, then these records are unset from the array $usernames

Returns:: array User names, blinded

Definition at line 1527 of file class.t3lib_befunc.php.

References $GLOBALS, $row, and t3lib_div\inList().

Referenced by SC_mod_web_perm_index\doEdit(), tx_cms_layout\getPageInfoBox(), tx_belog_webinfo\main(), SC_mod_tools_log_index\main(), SC_mod_user_ws_index\main(), user_SC_mod_user_ws_workspaceForms\processUserAndGroups(), and SC_mod_web_perm_ajax\renderUserSelector().

static t3lib_BEfunc::calcAge	(	$	seconds,
		$	labels = `'min\|hrs\|days\|yrs'`
	)		`[static]`

Returns the "age" in minutes / hours / days / years of the number of $seconds inputted. Usage: 15

Parameters:

integer	$seconds	could be the difference of a certain timestamp and time()
string	$labels	should be something like ' min\| hrs\| days\| yrs'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears")

Returns:: string Formatted time

Definition at line 1648 of file class.t3lib_befunc.php.

Referenced by recordHistory\displayHistory(), tx_cms_layout\getPageInfoBox(), SC_logomenu\main(), and tx_cms_layout\tt_board_drawItem().

static t3lib_BEfunc::compilePreviewKeyword	(	$	getVarsStr,
		$	beUserUid,
		$	ttl = `172800`,
		$	fullWorkspace = `NULL`
	)		`[static]`

Set preview keyword, eg: $previewUrl = t3lib_div::getIndpEnv('TYPO3_SITE_URL').'index.php?ADMCMD_prev='.t3lib_BEfunc::compilePreviewKeyword('id='.$pageId.'&L='.$language.'&ADMCMD_view=1&ADMCMD_editIcons=1&ADMCMD_previewWS='.$this->workspace, $GLOBALS['BE_USER']->user['uid'], 120);

todo for sys_preview:

Add a comment which can be shown to previewer in frontend in some way (plus maybe ability to write back, take other action?)
Add possibility for the preview keyword to work in the backend as well: So it becomes a quick way to a certain action of sorts?

Parameters:

string	Get variables to preview, eg. 'id=1150&L=0&ADMCMD_view=1&ADMCMD_editIcons=1&ADMCMD_previewWS=8'
string	32 byte MD5 hash keyword for the URL: "?ADMCMD_prev=[keyword]"
integer	Time-To-Live for keyword
integer	Which workspace to preview. Workspace UID, -1 or >0. If set, the getVars is ignored in the frontend, so that string can be empty

Returns:: string Returns keyword to use in URL for ADMCMD_prev=

Definition at line 3208 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by tx_Workspaces_ExtDirect_ActionHandler\generateWorkspacePreviewLink(), and SC_mod_user_ws_index\moduleContent_publish().

static t3lib_BEfunc::countVersionsOfRecordsOnPage	(	$	workspace,
		$	pageId,
		$	allTables = `FALSE`
	)		`[static]`

Count number of versions on a page

Parameters:

integer	Workspace ID
integer	Page ID
boolean	If set, then all tables and not only "versioning_followPages" are found (except other pages)

Returns:: array Overview of records

Definition at line 4191 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_treeView\getDataNext().

static t3lib_BEfunc::cshItem	(	$	table,
		$	field,
		$	BACK_PATH,
		$	wrap = `''`,
		$	onlyIconMode = `FALSE`,
		$	styleAttrib = `''`
	)		`[static]`

API for getting CSH icons/text for use in backend modules. TCA_DESCR will be loaded if it isn't already Usage: ?

Parameters:

string	Table name ('_MOD_'+module name)
string	Field name (CSH locallang main key)
string	Back path
string	Wrap code for icon-mode, splitted by "\|". Not used for full-text mode.
boolean	If set, the full text will never be shown (only icon). Useful for places where it will break the page if the table with full text is shown.
string	Additional style-attribute content for wrapping table (full text mode only)

Returns:: string HTML content for help text

See also:: helpText(), helpTextIcon()

Definition at line 2658 of file class.t3lib_befunc.php.

References $BACK_PATH, $BE_USER, helpText(), and helpTextIcon().

Referenced by recordHistory\displayHistory(), SC_show_rechis\getButtons(), localRecordList\getButtons(), SC_mod_web_info_index\getButtons(), SC_mod_web_func_index\getButtons(), SC_wizard_table\getButtons(), tx_reports_Module\getButtons(), SC_file_edit\getButtons(), SC_alt_file_navframe\getButtons(), SC_wizard_forms\getButtons(), SC_alt_db_navframe\getButtons(), SC_db_new\getButtons(), SC_mod_web_perm_index\getButtons(), SC_db_new_content_el\getButtons(), SC_mod_user_task_index\getButtons(), SC_file_list\getButtons(), SC_mod_user_setup_index\getButtons(), tx_recycler_module1\getDocHeaderButtons(), tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_tt_content(), tx_em_Extensions_Details\helpCol(), tx_wizardsortpages_webfunc_2\main(), tx_cms_webinfo_lang\main(), tx_infopagetsconfig_webinfo\main(), tx_cms_webinfo_page\main(), SC_alt_menu\main(), SC_file_list\main(), SC_file_rename\main(), SC_file_newfolder\main(), SC_file_upload\main(), SC_mod_user_setup_index\main(), SC_db_layout\main(), SC_mod_tools_log_index\makeAdvancedOptionsForm(), SC_mod_tools_log_index\makeConfigurationForm(), SC_mod_tools_log_index\makeSaveForm(), Tx_Fluid_ViewHelpers_Be_Buttons_CshViewHelper\render(), and SC_db_layout\renderQuickEdit().

static t3lib_BEfunc::date ( $ tstamp ) [static]

Returns $tstamp formatted as "ddmmyy" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy']) Usage: 11

Parameters:

integer Time stamp, seconds

Returns:: string Formatted time

Definition at line 1605 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by datetime(), dateTimeAge(), tx_cms_layout\getPageInfoBox(), getProcessedValue(), getRecordIconAltText(), tx_cms_webinfo_page\main(), and tx_cms_layout\tt_content_drawItem().

static t3lib_BEfunc::datetime ( $ value ) [static]

Returns $tstamp formatted as "ddmmyy hhmm" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'] AND $TYPO3_CONF_VARS['SYS']['hhmm']) Usage: 28

Parameters:

integer Time stamp, seconds

Returns:: string Formatted time

Definition at line 1616 of file class.t3lib_befunc.php.

References $GLOBALS, $value, and date().

Referenced by dateTimeAge(), recordHistory\displayHistory(), tx_Workspaces_ExtDirect_Server\getCommentsForRecord(), tx_cms_layout\getPageInfoBox(), SC_mod_tools_isearch_index\getPhashExternalDocs(), SC_mod_tools_isearch_index\getPhashT3pages(), getProcessedValue(), getProcessedValueExtra(), tx_lowlevel_syslog\main(), tx_dbal_module1\printLogMgm(), tx_cms_layout\tt_board_drawItem(), and SC_mod_user_ws_index\workspaceList_formatWorkspaceData().

static t3lib_BEfunc::dateTimeAge	(	$	tstamp,
		$	prefix = `1`,
		$	date = `''`
	)		`[static]`

Returns a formatted timestamp if $tstamp is set. The date/datetime will be followed by the age in parenthesis. Usage: 3

Parameters:

	integer	Time stamp, seconds
	integer	1/-1 depending on polarity of age.
string	$date,=="date"	will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm"

Returns:: string

Definition at line 1677 of file class.t3lib_befunc.php.

References $GLOBALS, date(), and datetime().

Referenced by tx_sysaction_task\viewEditRecord().

static t3lib_BEfunc::daysUntil ( $ tstamp ) [static]

Returns the difference in days between input $tstamp and $EXEC_TIME Usage: 2 (class t3lib_BEfunc)

Parameters:

integer Time stamp, seconds

Returns:: integer

Definition at line 1593 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by getRecordIconAltText().

static t3lib_BEfunc::deleteClause	(	$	table,
		$	tableAlias = `''`
	)		`[static]`

Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field is configured in $TCA for the tablename, $table This function should ALWAYS be called in the backend for selection on tables which are configured in TCA since it will ensure consistent selection of records, even if they are marked deleted (in which case the system must always treat them as non-existent!) In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering on those fields as well in the backend you can use ->BEenableFields() though. Usage: 71

Parameters:

string	Table name present in $TCA
string	Table alias if any

Returns:: string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0"

Definition at line 203 of file class.t3lib_befunc.php.

References $TCA.

Referenced by t3lib_TCEmain\addDefaultPermittedLanguageIfNotSet(), Tx_Extbase_Persistence_Storage_Typo3DbBackend\addEnableFieldsStatement(), tx_Workspaces_Service_AutoPublish\autoPublishWorkspaces(), wslib\autoPublishWorkspaces(), tx_rtehtmlarea_acronym\buildJSAcronymArray(), tx_scheduler_Module\checkSchedulerUser(), t3lib_userAuthGroup\checkWorkspace(), SC_mod_user_ws_workspaceForms\checkWorkspaceAccess(), tx_indexedsearch_crawler\cleanUpOldRunningConfigurations(), t3lib_admin\countRecords(), tx_indexedsearch_crawler\crawler_execute_type1(), tx_indexedsearch_crawler\crawler_execute_type4(), tx_indexedsearch_crawler\crawler_init(), displayWarningMessages(), tx_rtehtmlarea_pi2\drawRTE(), tx_rtehtmlarea_base\drawRTE(), SC_alt_doc\editRegularContentFromId(), SC_db_layout\exec_languageQuery(), SC_mod_tools_log_index\exec_listQueryPid(), browse_links\expandPage(), local_beUserAuth\ext_workspaceMembership(), t3lib_transferData\fetchRecord(), tx_version_tcemain\findPageElementsForVersionStageChange(), tx_version_tcemain\findPageElementsForVersionSwap(), tx_version_tcemain\findPageIdsForVersionStateChange(), tx_Workspaces_Service_Tcemain\flushWorkspaceElements(), tx_lowlevel_cleaner_core\genTree(), t3lib_admin\genTree_records(), tx_lowlevel_cleaner_core\genTree_traverse(), tx_reports_reports_status_SecurityStatus\getAdminAccountStatus(), t3lib_flexformtools\getAvailableLanguages(), t3lib_TCEforms\getAvailableLanguages(), tx_Workspaces_Service_Workspaces\getAvailableWorkspaces(), tx_cms_webinfo_lang\getContentElementCount(), t3lib_treeView\getCount(), tx_sysaction_task\getCreatedUsers(), t3lib_treeView\getDataInit(), t3lib_TCEforms\getDefaultRecord(), t3lib_userAuthGroup\getDefaultWorkspace(), t3lib_tree_pagetree_Commands\getDomainName(), tx_cms_webinfo_lang\getLangStatus(), tx_rtehtmlarea_language\getLanguages(), tx_Workspaces_Service_Workspaces\getMoveToPlaceHolderFromPages(), SC_db_layout\getNumberOfHiddenElements(), tslib_AdminPanel\getPreviewModule(), t3lib_queryGenerator\getSelectQuery(), ShortcutMenu\getShortcutIcon(), tx_cms_webinfo_lang\getSystemLanguages(), SC_index\getSystemNews(), tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_sys_note(), tx_cms_layout\getTable_tt_board(), tx_cms_layout\getTableMenu(), t3lib_queryGenerator\getTreeList(), tx_Workspaces_Service_Workspaces\getTreeUids(), t3lib_tree_pagetree_DataProvider\getWhereClause(), t3lib_recordList\initializeLanguages(), tx_Workspaces_Service_Workspaces\isNewPage(), SC_alt_doc\languageSwitch(), SC_alt_doc\localizationRedirect(), SC_mod_web_ts_index\main(), tx_lowlevel_versions\main(), t3lib_queryGenerator\makeOptionList(), recordList\makeQueryArray(), t3lib_search_livesearch\makeQuerySearchByTable(), SC_mod_user_ws_index\menuConfig(), SC_mod_tools_log_index\menuConfig(), tx_version_cm1\menuConfig(), t3lib_TCEmain\noRecordsFromUnallowedTables(), tx_cms_layout\numberOfRecords(), tx_version_cm1\pageSubContent(), tx_indexedsearch_crawler\processDatamap_afterDatabaseOperations(), t3lib_fullsearch\queryMaker(), t3lib_loadDBGroup\readForeignField(), SC_db_layout\renderQuickEdit(), tx_Workspaces_Service_Tcemain\resetStageOfElements(), t3lib_fullsearch\saveQueryInAction(), tx_Workspaces_Service_Workspaces\selectAllVersionsFromPages(), wslib\selectVersionsInWorkspace(), recordList\showSysNotesForPage(), tx_version_cm1\subElements_getNonPageRecords(), t3lib_admin\testDBRefs(), t3lib_transl8tools\translationInfo(), SC_mod_user_ws_index\workspaceList_getUserWorkspaceList(), and SC_alt_shortcut\workspaceSelector().

static t3lib_BEfunc::displayWarningMessages ( ) [static]

Display some warning messages if this installation is obviously insecure!! These warnings are only displayed to admin users

Returns:: void

Definition at line 4346 of file class.t3lib_befunc.php.

References $content, $enableInstallToolFile, $GLOBALS, $res, $row, $value, t3lib_div\_GET(), t3lib_div\compat_version(), deleteClause(), t3lib_message_AbstractMessage\ERROR, t3lib_div\getIndpEnv(), t3lib_div\getUserObj(), t3lib_div\makeInstance(), and t3lib_div\verifyFilenameAgainstDenyPattern().

static t3lib_BEfunc::editOnClick	(	$	params,
		$	backPath = `''`,
		$	requestUri = `''`
	)		`[static]`

Returns a JavaScript string (for an onClick handler) which will load the alt_doc.php script that shows the form for editing of the record(s) you have send as params. REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution) Usage: 35

Parameters:

string	$params	is parameters sent along to alt_doc.php. This requires a much more details description which you must seek in Inside TYPO3s documentation of the alt_doc.php API. And example could be '&edit[pages][123] = edit' which will show edit form for page record 123.
string	$backPath	must point back to the TYPO3_mainDir directory (where alt_doc.php is)
string	$requestUri	is an optional returnUrl you can set - automatically set to REQUEST_URI.

Returns:: string

See also:: template::issueCommand()

Definition at line 2708 of file class.t3lib_befunc.php.

References t3lib_div\getIndpEnv().

Referenced by tx_version_cm1\adminLinks(), SC_mod_tools_be_user_index\compareUsers(), tx_cms_layout\getPageInfoBox(), tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_tt_content(), tx_cms_layout\linkEditContent(), SC_db_new\linkWrap(), recordList\linkWrapItems(), SC_logomenu\main(), tx_infopagetsconfig_webinfo\main(), tx_tstemplateinfo\main(), localRecordList\makeControl(), tx_cms_layout\makeOrdinaryList(), tx_cms_layout\newContentElementOnClick(), tx_cms_layout\pages_drawItem(), tx_cms_webinfo_lang\renderL10nTable(), tx_cms_layout\tt_content_drawColHeader(), tx_cms_layout\tt_content_drawHeader(), and tx_version_cm1\versioningMgm().

static t3lib_BEfunc::exec_foreign_table_where_query	(	$	fieldValue,
		$	field = `''`,
		$	TSconfig = `array()`,
		$	prefix = `''`
	)		`[static]`

Returns select statement for MM relations (as used by TCEFORMs etc) Usage: 3

Parameters:

array	Configuration array for the field, taken from $TCA
string	Field name
array	TSconfig array from which to get further configuration settings for the field name
string	Prefix string for the key "*foreign_table_where" from $fieldValue array

Returns:: string Part of query

Definition at line 3327 of file class.t3lib_befunc.php.

References $GLOBALS, $TCA, and t3lib_div\loadTCA().

Referenced by t3lib_transferData\selectAddForeign().

static t3lib_BEfunc::explodeSoftRefParserList ( $ parserList ) [static]

Returns array of soft parser references

Parameters:

string	softRef parser list
string	Table name
string	Field name

Returns:: array Array where the parser key is the key and the value is the parameter string

Definition at line 3686 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\trimExplode().

Referenced by tx_linkvalidator_Processor\analyzeRecord().

static t3lib_BEfunc::firstDomainRecord ( $ rootLine ) [static]

Returns first found domain record "domainName" (without trailing slash) if found in the input $rootLine Usage: 2

Parameters:

array Root line array

Returns:: string Domain name, if found.

Definition at line 3543 of file class.t3lib_befunc.php.

References $row, getRecordsByField(), and t3lib_extMgm\isLoaded().

Referenced by tx_linkvalidator_linktype_Internal\getBrokenUrl(), getViewDomain(), and SC_mod_web_view_index\main().

static t3lib_BEfunc::fixVersioningPid	(	$	table,
		&$	rr,
		$	ignoreWorkspaceMatch = `FALSE`
	)		`[static]`

Find page-tree PID for versionized record Will look if the "pid" value of the input record is -1 and if the table supports versioning - if so, it will translate the -1 PID into the PID of the original record Used whenever you are tracking something back, like making the root line. Will only translate if the workspace of the input record matches that of the current user (unless flag set) Principle; Record offline! => Find online?

Parameters:

string	Table name
array	Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
boolean	Ignore workspace match

Returns:: void (Passed by ref). If the record had its pid corrected to the online versions pid, then "_ORIG_pid" is set to the original pid value (-1 of course). The field "_ORIG_pid" is used by various other functions to detect if a record was in fact in a versionized branch.

See also:: t3lib_page::fixVersioningPid()

Definition at line 3893 of file class.t3lib_befunc.php.

References $GLOBALS, $TCA, getRecord(), and t3lib_extMgm\isLoaded().

Referenced by tx_recycler_helper\checkAccess(), t3lib_TCEforms_inline\checkAccess(), t3lib_TCEmain\destNotInsideSelf(), t3lib_TCEmain\doesRecordExist(), t3lib_transferData\fetchRecord(), t3lib_TCEmain\fillInFieldArray(), getFlexFormDS(), t3lib_TCEforms\getLanguageIcon(), getPageForRootline(), tx_recycler_helper\getRecordPath(), t3lib_TCEforms\getRecordPath(), t3lib_TCEmain\getRecordPropertiesFromRow(), getTCEFORM_TSconfig(), tx_cms_layout\isRTEforField(), SC_wizard_rte\main(), SC_alt_doc\makeEditForm(), and readPageAccess().

static t3lib_BEfunc::getBackendScript ( $ interface = '' ) [static]

Returns the name of the backend script relative to the TYPO3 main directory.

Parameters:

string Name of the backend interface (backend, frontend) to look up the script name for. If no interface is given, the interface for the current backend user is used.

Returns:: string The name of the backend script relative to the TYPO3 main directory.

Definition at line 4579 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_userAuth\checkAuthentication(), SC_mod_user_ws_index\main(), and SC_alt_shortcut\workspaceSelector().

static t3lib_BEfunc::getCommonSelectFields	(	$	table,
		$	prefix = `''`,
		$	fields = `array()`
	)		`[static]`

Returns fields for a table, $table, which would typically be interesting to select This includes uid, the fields defined for title, icon-field. Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed) Usage: 3

Parameters:

string	Table name, present in TCA
string	Table prefix
array	Preset fields (must include prefix if that is used)

Returns:: string List of fields.

Definition at line 2383 of file class.t3lib_befunc.php.

References $TCA, and t3lib_div\trimExplode().

Referenced by t3lib_admin\genTree_records().

static t3lib_BEfunc::getDomainStartPage	(	$	domain,
		$	path = `''`
	)		`[static]`

Returns the sys_domain record for $domain, optionally with $path appended. Usage: 2

Parameters:

string	Domain name
string	Appended path

Returns:: array Domain record, if found

Definition at line 3564 of file class.t3lib_befunc.php.

References $GLOBALS, $res, and t3lib_extMgm\isLoaded().

Referenced by SC_mod_web_view_index\main().

static t3lib_BEfunc::getExcludeFields ( ) [static]

Returns an array with the exclude-fields as defined in TCA and FlexForms Used for listing the exclude-fields in be_groups forms Usage: 2 (t3lib_tceforms + t3lib_transferdata)

Returns:: array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)

Definition at line 645 of file class.t3lib_befunc.php.

References $extConf, $GLOBALS, $TCA, getRegisteredFlexForms(), and t3lib_div\loadTCA().

Referenced by t3lib_transferData\selectAddSpecial().

static t3lib_BEfunc::getExplicitAuthFieldValues ( ) [static]

Returns an array with explicit Allow/Deny fields. Used for listing these field/value pairs in be_groups forms

Returns:: array Array with information from all of $TCA

Definition at line 708 of file class.t3lib_befunc.php.

References $GLOBALS, $TCA, and t3lib_div\loadTCA().

Referenced by local_beUserAuth\ext_printOverview(), and t3lib_transferData\selectAddSpecial().

static t3lib_BEfunc::getFileIcon ( $ ext ) [static]

Returns file icon name (from $FILEICONS) for the fileextension $ext Usage: 10

Parameters:

string File extension, lowercase

Returns:: string File icon filename

Definition at line 2368 of file class.t3lib_befunc.php.

References $GLOBALS.

static t3lib_BEfunc::getFlexFormDS	(	$	conf,
		$	row,
		$	table,
		$	fieldName = `''`,
		$	WSOL = `TRUE`,
		$	newRecordPidValue = `0`
	)		`[static]`

Finds the Data Structure for a FlexForm field NOTE ON data structures for deleted records: This function may fail to deliver the data structure for a record for a few reasons: a) The data structure could be deleted (either with deleted-flagged or hard-deleted), b) the data structure is fetched using the ds_pointerField_searchParent in which case any deleted record on the route to the final location of the DS will make it fail. In theory, we can solve the problem in the case where records that are deleted-flagged keeps us from finding the DS - this is done at the markers ###NOTE_A### where we make sure to also select deleted records. However, we generally want the DS lookup to fail for deleted records since for the working website we expect a deleted-flagged record to be as inaccessible as one that is completely deleted from the DB. Any way we look at it, this may lead to integrity problems of the reference index and even lost files if attached. However, that is not really important considering that a single change to a data structure can instantly invalidate large amounts of the reference index which we do accept as a cost for the flexform features. Other than requiring a reference index update, deletion of/changes in data structure or the failure to look them up when completely deleting records may lead to lost files in the uploads/ folders since those are now without a proper reference. Usage: 5

Parameters:

array	Field config array
array	Record data
string	The table name
string	Optional fieldname passed to hook object
boolean	Boolean; If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a true reflection of how things are in the live workspace.
integer	SPECIAL CASES: Use this, if the DataStructure may come from a parent record and the INPUT row doesn't have a uid yet (hence, the pid cannot be looked up). Then it is necessary to supply a PID value to search recursively in for the DS (used from TCEmain)

Returns:: mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.

See also:: t3lib_TCEforms::getSingleField_typeFlex()

Definition at line 1022 of file class.t3lib_befunc.php.

References $GLOBALS, $res, $row, $TYPO3_CONF_VARS, fixVersioningPid(), t3lib_div\getFileAbsFileName(), getRecord(), t3lib_div\getUserObj(), t3lib_div\testInt(), t3lib_div\trimExplode(), workspaceOL(), and t3lib_div\xml2array().

Referenced by t3lib_TCEmain\checkValue_flex(), t3lib_TCEmain\copyRecord_procBasedOnFieldType(), tx_impexp\processSoftReferences(), t3lib_TCEmain\remapListedDBRecords(), t3lib_transferData\renderRecord_flexProc(), tx_impexp\setFlexFormRelations(), t3lib_flexformtools\traverseFlexFormXMLData(), and t3lib_TCEmain\version_remapMMForVersionSwap().

static t3lib_BEfunc::getFuncCheck	(	$	mainParams,
		$	elementName,
		$	currentValue,
		$	script = `''`,
		$	addparams = `''`,
		$	tagParams = `''`
	)		`[static]`

Checkbox function menu. Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox. Usage: 34

Parameters:

mixed	$mainParams	$id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	it the form elements name, probably something like "SET[...]"
string	$currentValue	is the value to be selected currently.
string	$script	is the script to send the &id to, if empty it's automatically found
string	$addParams	is additional parameters to pass to the script.
	string	Additional attributes for the checkbox input tag

Returns:: string HTML code for checkbox

See also:: getFuncMenu()

Definition at line 2894 of file class.t3lib_befunc.php.

References t3lib_div\_GET(), and t3lib_div\implodeArrayForUrl().

Referenced by SC_mod_tools_em_index\checkForUpdates(), SC_mod_tools_dbint_index\func_search(), tx_indexedsearch_modfunc2\main(), tx_tstemplateanalyzer\main(), tx_infopagetsconfig_webinfo\main(), SC_mod_tools_config_index\main(), SC_file_list\main(), SC_db_list\main(), tx_tstemplateobjbrowser\main(), tx_tstemplateinfo\main(), SC_mod_tools_log_index\main(), SC_mod_tools_em_index\main(), browse_links\main_file(), t3lib_queryGenerator\makeSelectorTable(), SC_mod_user_ws_index\moduleContent_publish(), SC_db_layout\renderListContent(), and SC_db_layout\renderQuickEdit().

static t3lib_BEfunc::getFuncInput	(	$	mainParams,
		$	elementName,
		$	currentValue,
		$	size = `10`,
		$	script = `""`,
		$	addparams = `""`
	)		`[static]`

Input field function menu Works like ->getFuncMenu() / ->getFuncCheck() but displays a input field instead which updates the script "onchange" Usage: 1

Parameters:

mixed	$id	is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	it the form elements name, probably something like "SET[...]"
string	$currentValue	is the value to be selected currently.
	integer	Relative size of input field, max is 48
string	$script	is the script to send the &id to, if empty it's automatically found
string	$addParams	is additional parameters to pass to the script.

Returns:: string HTML code for input text field.

See also:: getFuncMenu()

Definition at line 2923 of file class.t3lib_befunc.php.

References $GLOBALS, t3lib_div\_GET(), and t3lib_div\implodeArrayForUrl().

static t3lib_BEfunc::getFuncMenu	(	$	mainParams,
		$	elementName,
		$	currentValue,
		$	menuItems,
		$	script = `''`,
		$	addparams = `''`
	)		`[static]`

Returns a selector box "function menu" for a module Requires the JS function jumpToUrl() to be available See Inside TYPO3 for details about how to use / make Function menus Usage: 50

Parameters:

mixed	$id	is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	it the form elements name, probably something like "SET[...]"
string	$currentValue	is the value to be selected currently.
array	$menuItems	is an array with the menu items for the selector box
string	$script	is the script to send the &id to, if empty it's automatically found
string	$addParams	is additional parameters to pass to the script.

Returns:: string HTML code for selector box

Definition at line 2848 of file class.t3lib_befunc.php.

References $value, t3lib_div\_GET(), t3lib_div\deHSCentities(), and t3lib_div\implodeArrayForUrl().

Referenced by tx_recycler_module1\getFunctionMenu(), tx_dbal_module1\main(), tx_tstemplateceditor\main(), tx_tsconfighelp_module1\main(), SC_mod_web_ts_index\main(), SC_mod_web_info_index\main(), SC_mod_web_func_index\main(), SC_mod_user_task_index\main(), tx_cms_webinfo_lang\main(), tx_infopagetsconfig_webinfo\main(), tx_reports_Module\main(), tx_cms_webinfo_page\main(), tx_funcwizards_webfunc\main(), tx_indexedsearch_modfunc1\main(), tx_belog_webinfo\main(), SC_file_edit\main(), SC_mod_tools_isearch_index\main(), SC_file_list\main(), SC_file_rename\main(), SC_file_newfolder\main(), tx_version_cm1\main(), tx_tstemplateobjbrowser\main(), SC_file_upload\main(), SC_mod_tools_log_index\main(), SC_mod_web_perm_index\main(), SC_db_layout\main(), SC_mod_tools_be_user_index\main(), SC_mod_user_ws_index\moduleContent_publish(), SC_db_layout\renderListContent(), SC_mod_web_ts_index\templateMenu(), and tx_em_Install\tsStyleConfigForm().

static t3lib_BEfunc::getGroupNames	(	$	fields = `'title`,
		uid'	,
		$	where = `''`
	)		`[static]`

Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title Usage: 8 (spec. ext. "beuser" and module "web_perm")

Parameters:

string	Field list
string	WHERE clause

Returns:: array

Definition at line 1488 of file class.t3lib_befunc.php.

References $GLOBALS, $res, and $row.

Referenced by SC_mod_web_perm_ajax\__construct(), SC_mod_web_perm_index\doEdit(), local_beUserAuth\ext_getReadableButNonmounted(), getListGroupNames(), SC_mod_tools_log_index\menuConfig(), printAllPageTree_perms\printTree(), user_SC_mod_user_ws_workspaceForms\processUserAndGroups(), and SC_mod_user_ws_index\workspaceList_getUserListWithAccess().

static t3lib_BEfunc::getHash	(	$	hash,
		$	expTime = `0`
	)		`[static]`

Returns string value stored for the hash string in the cache "cache_hash" Can be used to retrieved a cached value

IDENTICAL to the function by same name found in t3lib_page

Parameters:

string The hash-string which was used to store the data value

Returns:: string

Definition at line 1280 of file class.t3lib_befunc.php.

References $GLOBALS, $res, $row, and time().

Referenced by SC_view_help\createGlossaryIndex(), t3lib_userAuthGroup\fetchGroupData(), getPagesTSconfig(), and t3lib_TSparser_TSconfig\parseTSconfig().

static t3lib_BEfunc::getInlineLocalizationMode	(	$	table,
		$	fieldOrConfig
	)		`[static]`

Returns the value of the property localizationMode in the given $config array ($TCA[

['columns'][<field>]['config']). If the table is prepared for localization and no localizationMode is set, 'select' is returned by default. If the table is not prepared for localization or not defined at all in $TCA, false is returned.

Parameters:

string	$table,:	The name of the table to lookup in TCA
mixed	$fieldOrConfig,:	The fieldname (string) or the configuration of the field to check (array)

Returns:: mixed If table is localizable, the set localizationMode is returned (if property is not set, 'select' is returned by default); if table is not localizable, false is returned

Definition at line 824 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_TCEmain\checkValue_inline_processDBdata(), t3lib_TCEmain\copyRecord_procBasedOnFieldType(), t3lib_TCEforms_inline\getRelatedRecords(), t3lib_TCEforms_inline\parseStructureString(), and t3lib_TCEforms_inline\pushStructure().

static t3lib_BEfunc::getItemLabel	(	$	table,
		$	col,
		$	printAllWrap = `''`
	)		`[static]`

Returns the label-value for fieldname $col in table, $table If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap = '|' and the fieldname was 'not_found_field' then the return value would be 'not_found_field' Usage: 17

Parameters:

string	Table name, present in $TCA
string	Field name
string	Wrap value - set function description

Returns:: string

Definition at line 2019 of file class.t3lib_befunc.php.

References $TCA, and t3lib_div\loadTCA().

Referenced by recordHistory\displayHistory(), tx_cms_layout\getPageInfoBox(), tx_Workspaces_ExtDirect_Server\getRowDetails(), tx_cms_layout\getTable_pages(), SC_show_item\renderDBInfo(), recordHistory\renderDiff(), and tx_cms_layout\tt_content_drawItem().

static t3lib_BEfunc::getLabelFromItemlist	(	$	table,
		$	col,
		$	key
	)		`[static]`

Returns the label of the first found entry in an "items" array from $TCA (tablename = $table/fieldname = $col) where the value is $key Usage: 9

Parameters:

string	Table name, present in $TCA
string	Field name, present in $TCA
string	items-array value to match

Returns:: string Label for item entry

Definition at line 1992 of file class.t3lib_befunc.php.

References $TCA, and t3lib_div\loadTCA().

Referenced by local_beUserAuth\ext_printOverview(), getProcessedValue(), SC_db_layout\renderQuickEdit(), and tx_cms_layout\tt_content_drawItem().

static t3lib_BEfunc::getListGroupNames	(	$	fields = `'title`,
		uid'
	)		`[static]`

Returns an array with be_groups records (like ->getGroupNames) but:

if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned. Usage: 2 (module "web_perm" and ext. taskcenter)

Parameters:

string Field list; $fields specify the fields selected (default: title,uid)

Returns:: array

Definition at line 1508 of file class.t3lib_befunc.php.

References $GLOBALS, and getGroupNames().

Referenced by SC_mod_web_perm_index\doEdit(), SC_mod_user_ws_index\main(), and user_SC_mod_user_ws_workspaceForms\processUserAndGroups().

static t3lib_BEfunc::getListViewLink	(	$	urlParameters = `array()`,
		$	linkTitle = `''`,
		$	linkText = `''`
	)		`[static]`

Return a link to the list view

Parameters:

array	$urlParameters	URL parameters that should be added as key value pairs
string	$linkTitle	title for the link tag
string	$linkText	optional link text after the icon

Returns:: string a complete link tag or empty string

Definition at line 3163 of file class.t3lib_befunc.php.

References getModuleUrl(), t3lib_iconWorks\getSpriteIcon(), and t3lib_extMgm\isLoaded().

Referenced by SC_mod_web_info_index\getButtons(), SC_mod_web_func_index\getButtons(), SC_mod_web_ts_index\getButtons(), SC_db_new\getButtons(), tx_version_cm1\getButtons(), SC_mod_web_perm_index\getButtons(), SC_mod_tools_log_index\getButtons(), SC_db_layout\getButtons(), and template\viewPageIcon().

static t3lib_BEfunc::getLiveVersionIdOfRecord	(	$	table,
		$	uid
	)		`[static]`

Gets the id of the live version of a record.

Parameters:

string	$table	Name of the table
integer	$uid	Uid of the offline/draft record

Returns:: integer The id of the live version of the record (or NULL if nothing was found)

Definition at line 4107 of file class.t3lib_befunc.php.

References getRecord().

Referenced by tx_version_tcemain_CommandMap\createNewDependentElementCallback(), getLiveVersionOfRecord(), t3lib_TCEforms_inline\getSingleField_typeInline(), and tx_Workspaces_Service_Workspaces\viewSingleRecord().

static t3lib_BEfunc::getLiveVersionOfRecord	(	$	table,
		$	uid,
		$	fields = `'*'`
	)		`[static]`

Returns live version of record

Parameters:

string	Table name
integer	Record UID of draft, offline version
string	Field list, default is *

Returns:: array If found, the record, otherwise nothing.

Definition at line 4092 of file class.t3lib_befunc.php.

References getLiveVersionIdOfRecord(), and getRecord().

Referenced by t3lib_TCEmain\getSortNumber(), SC_wizard_add\init(), t3lib_TCEmain\moveRecord(), t3lib_TCEmain\placeholderShadowing(), tx_version_tcemain\processCmdmap_deleteAction(), t3lib_TCEmain\resolvePid(), tx_version_tcemain\version_clearWSID(), and tx_Workspaces_Service_Workspaces\viewSingleRecord().

static t3lib_BEfunc::getModTSconfig	(	$	id,
		$	TSref
	)		`[static]`

Returns the merged User/Page TSconfig for page id, $id. Please read details about module programming elsewhere! Usage: 15

Parameters:

	integer	Page uid
string	$TSref	is an object string which determines the path of the TSconfig to return.

Returns:: array

Definition at line 2827 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\array_merge_recursive_overrule().

Referenced by tx_linkvalidator_linktype_LinkHandler\__construct(), clickMenu\DB_newWizard(), tx_linkvalidator_tasks_Validator\execute(), tslib_AdminPanel\ext_makeToolBar(), tx_cms_BackendLayout\getColPosListItemsParsed(), SC_alt_doc\getLanguages(), t3lib_transl8tools\getSystemLanguages(), SC_mod_web_view_index\init(), tx_cms_layout\languageSelector(), tx_infopagetsconfig_webinfo\main(), SC_db_new\main(), SC_db_layout\main(), SC_alt_doc\main(), SC_db_list\menuConfig(), t3lib_SCbase\menuConfig(), and tx_cms_webinfo_lang\renderL10nTable().

static t3lib_BEfunc::getModuleData	(	$	MOD_MENU,
		$	CHANGED_SETTINGS,
		$	modName,
		$	type = `''`,
		$	dontValidateList = `''`,
		$	setDefaultList = `''`
	)		`[static]`

Returns an array which is most backend modules becomes MOD_SETTINGS containing values from function menus etc. determining the function of the module. This is kind of session variable management framework for the backend users. If a key from MOD_MENU is set in the CHANGED_SETTINGS array (eg. a value is passed to the script from the outside), this value is put into the settings-array Ultimately, see Inside TYPO3 for how to use this function in relation to your modules. Usage: 23

Parameters:

array	MOD_MENU is an array that defines the options in menus.
array	CHANGED_SETTINGS represents the array used when passing values to the script from the menus.
string	modName is the name of this module. Used to get the correct module data.
string	If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
string	dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
string	List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)

Returns:: array The array $settings, which holds a key for each MOD_MENU key and the values of each key will be within the range of values for each menuitem

Definition at line 3062 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\inList().

Referenced by t3lib_extobjbase\checkExtObj(), t3lib_SCbase\checkExtObj(), SC_mod_tools_em_index\fetchMetaData(), t3lib_extobjbase\handleExternalFunctionValue(), SC_alt_doc\init(), tx_dbal_module1\main(), tx_tstemplateceditor\main(), browse_links\main_file(), SC_mod_tools_config_index\menuConfig(), SC_mod_user_ws_index\menuConfig(), SC_mod_tools_log_index\menuConfig(), SC_file_list\menuConfig(), SC_mod_tools_isearch_index\menuConfig(), tx_version_cm1\menuConfig(), SC_mod_tools_dbint_index\menuConfig(), SC_db_list\menuConfig(), SC_mod_web_perm_index\menuConfig(), t3lib_SCbase\menuConfig(), SC_mod_tools_em_index\menuConfig(), SC_mod_tools_be_user_index\menuConfig(), t3lib_fullsearch\procesStoreControl(), tx_em_Settings\readSettings(), tx_t3editor_hooks_tstemplateinfo\save(), tx_em_Settings\saveSetting(), tx_em_Settings\saveSettings(), SC_mod_web_ts_index\templateMenu(), tx_em_Translations\translationHandling(), tx_em_Install\tsStyleConfigForm(), and t3lib_modSettings\writeStoredSetting().

static t3lib_BEfunc::getModuleUrl	(	$	moduleName,
		$	urlParameters = `array()`,
		$	backPathOverride = `FALSE`,
		$	returnAbsoluteUrl = `FALSE`
	)		`[static]`

Returns the URL to a given module

Parameters:

string	$moduleName	Name of the module
array	$urlParameters	URL parameters that should be added as key value pairs
	bool/string	$backPathOverride backpath that should be used instead of the global $BACK_PATH
bool	$returnAbsoluteUrl	If set to true, the URL returned will be absolute, $backPathOverride will be ignored in this case

Returns:: bool/string calculated URL or FALSE

Definition at line 3131 of file class.t3lib_befunc.php.

References $GLOBALS, t3lib_div\getIndpEnv(), and t3lib_div\implodeArrayForUrl().

Referenced by clickMenu\DB_db_list(), tslib_AdminPanel\ext_makeToolBar(), getListViewLink(), SC_wizard_list\main(), and SC_db_list\main().

static t3lib_BEfunc::getMovePlaceholder	(	$	table,
		$	uid,
		$	fields = `'*'`
	)		`[static]`

Returns move placeholder of online (live) version

Parameters:

string	Table name
integer	Record UID of online version
string	Field list, default is *

Returns:: array If found, the record, otherwise nothing.

Definition at line 4242 of file class.t3lib_befunc.php.

References $GLOBALS, $row, and $TCA.

Referenced by tx_version_tcemain\moveRecord_wsPlaceholders(), tx_version_tcemain\version_clearWSID(), and tx_version_tcemain\version_swap().

static t3lib_BEfunc::getNoRecordTitle ( $ prep = FALSE ) [static]

Get a localized [No title] string, wrapped in | if $prep is true.

Parameters:

boolean $prep,: Wrap result in |

Returns:: string Localized [No title] string

Definition at line 2126 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by getRecordTitle(), and t3lib_TCEforms_inline\renderForeignRecordHeader().

static t3lib_BEfunc::getPageForRootline	(	$	uid,
		$	clause,
		$	workspaceOL
	)		`[static, protected]`

Gets the cached page record for the rootline

Parameters:

integer	$uid,:	Page id for which to create the root line.
string	$clause,:	can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
boolean	$workspaceOL,:	If true, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!

Returns:: array Cached page record for the rootline

See also:: BEgetRootLine

Definition at line 522 of file class.t3lib_befunc.php.

References $GLOBALS, $res, $row, fixVersioningPid(), and workspaceOL().

Referenced by BEgetRootLine().

static t3lib_BEfunc::getPagesTSconfig	(	$	id,
		$	rootLine = `''`,
		$	returnPartArray = `0`
	)		`[static]`

Returns the Page TSconfig for page with id, $id Requires class "t3lib_TSparser" Usage: 26 (spec. in ext info_pagetsconfig)

Parameters:

integer	Page uid for which to create Page TSconfig
array	If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
boolean	If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser.

Returns:: array Page TSconfig

See also:: t3lib_TSparser

Definition at line 1321 of file class.t3lib_befunc.php.

References $GLOBALS, $res, t3lib_div\array_merge_recursive_overrule(), BEgetRootLine(), t3lib_TSparser\checkIncludeLines_array(), getHash(), t3lib_div\makeInstance(), and storeHash().

Referenced by t3lib_TCEmain\checkValue_flex_procInData_travDS(), Tx_Extbase_Persistence_Storage_Typo3DbBackend\clearPageCache(), recordHistory\displayHistory(), tx_rtehtmlarea_base\drawRTE(), t3lib_TCEmain\fillInFieldArray(), t3lib_TCEmain\getTCEMAIN_TSconfig(), tx_cms_layout\isRTEforField(), tx_infopagetsconfig_webinfo\main(), tx_rtehtmlarea_parse_html\main_parse_html(), tx_rtehtmlarea_user\main_user(), t3lib_TCEforms_Suggest\processAjaxRequest(), and SC_db_new\regularNew().

static t3lib_BEfunc::getPathType_web_nonweb ( $ path ) [static]

Returns "web" if the $path (absolute) is within the DOCUMENT ROOT - and thereby qualifies as a "web" folder. Usage: 4

Parameters:

string Path to evaluate

Returns:: boolean

Definition at line 4526 of file class.t3lib_befunc.php.

References t3lib_div\getIndpEnv(), and t3lib_div\isFirstPartOfStr().

Referenced by filelistFolderTree\getFolderTree().

static t3lib_BEfunc::getPidForModTSconfig	(	$	table,
		$	uid,
		$	pid
	)		`[static]`

Return $uid if $table is pages and $uid is integer - otherwise the $pid Usage: 1

Parameters:

string	Table name
integer	Record uid
integer	Record pid

Returns:: integer

Definition at line 3511 of file class.t3lib_befunc.php.

References $pid, and t3lib_div\testInt().

Referenced by getTSCpid().

static t3lib_BEfunc::getProcessedValue	(	$	table,
		$	col,
		$	value,
		$	fixed_lgd_chars = `0`,
		$	defaultPassthrough = `0`,
		$	noRecordLookup = `FALSE`,
		$	uid = `0`,
		$	forceResult = `TRUE`
	)		`[static]`

Returns a human readable output of a value from a record For instance a database record relation would be looked up to display the title-value of that record. A checkbox with a "1" value would be "Yes", etc. $table/$col is tablename and fieldname REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant) Usage: 24

Parameters:

	string	Table name, present in TCA
	string	Field name, present in TCA
string	$value	is the value of that field from a selected record
integer	$fixed_lgd_chars	is the max amount of characters the value may occupy
boolean	$defaultPassthrough	flag means that values for columns that has no conversion will just be pass through directly (otherwise cropped to 200 chars or returned as "N/A")
	boolean	If set, no records will be looked up, UIDs are just shown.
	integer	uid of the current record
	boolean	If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.

Returns:: string

Definition at line 2151 of file class.t3lib_befunc.php.

References $GLOBALS, $TCA, $TYPO3_CONF_VARS, $value, t3lib_div\callUserFunction(), date(), datetime(), t3lib_div\fixed_lgd_cs(), getLabelFromItemlist(), getRecordTitle(), getRecordWSOL(), t3lib_div\inList(), t3lib_div\loadTCA(), t3lib_div\makeInstance(), time(), and t3lib_div\trimExplode().

Referenced by tx_Workspaces_Service_GridData\calculateChangePercentage(), tx_impexp\compareRecords(), tx_cms_layout\dataFields(), local_beUserAuth\ext_printOverview(), tx_cms_layout\getPageInfoBox(), tx_cms_layout\getProcessedValue(), getProcessedValueExtra(), getRecordTitle(), tx_Workspaces_ExtDirect_Server\getRowDetails(), tx_cms_layout\getTable_tt_content(), tx_cms_layout\pages_drawItem(), SC_show_item\renderDBInfo(), recordHistory\renderDiff(), and tx_version_cm1\versioningMgm().

static t3lib_BEfunc::getProcessedValueExtra	(	$	table,
		$	fN,
		$	fV,
		$	fixed_lgd_chars = `0`,
		$	uid = `0`,
		$	forceResult = `TRUE`
	)		`[static]`

Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead. Usage: 2

Parameters:

	string	Table name, present in TCA
	string	Field name
	string	Field value
integer	$fixed_lgd_chars	is the max amount of characters the value may occupy
	integer	uid of the current record
	boolean	If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.

Returns:: string

See also:: getProcessedValue()

Definition at line 2344 of file class.t3lib_befunc.php.

References $TCA, datetime(), getProcessedValue(), and getRecordPath().

Referenced by t3lib_TCEforms_inline\renderForeignRecordHeader().

static t3lib_BEfunc::getRecord	(	$	table,
		$	uid,
		$	fields = `'*'`,
		$	where = `''`,
		$	useDeleteClause = `TRUE`
	)		`[static]`

Gets record with uid = $uid from $table You can set $field to a list of fields (default is '*') Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1') Will automatically check if records has been deleted and if so, not return anything. $table must be found in $TCA Usage: 99

Parameters:

string	Table name present in $TCA
integer	UID of record
string	List of fields to select
string	Additional WHERE clause, eg. " AND blablabla = 0"
boolean	Use the deleteClause to check if a record is deleted (default true)

Returns:: array Returns the row if found, otherwise nothing

Definition at line 227 of file class.t3lib_befunc.php.

References $GLOBALS, $res, and $row.

static t3lib_BEfunc::getRecordIconAltText	(	$	row,
		$	table = `'pages'`
	)		`[static]`

Returns title-attribute information for ANY record (from a table defined in TCA of course) The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included. "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page. Usage: 10

Parameters:

array	Table row; $row is a row from the table, $table
string	Table name

Returns:: string

Definition at line 1931 of file class.t3lib_befunc.php.

References $GLOBALS, $row, date(), daysUntil(), and titleAttribForPages().

Referenced by tx_cms_layout\getIcon(), template\getPageInfo(), clickMenu\printDBClickMenu(), clickMenu\printNewDBLevel(), Tx_Fluid_ViewHelpers_Be_PageInfoViewHelper\render(), and t3lib_TCEforms_inline\renderForeignRecordHeader().

static t3lib_BEfunc::getRecordLocalization	(	$	table,
		$	uid,
		$	language,
		$	andWhereClause = `''`
	)		`[static]`

Fetches the localization for a given record.

Parameters:

string	$table,:	Table name present in $TCA
integer	$uid,:	The uid of the record
integer	$language,:	The uid of the language record in sys_language
string	$andWhereClause,:	Optional additional WHERE clause (default: '')

Returns:: mixed Multidimensional array with selected records; if none exist, false is returned

Definition at line 426 of file class.t3lib_befunc.php.

References $GLOBALS, and getRecordsByField().

Referenced by t3lib_TCEmain\copyRecord_procBasedOnFieldType(), and t3lib_TCEmain\localize().

static t3lib_BEfunc::getRecordPath	(	$	uid,
		$	clause,
		$	titleLimit,
		$	fullTitleLimit = `0`
	)		`[static]`

Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage" Each part of the path will be limited to $titleLimit characters Deleted pages are filtered out. Usage: 15

Parameters:

	integer	Page uid for which to create record path
string	$clause	is additional where clauses, eg. "
	integer	Title limit
	integer	Title limit of Full title (typ. set to 1000 or so)

Returns:: mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.

Definition at line 604 of file class.t3lib_befunc.php.

References BEgetRootLine(), and t3lib_div\fixed_lgd_cs().

Referenced by t3lib_tsparser_ext\ext_getTemplateHierarchyArr(), local_beUserAuth\ext_non_readAccessPages(), getProcessedValueExtra(), tx_impexp\getRecordPath(), tx_cms_layout\getTable_sys_note(), tx_impexp_task\main(), tx_impexp_modfunc1\main(), SC_mod_tools_log_index\main(), printAllPageTree_perms\printTree(), readPageAccess(), tx_sysaction_task\viewEditRecord(), and localPageTree\wrapIcon().

static t3lib_BEfunc::getRecordRaw	(	$	table,
		$	where = `''`,
		$	fields = `'*'`
	)		`[static]`

Returns the first record found from $table with $where as WHERE clause This function does NOT check if a record has the deleted flag set. $table does NOT need to be configured in $TCA The query used is simply this: $query = 'SELECT '.$fields.' FROM '.$table.' WHERE '.$where; Usage: 5 (ext: sys_todos)

Parameters:

	string	Table name (not necessarily in TCA)
	string	WHERE clause
string	$fields	is a list of fields to select, default is '*'

Returns:: array First row found, if any, FALSE otherwise

Definition at line 286 of file class.t3lib_befunc.php.

References $GLOBALS, $res, and $row.

Referenced by t3lib_TCEmain\deleteRecord(), recordHistory\displayHistory(), recordHistory\displaySettings(), t3lib_TCEmain\doesRecordExist(), recordHistory\generateTitle(), tx_lowlevel_cleaner_core\genTree_traverse(), tx_lowlevel_missing_relations\main(), tx_lowlevel_cleanflexform\main_autoFix(), tx_lowlevel_cleanflexform\main_parseTreeCallBack(), tx_lowlevel_cleaner\quickDBlookUp(), and t3lib_refindex\updateRefIndexTable().

static t3lib_BEfunc::getRecordsByField	(	$	theTable,
		$	theField,
		$	theValue,
		$	whereClause = `''`,
		$	groupBy = `''`,
		$	orderBy = `''`,
		$	limit = `''`,
		$	useDeleteClause = `TRUE`
	)		`[static]`

Returns records from table, $theTable, where a field ($theField) equals the value, $theValue The records are returned in an array If no records were selected, the function returns nothing Usage: 8

Parameters:

string	Table name present in $TCA
string	Field to select on
string	Value that $theField must match
string	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	Optional GROUP BY field(s), if none, supply blank string.
string	Optional ORDER BY field(s), if none, supply blank string.
string	Optional LIMIT value ([begin,]max), if none, supply blank string.
boolean	Use the deleteClause to check if a record is deleted (default true)

Returns:: mixed Multidimensional array with selected records (if any is selected)

Definition at line 311 of file class.t3lib_befunc.php.

References $GLOBALS, $res, $row, and $TCA.

Referenced by t3lib_userAuthGroup\checkFullLanguagesAccess(), t3lib_TCEmain\copyL10nOverlayRecords(), t3lib_TCEmain\deleteL10nOverlayRecords(), firstDomainRecord(), t3lib_softrefproc\getPageIdFromAlias(), getRecordLocalization(), tx_cms_layout\getTable_tt_content(), TYPO3backend\handlePageEditing(), t3lib_TCEmain\localize(), t3lib_TCEmain\moveL10nOverlayRecords(), SC_db_layout\renderQuickEdit(), tx_recycler_model_deletedRecords\setData(), and t3lib_parsehtml_proc\TS_links_rte().

static t3lib_BEfunc::getRecordTitle	(	$	table,
		$	row,
		$	prep = `FALSE`,
		$	forceResult = `TRUE`
	)		`[static]`

Returns the "title"-value in record, $row, from table, $table The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force' Usage: 26

Parameters:

string	Table name, present in TCA
array	Row from table
boolean	If set, result is prepared for output: The output is cropped to a limited lenght (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '[No title]' is returned (localized). Further, the output is htmlspecialchars()'ed
boolean	If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).

Returns:: string

Definition at line 2045 of file class.t3lib_befunc.php.

References $row, $TCA, t3lib_div\callUserFunction(), getNoRecordTitle(), getProcessedValue(), getRecordTitlePrep(), and t3lib_div\trimExplode().

Referenced by tx_linkvalidator_tasks_Validator\buildMail(), browse_links\expandPage(), tx_impexp\export_addRecord(), t3lib_admin\genTree_records(), t3lib_TCEforms_Suggest_DefaultReceiver\getLabel(), template\getPageInfo(), getProcessedValue(), tx_cms_layout\getTable_tt_content(), TBE_browser_recordList\linkWrapItems(), recordList\linkWrapItems(), SC_logomenu\main(), SC_db_layout\main(), SC_mod_tools_log_index\makeConfigurationForm(), SC_alt_doc\makeEditForm(), SC_mod_user_ws_index\moduleContent_publish(), tx_version_cm1\pageSubContent(), clickMenu\printDBClickMenu(), clickMenu\printDragDropClickMenu(), clickMenu\printNewDBLevel(), t3lib_loadDBGroup\readyForInterface(), t3lib_TCEforms_inline\renderForeignRecordHeader(), t3lib_transferData\selectAddForeign(), tx_recycler_view_deletedRecords\transform(), tx_version_cm1\versioningMgm(), and tx_sysaction_task\viewEditRecord().

static t3lib_BEfunc::getRecordTitlePrep	(	$	title,
		$	titleLength = `0`
	)		`[static]`

Crops a title string to a limited lenght and if it really was cropped, wrap it in a |, which offers a tooltip with the original title when moving mouse over it.

Parameters:

string	$title,:	The title string to be cropped
integer	$titleLength,:	Crop title after this length - if not set, BE_USER->uc['titleLen'] is used

Returns:: string The processed title string, wrapped in | if cropped

Definition at line 2106 of file class.t3lib_befunc.php.

References $GLOBALS, t3lib_div\fixed_lgd_cs(), and t3lib_div\testInt().

Referenced by tx_indexedsearch_modfunc1\drawTableOfIndexedPages(), getRecordTitle(), TBE_browser_recordList\linkWrapItems(), and t3lib_TCEforms_inline\renderForeignRecordHeader().

static t3lib_BEfunc::getRecordWSOL	(	$	table,
		$	uid,
		$	fields = `'*'`,
		$	where = `''`,
		$	useDeleteClause = `TRUE`,
		$	unsetMovePointers = `FALSE`
	)		`[static]`

Like getRecord(), but overlays workspace version if any.

Parameters:

string	Table name present in $TCA
integer	UID of record
string	List of fields to select
string	Additional WHERE clause, eg. " AND blablabla = 0"
boolean	Use the deleteClause to check if a record is deleted (default true)
boolean	If true the function does not return a "pointer" row for moved records in a workspace

Returns:: array Returns the row if found, otherwise nothing

Definition at line 253 of file class.t3lib_befunc.php.

References $row, getRecord(), t3lib_div\inList(), t3lib_div\uniqueList(), and workspaceOL().

Referenced by t3lib_tree_Tca_DatabaseTreeDataProvider\buildRepresentationForNode(), t3lib_TCEmain\checkValue_inline_processDBdata(), t3lib_TCEmain\copyRecord(), SC_alt_shortcut\editPageIdFunc(), browse_links\expandPage(), SC_mod_tools_log_index\exportData(), recordList\generateList(), t3lib_tree_pagetree_Commands\getNodeRecord(), t3lib_matchCondition_backend\getPageIdByRecord(), getProcessedValue(), t3lib_treeView\getRecord(), tx_cms_layout\getTable_tt_content(), TYPO3backend\handlePageEditing(), SC_show_item\init(), t3lib_TCEmain\localize(), tx_cms_webinfo_lang\main(), tx_infopagetsconfig_webinfo\main(), SC_mod_tools_log_index\makeConfigurationForm(), t3lib_TCEmain\moveRecord_procFields(), clickMenu\printDBClickMenu(), clickMenu\printNewDBLevel(), SC_mod_web_ts_index\renderList(), tx_opendocs\renderMenuEntry(), and t3lib_transl8tools\translationInfo().

static t3lib_BEfunc::getRegisteredFlexForms ( $ table = 'tt_content' ) [static]

Returns all registered FlexForm definitions with title and fields Usage: 1

Parameters:

string The content table

Returns:: array The data structures with speaking extension title

See also:: t3lib_BEfunc::getExcludeFields()

Definition at line 1157 of file class.t3lib_befunc.php.

References $GLOBALS, $items, t3lib_div\getFileAbsFileName(), t3lib_div\resolveAllSheetsInDS(), t3lib_div\trimExplode(), and t3lib_div\xml2array().

Referenced by getExcludeFields(), and tx_coreupdates_addflexformstoacl\getGroupAddFields().

static t3lib_BEfunc::getSpecConfParametersFromArray ( $ pArr ) [static]

Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value. Better see it in action! Find example in Inside TYPO3 Usage: 6

Parameters:

array Array of "[key] = [value]" strings to convert.

Returns:: array

Definition at line 993 of file class.t3lib_befunc.php.

Referenced by tx_cms_layout\isRTEforField(), t3lib_parsehtml_proc\RTE_transform(), and t3lib_rteapi\transformContent().

static t3lib_BEfunc::getSpecConfParts	(	$	str,
		$	defaultExtras
	)		`[static]`

Parses a part of the field lists in the "types"-section of $TCA arrays, namely the "special configuration" at index 3 (position 4) Elements are splitted by ":" and within those parts, parameters are splitted by "|". Everything is returned in an array and you should rather see it visually than listen to me anymore now... Check out example in Inside TYPO3 Usage: 5

Parameters:

string	Content from the "types" configuration of TCA (the special configuration) - see description of function
string	The ['defaultExtras'] value from field configuration

Returns:: array

Definition at line 962 of file class.t3lib_befunc.php.

References t3lib_div\trimExplode().

Referenced by t3lib_TCEmain\checkValue_flex_procInData_travDS(), and getTCAtypes().

static t3lib_BEfunc::getSQLselectableList	(	$	in_list,
		$	tablename,
		$	default_tablename
	)		`[static]`

Returns a list of pure integers based on $in_list being a list of records with table-names prepended. Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well. Usage: 1 (t3lib_userauthgroup)

Parameters:

	string	Input list
	string	Table name from which ids is returned
string	$default_tablename	denotes what table the number '45' is from (if nothing is prepended on the value)

Returns:: string List of ids

Definition at line 359 of file class.t3lib_befunc.php.

static t3lib_BEfunc::getSystemLanguages ( ) [static]

Returns an array with system languages:

Since TYPO3 4.5 the flagIcon is not returned as a filename in "gfx/flags/*" anymore, but as a string <flags-xx>. The calling party should call t3lib_iconWorks::getSpriteIcon(<flags-xx>) to get an HTML which will represent the flag of this language.

Returns:: array Array with languages (title, uid, flagIcon)

Definition at line 784 of file class.t3lib_befunc.php.

References t3lib_div\makeInstance().

Referenced by local_beUserAuth\ext_printOverview(), and t3lib_transferData\selectAddSpecial().

static t3lib_BEfunc::getTcaFieldConfiguration	(	$	table,
		$	field
	)		`[static]`

Gets the TCA configuration of a field.

Parameters:

string	$table	Name of the table
string	$field	Name of the field

Returns:: array

Definition at line 4614 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\loadTCA().

static t3lib_BEfunc::getTCAtypes	(	$	table,
		$	rec,
		$	useFieldNameAsKey = `0`
	)		`[static]`

Returns the "types" configuration parsed into an array for the record, $rec, from table, $table Usage: 6

Parameters:

string	Table name (present in TCA)
array	Record from $table
boolean	If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.

Returns:: array

Definition at line 884 of file class.t3lib_befunc.php.

References $TCA, getSpecConfParts(), getTCAtypeValue(), t3lib_div\loadTCA(), and t3lib_div\trimExplode().

Referenced by t3lib_TCEmain\fillInFieldArray(), t3lib_TCEforms\getListedFields(), tx_cms_layout\getSpecConfForField(), and t3lib_transferData\renderRecordRaw().

static t3lib_BEfunc::getTCAtypeValue	(	$	table,
		$	rec
	)		`[static]`

Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $TCA If no "type" field is configured in the "ctrl"-section of the $TCA for the table, zero is used. If zero is not an index in the "types" section of $TCA for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not) Usage: 7

Parameters:

string	Table name present in TCA
array	Record from $table

Returns:: string Field value

See also:: getTCAtypes()

Definition at line 937 of file class.t3lib_befunc.php.

References $TCA, and t3lib_div\loadTCA().

Referenced by t3lib_TCEmain\checkValue_flex_procInData_travDS(), t3lib_TCEmain\fillInFieldArray(), getTCAtypes(), getTCEFORM_TSconfig(), and tx_cms_layout\isRTEforField().

static t3lib_BEfunc::getTCEFORM_TSconfig	(	$	table,
		$	row
	)		`[static]`

Returns TSConfig for the TCEFORM object in Page TSconfig. Used in TCEFORMs Usage: 4

Parameters:

string	Table name present in TCA
array	Row from table

Returns:: array

See also:: t3lib_transferData::renderRecord(), t3lib_TCEforms::setTSconfig(), SC_wizard_list::main(), SC_wizard_add::main()

Definition at line 3414 of file class.t3lib_befunc.php.

References $GLOBALS, $res, $row, t3lib_div\array_merge_recursive_overrule(), BEgetRootLine(), fixVersioningPid(), getTCAtypeValue(), and getTSCpid().

Referenced by SC_wizard_add\init(), SC_wizard_list\main(), SC_db_new_content_el\removeInvalidElements(), and t3lib_transferData\renderRecord().

static t3lib_BEfunc::getThumbNail	(	$	thumbScript,
		$	theFile,
		$	tparams = `''`,
		$	size = `''`
	)		`[static]`

Returns single image tag to thumbnail using a thumbnail script (like thumbs.php) Usage: 3

Parameters:

string	$thumbScript	must point to "thumbs.php" relative to the script position
string	$theFile	must be the proper reference to the file thumbs.php should show
string	$tparams	are additional attributes for the image tag
integer	$size	is the size of the thumbnail send along to "thumbs.php"

Returns:: string Image tag

Definition at line 1817 of file class.t3lib_befunc.php.

static t3lib_BEfunc::getTSconfig_pidValue	(	$	table,
		$	uid,
		$	pid
	)		`[static]`

Find the real PID of the record (with $uid from $table). This MAY be impossible if the pid is set as a reference to the former record or a page (if two records are created at one time). NOTICE: Make sure that the input PID is never negative because the record was an offline version! Therefore, you should always use t3lib_BEfunc::fixVersioningPid($table,$row); on the data you input before calling this function! Usage: 2

Parameters:

string	Table name
integer	Record uid
integer	Record pid, could be negative then pointing to a record from same table whose pid to find and return.

Returns:: integer

Definition at line 3468 of file class.t3lib_befunc.php.

References $pid, getRecord(), and t3lib_div\testInt().

Referenced by t3lib_TCEmain\copyRecord(), and getTSCpid().

static t3lib_BEfunc::getTSCpid	(	$	table,
		$	uid,
		$	pid
	)		`[static]`

Returns the REAL pid of the record, if possible. If both $uid and $pid is strings, then pid=-1 is returned as an error indication. Usage: 8

Parameters:

string	Table name
integer	Record uid
integer	Record pid

Returns:: array Array of two integers; first is the REAL PID of a record and if its a new record negative values are resolved to the true PID, second value is the PID value for TSconfig (uid if table is pages, otherwise the pid)

Definition at line 3527 of file class.t3lib_befunc.php.

References $pid, getPidForModTSconfig(), and getTSconfig_pidValue().

Referenced by t3lib_TCEmain\clear_cache(), tx_rtehtmlarea_base\drawRTE(), getTCEFORM_TSconfig(), tx_cms_layout\isRTEforField(), t3lib_TCEmain\localize(), t3lib_TCEmain\process_datamap(), t3lib_transferData\renderRecord(), and t3lib_TCEmain\setHistory().

static t3lib_BEfunc::getUpdateSignalCode ( ) [static]

Call to update the page tree frame (or something else..?) if this is set by the function setUpdateSignal(). It will return some JavaScript that does the update (called in the typo3/template.php file, end() function) Usage: 1

Returns:: string HTML javascript code

See also:: t3lib_BEfunc::setUpdateSignal()

Definition at line 2994 of file class.t3lib_befunc.php.

References $content, $GLOBALS, t3lib_div\callUserFunction(), and setUpdateSignal().

Referenced by template\endPage().

static t3lib_BEfunc::getUrlToken	(	$	formName = `'securityToken'`,
		$	tokenName = `'formToken'`
	)		`[static]`

Generates a token and returns a parameter for the URL

Parameters:

string	$formName	Context of the token
string	$tokenName	The name of the token GET variable

Returns:: string a URL GET variable including ampersand

Definition at line 3183 of file class.t3lib_befunc.php.

References $formprotection, and t3lib_formprotection_Factory\get().

Referenced by ClearCacheMenu\__construct(), template\clearCacheMenu(), clickMenu\DB_changeFlag(), clickMenu\DB_delete(), clickMenu\dragDrop_copymovepage(), SC_alt_doc\init(), template\issueCommand(), SC_alt_doc\languageSwitch(), SC_alt_doc\localizationRedirect(), SC_db_layout\main(), and ext_posMap_pages\onClickEvent().

static t3lib_BEfunc::getUserNames	(	$	fields = `'username`,
		usergroup	,
		usergroup_cached_list	,
		uid'	,
		$	where = `''`
	)		`[static]`

Returns an array with be_users records of all user NOT DELETED sorted by their username Keys in the array is the be_users uid Usage: 14 (spec. ext. "beuser" and module "web_perm")

Parameters:

string	Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
string	Optional $where clause (fx. "AND username='pete'") can be used to limit query

Returns:: array

Definition at line 1468 of file class.t3lib_befunc.php.

References $GLOBALS, $res, and $row.

Referenced by SC_mod_web_perm_ajax\__construct(), SC_mod_tools_be_user_index\compareUsers(), recordHistory\displayHistory(), SC_mod_web_perm_index\doEdit(), local_beUserAuth\ext_getReadableButNonmounted(), tx_cms_layout\getPageInfoBox(), Tx_Workspaces_Service_Stages\getResponsibleBeUser(), tx_impexp_task\main(), tx_impexp_modfunc1\main(), tx_belog_webinfo\main(), SC_mod_user_ws_index\main(), SC_mod_tools_log_index\menuConfig(), printAllPageTree_perms\printTree(), user_SC_mod_user_ws_workspaceForms\processUserAndGroups(), SC_mod_web_perm_ajax\renderUserSelector(), and SC_mod_user_setup_index\simulateUser().

static t3lib_BEfunc::getViewDomain	(	$	pageId,
		$	rootLine = `NULL`
	)		`[static]`

Builds the frontend view domain for a given page ID with a given root line.

Parameters:

integer	$pageId	the page ID to use, must be > 0
array	$rootLine	the root line structure to use

Returns:: string the full domain including the protocol http:// or https://, but without the trailing '/'

Author:: Michael Klapper <michael.klapper@aoemedia.de>

Definition at line 2799 of file class.t3lib_befunc.php.

References BEgetRootLine(), firstDomainRecord(), and t3lib_div\getIndpEnv().

Referenced by tx_Workspaces_ExtDirect_ActionHandler\generateWorkspacePreviewLink(), SC_mod_user_ws_index\moduleContent_publish(), and viewOnClick().

static t3lib_BEfunc::getWorkspaceVersionOfRecord	(	$	workspace,
		$	table,
		$	uid,
		$	fields = `'*'`
	)		`[static]`

Select the workspace version of a record, if exists

Parameters:

integer	Workspace ID
string	Table name to select from
integer	Record uid for which to find workspace version.
string	Field list to select

Returns:: array If found, return record, otherwise false

Definition at line 4060 of file class.t3lib_befunc.php.

References $GLOBALS, $row, $TCA, and t3lib_extMgm\isLoaded().

Referenced by t3lib_TCEmain\copyRecord_procBasedOnFieldType(), t3lib_TCEforms_inline\getRecord(), SC_alt_doc\getRecordForEdit(), tx_lowlevel_versions\main(), SC_wizard_rte\main(), tx_version_tcemain\moveRecord(), t3lib_TCEmain\process_datamap(), tx_version_tcemain\processCmdmap_deleteAction(), SC_alt_doc\processData(), SC_db_layout\renderQuickEdit(), recordHistory\resolveElement(), t3lib_TCEmain\resolvePid(), t3lib_TCEmain\versionizeRecord(), t3lib_userAuthGroup\workspaceAllowAutoCreation(), and workspaceOL().

static t3lib_BEfunc::getWorkspaceWhereClause	(	$	table,
		$	workspaceId = `NULL`
	)		`[static]`

Get additional where clause to select records of a specific workspace (includes live as well).

Parameters:

$table
$workspaceId

Returns:: string

Definition at line 4167 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by tx_Workspaces_Service_Tcemain\flushWorkspaceElements(), and t3lib_loadDBGroup\readForeignField().

static t3lib_BEfunc::helpText	(	$	table,
		$	field,
		$	BACK_PATH = `''`,
		$	styleAttrib = `''`
	)		`[static]`

Returns CSH help text (description), if configured for. TCA_DESCR must be loaded prior to this function and $BE_USER must have "edit_showFieldHelp" set to "text", otherwise nothing is returned Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text. Usage: 4

Parameters:

string	Table name
string	Field name
string	Back path, deprecated since TYPO3 4.5, will be removed in TYPO3 4.7, because not used at all
string	DEPRECATED: Additional style-attribute content for wrapping table (now: only in function cshItem needed)

Returns:: string HTML content for help text

Definition at line 2568 of file class.t3lib_befunc.php.

References t3lib_iconWorks\getSpriteIcon(), and helpTextArray().

Referenced by cshItem(), and wrapInHelp().

static t3lib_BEfunc::helpTextArray	(	$	table,
		$	field
	)		`[static]`

Returns CSH help text (description), if configured for, as an array (title, description) Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text.

Parameters:

string	Table name
string	Field name

Returns:: array With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'

Definition at line 2525 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by helpText().

static t3lib_BEfunc::helpTextIcon	(	$	table,
		$	field,
		$	BACK_PATH,
		$	force = `0`
	)		`[static]`

Returns help-text icon if configured for. TCA_DESCR must be loaded prior to this function and $BE_USER must have 'edit_showFieldHelp' set to 'icon', otherwise nothing is returned Usage: 6

Please note: since TYPO3 4.5 the UX team decided to not use CSH in its former way, but to wrap the given text (where before the help icon was, and you could hover over it) Please also note that since TYPO3 4.5 the option to enable help (none, icon only, full text) was completely removed.

Parameters:

string	Table name
string	Field name
string	Back path
boolean	Force display of icon nomatter BE_USER setting for help

Returns:: string HTML content for a help icon/text

Definition at line 2509 of file class.t3lib_befunc.php.

References $BE_USER, and wrapInHelp().

Referenced by cshItem().

static t3lib_BEfunc::implodeTSParams	(	$	p,
		$	k = `''`
	)		`[static]`

Implodes a multi dimensional TypoScript array, $p, into a one-dimentional array (return value) Usage: 3

Parameters:

array	TypoScript structure
string	Prefix string

Returns:: array Imploded TypoScript objectstring/values

Definition at line 1438 of file class.t3lib_befunc.php.

Referenced by updatePagesTSconfig().

static t3lib_BEfunc::isModuleSetInTBE_MODULES ( $ modName ) [static]

Returns true if $modName is set and is found as a main- or submodule in $TBE_MODULES array Usage: 1

Parameters:

string Module name

Returns:: boolean

Definition at line 3720 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\trimExplode().

Referenced by tx_version_cm1\adminLinks(), clickMenu\DB_edit(), Tx_Workspaces_Controller_PreviewController\generateJavascript(), TYPO3backend\generateJavascript(), tslib_AdminPanel\getEditModule(), SC_view_help\init(), SC_alt_doc_nodoc\main(), tx_version_cm1\main(), and t3lib_userAuthGroup\modAccess().

static t3lib_BEfunc::isPidInVersionizedBranch	(	$	pid,
		$	table = `''`,
		$	returnStage = `FALSE`
	)		`[static]`

Will fetch the rootline for the pid, then check if anywhere in the rootline there is a branch point and if so everything is allowed of course. Alternatively; if the page of the PID itself is a version and swapmode is zero (page+content) then tables from versioning_followPages are allowed as well.

Parameters:

integer	Page id inside of which you want to edit/create/delete something.
string	Table name you are checking for. If you don't give the table name ONLY "branch" types are found and returned true. Specifying table you might also get a positive response if the pid is a "page" versioning type AND the table has "versioning_followPages" set.
boolean	If set, the keyword "branchpoint" or "first" is not returned by rather the "t3ver_stage" value of the branch-point.

Returns:: mixed Returns either "branchpoint" (if branch) or "first" (if page) or false if nothing. Alternatively, it returns the value of "t3ver_stage" for the branchpoint (if any)

Definition at line 4129 of file class.t3lib_befunc.php.

References $GLOBALS, $pid, and BEgetRootLine().

Referenced by wsol_preview\generateUrls(), t3lib_userAuthGroup\workspaceAllowAutoCreation(), and t3lib_userAuthGroup\workspaceAllowLiveRecordsInPID().

static t3lib_BEfunc::isRecordLocked	(	$	table,
		$	uid
	)		`[static]`

Returns information about whether the record from table, $table, with uid, $uid is currently locked (edited by another user - which should issue a warning). Notice: Locking is not strictly carried out since locking is abandoned when other backend scripts are activated - which means that a user CAN have a record "open" without having it locked. So this just serves as a warning that counts well in 90% of the cases, which should be sufficient. Usage: 5

Parameters:

string	Table name
integer	Record uid

Returns:: array

Definition at line 3267 of file class.t3lib_befunc.php.

References $GLOBALS, $res, and $row.

Referenced by SC_alt_doc\makeEditForm(), SC_db_layout\renderQuickEdit(), tx_cms_layout\tt_content_drawHeader(), and webPageTree\wrapIcon().

static t3lib_BEfunc::isTableLocalizable ( $ table ) [static]

Determines whether a table is localizable and has the languageField and transOrigPointerField set in $TCA.

Parameters:

string $table,: The table to check

Returns:: boolean Whether a table is localizable

Definition at line 806 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_userAuthGroup\checkFullLanguagesAccess(), t3lib_TCEmain\copyL10nOverlayRecords(), t3lib_TCEmain\copyRecord_procBasedOnFieldType(), t3lib_TCEmain\deleteL10nOverlayRecords(), t3lib_TCEforms_inline\getSingleField_typeInline(), t3lib_TCEmain\moveL10nOverlayRecords(), and clickMenu\printDBClickMenu().

static t3lib_BEfunc::isTableWorkspaceEnabled ( $ table ) [static]

Determines whether a table is enabled for workspaces.

Parameters:

$table Name of the table to be checked

Returns:: boolean

Definition at line 4603 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_TCEmain\copyRecord_procBasedOnFieldType(), tx_Workspaces_Service_Tcemain\flushWorkspaceElements(), t3lib_loadDBGroup\readForeignField(), tx_Workspaces_Service_Tcemain\resetStageOfElements(), and t3lib_loadDBGroup\writeForeignField().

static t3lib_BEfunc::lockRecords	(	$	table = `''`,
		$	uid = `0`,
		$	pid = `0`
	)		`[static]`

Unlock or Lock a record from $table with $uid If $table and $uid is not set, then all locking for the current BE_USER is removed! Usage: 5

Parameters:

string	Table name
integer	Record uid
integer	Record pid

Returns:: void

Definition at line 3237 of file class.t3lib_befunc.php.

References $GLOBALS, and $pid.

Referenced by t3lib_transferData\lockRecord().

static t3lib_BEfunc::makeConfigForm	(	$	configArray,
		$	defaults,
		$	dataPrefix
	)		`[static]`

Makes a form for configuration of some values based on configuration found in the array $configArray, with default values from $defaults and a data-prefix $dataPrefix <form>-tags must be supplied separately Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3. That's were you can expect to find example, if anywhere. Usage: 1 (ext. direct_mail)

Parameters:

array	Field configuration code.
array	Defaults
string	Prefix for formfields

Returns:: string HTML for a form.

Definition at line 2437 of file class.t3lib_befunc.php.

References $GLOBALS, and debug().

static t3lib_BEfunc::movePlhOL	(	$	table,
		&$	row
	)		`[static]`

Checks if record is a move-placeholder (t3ver_state==3) and if so it will set $row to be the pointed-to live record (and return TRUE)

Parameters:

string	Table name
array	Row (passed by reference) - must be online record!

Returns:: boolean True if overlay is made.

See also:: t3lib_page::movePlhOl()

Definition at line 4025 of file class.t3lib_befunc.php.

References $row, $TCA, and getRecord().

Referenced by tx_lowlevel_versions\main(), and workspaceOL().

static t3lib_BEfunc::openPageTree	(	$	pid,
		$	clearExpansion
	)		`[static]`

Opens the page tree to the specified page id

Parameters:

integer	Page id.
boolean	If set, then other open branches are closed.

Returns:: void

Definition at line 559 of file class.t3lib_befunc.php.

References $BE_USER, $pid, and BEgetRootLine().

Referenced by TYPO3backend\handlePageEditing().

static t3lib_BEfunc::processParams ( $ params ) [static]

Returns an array with key=>values based on input text $params $params is exploded by line-breaks and each line is supposed to be on the syntax [key] = [some value] These pairs will be parsed into an array an returned. Usage: 1

Parameters:

string String of parameters on multiple lines to parse into key-value pairs (see function description)

Returns:: array

Definition at line 4560 of file class.t3lib_befunc.php.

static t3lib_BEfunc::readPageAccess	(	$	id,
		$	perms_clause
	)		`[static]`

Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not. If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin. In any case ->isInWebMount must return true for the user (regardless of $perms_clause) Usage: 21

Parameters:

	integer	Page uid for which to check read-access
string	$perms_clause	is typically a value generated with $BE_USER->getPagePermsClause(1);

Returns:: array Returns page record if OK, otherwise false.

Definition at line 851 of file class.t3lib_befunc.php.

References $GLOBALS, fixVersioningPid(), getRecord(), getRecordPath(), and workspaceOL().

Referenced by Tx_Extbase_Core_Bootstrap\callModule(), t3lib_TCEforms_Suggest_DefaultReceiver\checkRecordAccess(), t3lib_search_livesearch\getEditLink(), SC_db_new\init(), SC_show_item\init(), tx_recycler_module1\initialize(), tx_linkvalidator_ModFuncReport\initialize(), SC_alt_db_navframe\initializeTemporaryDBmount(), SC_mod_web_info_index\main(), SC_mod_web_ts_index\main(), SC_mod_web_func_index\main(), SC_mod_web_view_index\main(), tx_version_cm1\main(), SC_db_list\main(), SC_mod_web_perm_index\main(), SC_mod_tools_log_index\main(), SC_alt_doc\main(), tx_version_tcemain\moveRecord_wsPlaceholders(), Tx_Fluid_ViewHelpers_Be_PagePathViewHelper\render(), Tx_Fluid_ViewHelpers_Be_PageInfoViewHelper\render(), Tx_Fluid_ViewHelpers_Be_TableListViewHelper\render(), t3lib_TCEforms_inline\renderForeignRecordHeaderControl(), and tx_sysaction_task\viewRecordList().

static t3lib_BEfunc::referenceCount	(	$	table,
		$	ref,
		$	msg = `''`,
		$	count = `NULL`
	)		`[static]`

Counting references to a record/file

Parameters:

string	Table name (or "_FILE" if its a file)
string	Reference: If table, then integer-uid, if _FILE, then file reference (relative to PATH_site)
string	Message with s, eg. "There were %s records pointing to this file!"
string	reference count

Returns:: string Output string (or integer count value if no msg string specified)

Definition at line 3744 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\isFirstPartOfStr().

Referenced by clickMenu\DB_delete(), and clickMenu\FILE_delete().

static& t3lib_BEfunc::RTEgetObj ( ) [static]

Returns first possible RTE object if available. Usage: $RTEobj = &t3lib_BEfunc::RTEgetObj();

Returns:: mixed If available, returns RTE object, otherwise an array of messages from possible RTEs

Definition at line 3615 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\getUserObj().

Referenced by t3lib_TCEmain\checkValue_flex_procInData_travDS(), t3lib_TCEmain\fillInFieldArray(), t3lib_userAuthGroup\isRTE(), and SC_wizard_rte\main().

static t3lib_BEfunc::RTEsetup	(	$	RTEprop,
		$	table,
		$	field,
		$	type = `''`
	)		`[static]`

Returns overlayered RTE setup from an array with TSconfig. Used in TCEforms and TCEmain Usage: 8

Parameters:

array	The properties of Page TSconfig in the key "RTE."
string	Table name
string	Field name
string	Type value of the current record (like from CType of tt_content)

Returns:: array Array with the configuration for the RTE

Definition at line 3596 of file class.t3lib_befunc.php.

References t3lib_div\array_merge_recursive_overrule().

Referenced by t3lib_TCEmain\checkValue_flex_procInData_travDS(), t3lib_TCEmain\fillInFieldArray(), tx_cms_layout\isRTEforField(), tx_rtehtmlarea_parse_html\main_parse_html(), and tx_rtehtmlarea_user\main_user().

static t3lib_BEfunc::selectVersionsOfRecord	(	$	table,
		$	uid,
		$	fields = `'*'`,
		$	workspace = `0`,
		$	includeDeletedRecords = `FALSE`,
		$	row = `NULL`
	)		`[static]`

Select all versions of a record, ordered by version id (DESC)

Parameters:

string	Table name to select from
integer	Record uid for which to find versions.
string	Field list to select
integer	Workspace ID, if zero all versions regardless of workspace is found.
boolean	If set, deleted-flagged versions are included! (Only for clean-up script!)
array	The current record

Returns:: array Array of versions of table/uid

Definition at line 3821 of file class.t3lib_befunc.php.

References $GLOBALS, $res, $row, and $TCA.

Referenced by t3lib_TCEmain\deleteVersionsForRecord(), tx_lowlevel_cleaner_core\genTree_traverse(), tx_version_gui\getVersionSelector(), tx_version_cm1\lookForOwnVersions(), tx_lowlevel_versions\main(), localRecordList\makeControl(), and tx_version_cm1\versioningMgm().

static t3lib_BEfunc::setUpdateSignal	(	$	set = `''`,
		$	params = `''`
	)		`[static]`

Call to update the page tree frame (or something else..?) after use 'updatePageTree' as a first parameter will set the page tree to be updated. Usage: 10

Parameters:

string	Key to set the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. If empty, all update signals will be removed.
mixed	Additional information for the update signal, used to only refresh a branch of the tree

Returns:: void

See also:: t3lib_BEfunc::getUpdateSignalCode()

Definition at line 2971 of file class.t3lib_befunc.php.

References $BE_USER.

Referenced by SC_alt_doc\closeDocument(), TYPO3_tcefile\finish(), getUpdateSignalCode(), Tx_Workspaces_Controller_ReviewController\indexAction(), tx_wizardsortpages_webfunc_2\main(), SC_tce_db\main(), SC_db_list\main(), SC_mod_user_setup_index\main(), SC_alt_doc\main(), and SC_alt_doc\processData().

static& t3lib_BEfunc::softRefParserObj ( $ spKey ) [static]

Returns soft-reference parser for the softRef processing type Usage: $softRefObj = &t3lib_BEfunc::softRefParserObj('[parser key]');

Parameters:

string softRef parser key

Returns:: mixed If available, returns Soft link parser object.

Definition at line 3654 of file class.t3lib_befunc.php.

References $GLOBALS, and t3lib_div\getUserObj().

Referenced by tx_linkvalidator_Processor\analyzeRecord().

static t3lib_BEfunc::splitTable_Uid ( $ str ) [static]

Makes an backwards explode on the $str and returns an array with ($table, $uid). Example: tt_content_45 => array('tt_content', 45) Usage: 1

Parameters:

string [tablename]_[uid] string to explode

Returns:: array

Definition at line 344 of file class.t3lib_befunc.php.

static t3lib_BEfunc::storeHash	(	$	hash,
		$	data,
		$	ident
	)		`[static]`

Stores the string value $data in the 'cache_hash' cache with the hash key, $hash, and visual/symbolic identification, $ident IDENTICAL to the function by same name found in t3lib_page: Usage: 2

Parameters:

	string	32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
	string	The data string. If you want to store an array, then just serialize it first.
string	$ident	is just a textual identification in order to inform about the content!

Returns:: void

Definition at line 1251 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by SC_view_help\createGlossaryIndex(), t3lib_userAuthGroup\fetchGroupData(), getPagesTSconfig(), and t3lib_TSparser_TSconfig\parseTSconfig().

static t3lib_BEfunc::thumbCode	(	$	row,
		$	table,
		$	field,
		$	backPath,
		$	thumbScript = `''`,
		$	uploaddir = `NULL`,
		$	abs = `0`,
		$	tparams = `''`,
		$	size = `''`
	)		`[static]`

Returns a linked image-tag for thumbnail(s)/fileicons/truetype-font-previews from a database row with a list of image files in a field All $TYPO3_CONF_VARS['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example) Thumbsnails are linked to the show_item.php script which will display further details. Usage: 7

Parameters:

array	$row	is the database row from the table, $table.
	string	Table name for $row (present in TCA)
string	$field	is pointing to the field with the list of image files
	string	Back path prefix for image tag src="" field
	string	Optional: $thumbScript os by default 'thumbs.php' if you don't set it otherwise
	string	Optional: $uploaddir is the directory relative to PATH_site where the image files from the $field value is found (Is by default set to the entry in $TCA for that field! so you don't have to!)
	boolean	If set, uploaddir is NOT prepended with "../"
	string	Optional: $tparams is additional attributes for the image tags
	integer	Optional: $size is [w]x[h] of the thumbnail. 56 is default.

Returns:: string Thumbnail image tag.

Definition at line 1715 of file class.t3lib_befunc.php.

References $GLOBALS, $row, $TCA, t3lib_div\inList(), t3lib_div\loadTCA(), and t3lib_div\split_fileref().

Referenced by t3lib_tsparser_ext\ext_printFields(), tx_Workspaces_ExtDirect_Server\getRowDetails(), t3lib_TCEforms\previewFieldValue(), tx_tstemplateinfo\procesResources(), and tx_tstemplateinfo\resourceListForCopy().

static t3lib_BEfunc::time	(	$	value,
		$	withSeconds = `TRUE`
	)		`[static]`

Returns $value (in seconds) formatted as hh:mm:ss For instance $value = 3600 + 60*2 + 3 should return "01:02:03" Usage: 1 (class t3lib_BEfunc)

Parameters:

integer	Time stamp, seconds
boolean	Output hh:mm:ss. If false: hh:mm

Returns:: string Formatted time

Definition at line 1629 of file class.t3lib_befunc.php.

References $value.

Referenced by getHash(), and getProcessedValue().

static t3lib_BEfunc::titleAltAttrib ( $ content ) [static]

Returns alt="" and title="" attributes with the value of $content. Usage: 7

Parameters:

string Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)

Returns:: string

Definition at line 1691 of file class.t3lib_befunc.php.

References $content.

static t3lib_BEfunc::titleAttribForPages	(	$	row,
		$	perms_clause = `''`,
		$	includeAttrib = `1`
	)		`[static]`

Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc. Usage: 8

Parameters:

	array	Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
string	$perms_clause	is used to get the record path of the shortcut page, if any (and doktype==4)
	boolean	If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already

Returns:: string

Definition at line 1837 of file class.t3lib_befunc.php.

Referenced by tx_cms_layout\getPageInfoBox(), getRecordIconAltText(), and t3lib_browseTree\getTitleAttrib().

static t3lib_BEfunc::translationCount	(	$	table,
		$	ref,
		$	msg = `''`
	)		`[static]`

Counting translations of records

Parameters:

string	Table name
string	Reference: the record's uid
string	Message with s, eg. "This record has %s translation(s) which will be deleted, too!"

Returns:: string Output string (or integer count value if no msg string specified)

Definition at line 3780 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by clickMenu\DB_delete(), and tx_cms_layout\tt_content_drawHeader().

static t3lib_BEfunc::TYPO3_copyRightNotice ( ) [static]

Prints TYPO3 Copyright notice for About Modules etc. modules.

Returns:: void

Definition at line 4302 of file class.t3lib_befunc.php.

References $GLOBALS, $TYPO3_CONF_VARS, and t3lib_iconWorks\skinImg().

Referenced by SC_alt_intro\main().

static t3lib_BEfunc::typo3PrintError	(	$	header,
		$	text,
		$	js = `''`,
		$	head = `1`
	)		`[static]`

Print error message with header, text etc. Usage: 19

Parameters:

string	Header string
string	Content string
boolean	Will return an alert() with the content of header and text.
boolean	Print header.

Returns:: void

Deprecated:: since TYPO3 4.5, will be removed in TYPO3 4.7 - use RuntimeException from now on

Definition at line 4285 of file class.t3lib_befunc.php.

References t3lib_div\logDeprecatedFunction(), t3lib_div\makeInstance(), and t3lib_div\slashJS().

static t3lib_BEfunc::unsetMenuItems	(	$	modTSconfig,
		$	itemArray,
		$	TSref
	)		`[static]`

Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig) See Inside TYPO3 about how to program modules and use this API. Usage: 4

Parameters:

	array	Module TS config array
	array	Array of items from which to remove items.
string	$TSref	points to the "object string" in $modTSconfig

Returns:: array The modified $itemArray is returned.

Definition at line 2948 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_SCbase\menuConfig(), and tx_funcwizards_webfunc\modMenu().

static t3lib_BEfunc::updatePagesTSconfig	(	$	id,
		$	pageTS,
		$	TSconfPrefix,
		$	impParams = `''`
	)		`[static]`

Updates Page TSconfig for a page with $id The function seems to take $pageTS as an array with properties and compare the values with those that already exists for the "object string", $TSconfPrefix, for the page, then sets those values which were not present. $impParams can be supplied as already known Page TSconfig, otherwise it's calculated.

THIS DOES NOT CHECK ANY PERMISSIONS. SHOULD IT? More documentation is needed.

Usage: 1 (ext. direct_mail)

Parameters:

integer	Page id
array	Page TS array to write
string	Prefix for object paths
array	[Description needed.]

Returns:: void

Definition at line 1386 of file class.t3lib_befunc.php.

References $GLOBALS, getRecord(), and implodeTSParams().

static t3lib_BEfunc::versioningPlaceholderClause ( $ table ) [static]

Will return where clause de-selecting new(/deleted)-versions from other workspaces. If in live-workspace, don't show "MOVE-TO-PLACEHOLDERS" records if versioningWS is 2 (allows moving)

Parameters:

string Table name

Returns:: string Where clause if applicable.

Definition at line 4153 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by SC_alt_doc\editRegularContentFromId(), SC_mod_tools_log_index\exec_listQueryPid(), browse_links\expandPage(), tx_cms_webinfo_lang\getContentElementCount(), t3lib_treeView\getCount(), t3lib_treeView\getDataInit(), tx_cms_webinfo_lang\getLangStatus(), SC_db_layout\getNumberOfHiddenElements(), ShortcutMenu\getShortcutIcon(), tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_sys_note(), tx_cms_layout\getTable_tt_board(), tx_cms_layout\getTableMenu(), t3lib_tree_pagetree_DataProvider\getWhereClause(), t3lib_recordList\initializeLanguages(), SC_alt_doc\languageSwitch(), SC_alt_doc\localizationRedirect(), SC_mod_web_ts_index\main(), recordList\makeQueryArray(), t3lib_search_livesearch\makeQuerySearchByTable(), tx_cms_layout\numberOfRecords(), SC_db_layout\renderQuickEdit(), recordList\showSysNotesForPage(), and t3lib_transl8tools\translationInfo().

static t3lib_BEfunc::viewOnClick	(	$	pageUid,
		$	backPath = `''`,
		$	rootLine = `''`,
		$	anchorSection = `''`,
		$	alternativeUrl = `''`,
		$	additionalGetVars = `''`,
		$	switchFocus = `TRUE`
	)		`[static]`

Returns a JavaScript string for viewing the page id, $id It will detect the correct domain name if needed and provide the link with the right back path. Also it will re-use any window already open. Usage: 8

Parameters:

integer	$pageUid	is page id
string	$backPath	must point back to TYPO3_mainDir (where the site is assumed to be one level above)
array	$rootLine	If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
string	$anchorSection	is optional anchor to the URL
string	$alternativeUrl	is an alternative URL which - if set - will make all other parameters ignored: The function will just return the window.open command wrapped around this URL!
string	$additionalGetVars	Additional GET variables.
	boolean	If true, then the preview window will gain the focus.

Returns:: string

Definition at line 2727 of file class.t3lib_befunc.php.

References $GLOBALS, t3lib_div\getUserObj(), getViewDomain(), t3lib_div\intExplode(), and t3lib_div\makeInstance().

Referenced by tx_version_cm1\adminLinks(), clickMenu\DB_view(), localRecordList\getButtons(), SC_mod_web_info_index\getButtons(), SC_mod_web_func_index\getButtons(), SC_mod_web_ts_index\getButtons(), SC_db_new\getButtons(), tx_version_cm1\getButtons(), SC_mod_tools_log_index\getButtons(), SC_db_layout\getButtons(), tx_cms_layout\getTable_tt_content(), SC_alt_doc\init(), recordList\linkWrapItems(), SC_wizard_rte\main(), SC_db_layout\main(), localRecordList\makeControl(), tx_cms_webinfo_lang\renderL10nTable(), tx_impexp\singleRecordLines(), template\viewPageIcon(), and tx_Workspaces_Service_Workspaces\viewSingleRecord().

static t3lib_BEfunc::workspaceOL	(	$	table,
		&$	row,
		$	wsid = `-99`,
		$	unsetMovePointers = `FALSE`
	)		`[static]`

Workspace Preview Overlay Generally ALWAYS used when records are selected based on uid or pid. If records are selected on other fields than uid or pid (eg. "email = ....") then usage might produce undesired results and that should be evaluated on individual basis. Principle; Record online! => Find offline? Recently, this function has been modified so it MAY set $row to FALSE. This happens if a version overlay with the move-id pointer is found in which case we would like a backend preview. In other words, you should check if the input record is still an array afterwards when using this function.

Parameters:

string	Table name
array	Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_swapmode" (pages) fields must exist! Fake fields cannot exist since the fields in the array is used as field names in the SQL look up. It would be nice to have fields like "t3ver_state" and "t3ver_mode_id" as well to avoid a new lookup inside movePlhOL().
integer	Workspace ID, if not specified will use $GLOBALS['BE_USER']->workspace
boolean	If true the function does not return a "pointer" row for moved records in a workspace

Returns:: void (Passed by ref).

See also:: fixVersioningPid()

Definition at line 3937 of file class.t3lib_befunc.php.

References $GLOBALS, $row, $TCA, getRecord(), getWorkspaceVersionOfRecord(), t3lib_extMgm\isLoaded(), and movePlhOL().

Referenced by tx_impexp\export_addRecord(), t3lib_tsparser_ext\ext_getAllTemplates(), t3lib_tsparser_ext\ext_getFirstTemplate(), t3lib_TCEmain\fillInFieldArray(), tx_version_tcemain\findPageElementsForVersionSwap(), tx_version_tcemain\findPageIdsForVersionStateChange(), t3lib_treeView\getDataNext(), getFlexFormDS(), tx_cms_webinfo_lang\getLangStatus(), getPageForRootline(), tx_recycler_helper\getRecordPath(), t3lib_TCEmain\getRecordProperties(), getRecordWSOL(), tx_cms_layout\getResult(), tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_sys_note(), tx_cms_layout\getTable_tt_board(), tx_cms_layout\getTable_tt_content(), TYPO3backend\handlePageEditing(), tx_cms_layout\makeOrdinaryList(), t3lib_TCEforms_Suggest_DefaultReceiver\makeWorkspaceOverlay(), tx_cms_layout\pages_getTree(), readPageAccess(), t3lib_TCEmain\remapListedDBRecords(), SC_db_layout\renderQuickEdit(), tx_impexp\singleRecordLines(), and t3lib_TStemplate\versionOL().

static t3lib_BEfunc::wrapInHelp	(	$	table,
		$	field,
		$	text = `''`,
		array $	overloadHelpText = `array()`
	)		`[static]`

API function that wraps the text / html in help text, so if a user hovers over it the help text will show up This is the new help API function since TYPO3 4.5, and uses the new behaviour (hover over text, no icon, no fulltext option, no option to disable the help)

Parameters:

string	$table	The table name for which the help should be shown
string	$field	The field name for which the help should be shown
string	$text	the text which should be wrapped with the help text

Returns:: string the HTML code ready to render public

Definition at line 2605 of file class.t3lib_befunc.php.

References t3lib_iconWorks\getSpriteIcon(), and helpText().

Referenced by SC_mod_tools_em_index\extensionList_import(), tx_em_Extensions_Details\extInformationarray(), tx_linkvalidator_tasks_ValidatorAdditionalFieldProvider\getAdditionalFields(), SC_mod_user_setup_index\getCSH(), t3lib_TCEforms\getSingleField(), t3lib_TCEforms\getSingleField_typeSelect_checkbox(), tx_em_Extensions_Details\headerCol(), helpTextIcon(), SC_db_list\main(), SC_mod_tools_em_index\main(), t3lib_clipboard\printClipboard(), SC_db_new\regularNew(), SC_db_layout\renderListContent(), SC_mod_tools_em_index\showExtDetails(), and tx_em_Translations\translationHandling().

static t3lib_BEfunc::wsMapId	(	$	table,
		$	uid
	)		`[static]`

Performs mapping of new uids to new versions UID in case of import inside a workspace.

Parameters:

string	Table name
integer	Record uid (of live record placeholder)

Returns:: integer Uid of offline version if any, otherwise live uid.

Definition at line 4226 of file class.t3lib_befunc.php.

References $GLOBALS.

Referenced by t3lib_TCEmain\copyRecord(), t3lib_TCEmain\copyRecord_raw(), t3lib_TCEmain\dbAnalysisStoreExec(), tx_impexp\processSoftReferences(), tx_impexp\processSoftReferences_substTokens(), t3lib_TCEmain\remapListedDBRecords(), tx_impexp\setFlexFormRelations(), and tx_impexp\setRelations().

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

t3lib/class.t3lib_befunc.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation