Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0 3.8.1 4.0.0 4.0.1 4.1.0 <- Available in other TYPO3 versions

t3lib_BEfunc Class Reference


Public Member Functions
	deleteClause ($table)
	getRecord ($table, $uid, $fields='*', $where='')
	getRecordRaw ($table, $where='', $fields='*')
	getRecordsByField ($theTable, $theField, $theValue, $whereClause='', $groupBy='', $orderBy='', $limit='')
	fixVersioningPid ($table, &$rr)
	searchQuery ($searchWords, $fields, $table='')
	listQuery ($field, $value)
	splitTable_Uid ($str)
	getSQLselectableList ($in_list, $tablename, $default_tablename)
	BEenableFields ($table, $inv=0)
	mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause='', $groupBy='', $orderBy='', $limit='')
	DBcompileInsert ($table, $fields_values)
	DBcompileUpdate ($table, $where, $fields_values)
	BEgetRootLine ($uid, $clause='')
	openPageTree ($pid, $clearExpansion)
	getRecordPath ($uid, $clause, $titleLimit, $fullTitleLimit=0)
	getExcludeFields ()
	getExplicitAuthFieldValues ()
	getSystemLanguages ()
	readPageAccess ($id, $perms_clause)
	getTCAtypes ($table, $rec, $useFieldNameAsKey=0)
	getTCAtypeValue ($table, $rec)
	getSpecConfParts ($str, $defaultExtras)
	getSpecConfParametersFromArray ($pArr)
	getFlexFormDS ($conf, $row, $table)
	storeHash ($hash, $data, $ident)
	getHash ($hash, $expTime)
	getPagesTSconfig ($id, $rootLine='', $returnPartArray=0)
	updatePagesTSconfig ($id, $pageTS, $TSconfPrefix, $impParams='')
	implodeTSParams ($p, $k='')
	getUserNames ($fields='username, usergroup, usergroup_cached_list, uid', $where='')
	getGroupNames ($fields='title, uid', $where='')
	getListGroupNames ($fields='title, uid')
	blindUserNames ($usernames, $groupArray, $excludeBlindedFlag=0)
	blindGroupNames ($groups, $groupArray, $excludeBlindedFlag=0)
	daysUntil ($tstamp)
	date ($tstamp)
	datetime ($value)
	time ($value)
	calcAge ($seconds, $labels= 'min\|hrs\|days\|yrs')
	dateTimeAge ($tstamp, $prefix=1, $date='')
	titleAttrib ($content='', $hsc=0)
	titleAltAttrib ($content)
	thumbCode ($row, $table, $field, $backPath, $thumbScript='', $uploaddir=NULL, $abs=0, $tparams='', $size='')
	getThumbNail ($thumbScript, $theFile, $tparams='', $size='')
	titleAttribForPages ($row, $perms_clause='', $includeAttrib=1)
	getRecordIconAltText ($row, $table='pages')
	getLabelFromItemlist ($table, $col, $key)
	getItemLabel ($table, $col, $printAllWrap='')
	getRecordTitle ($table, $row, $prep=0)
	getProcessedValue ($table, $col, $value, $fixed_lgd_chars=0, $defaultPassthrough=0)
	getProcessedValueExtra ($table, $fN, $fV, $fixed_lgd_chars=0)
	getFileIcon ($ext)
	getCommonSelectFields ($table, $prefix)
	makeConfigForm ($configArray, $defaults, $dataPrefix)
	helpTextIcon ($table, $field, $BACK_PATH, $force=0)
	helpText ($table, $field, $BACK_PATH, $styleAttrib='')
	cshItem ($table, $field, $BACK_PATH, $wrap='', $onlyIconMode=FALSE, $styleAttrib='')
	editOnClick ($params, $backPath='', $requestUri='')
	viewOnClick ($id, $backPath='', $rootLine='', $anchor='', $altUrl='', $addGetVars='')
	getModTSconfig ($id, $TSref)
	getFuncMenu ($mainParams, $elementName, $currentValue, $menuItems, $script='', $addparams='')
	getFuncCheck ($mainParams, $elementName, $currentValue, $script='', $addparams='', $tagParams='')
	getFuncInput ($mainParams, $elementName, $currentValue, $size=10, $script="", $addparams="")
	unsetMenuItems ($modTSconfig, $itemArray, $TSref)
	getSetUpdateSignal ($set='')
	getModuleData ($MOD_MENU, $CHANGED_SETTINGS, $modName, $type='', $dontValidateList='', $setDefaultList='')
	lockRecords ($table='', $uid=0, $pid=0)
	isRecordLocked ($table, $uid)
	exec_foreign_table_where_query ($fieldValue, $field='', $TSconfig=array(), $prefix='')
	getTCEFORM_TSconfig ($table, $row)
	getTSconfig_pidValue ($table, $uid, $pid)
	getPidForModTSconfig ($table, $uid, $pid)
	getTSCpid ($table, $uid, $pid)
	firstDomainRecord ($rootLine)
	getDomainStartPage ($domain, $path='')
	selectVersionsOfRecord ($table, $uid, $fields='*')
	RTEsetup ($RTEprop, $table, $field, $type='')
&	RTEgetObj ()
	isModuleSetInTBE_MODULES ($modName)
	typo3PrintError ($header, $text, $js='', $head=1)
	TYPO3_copyRightNotice ()
	getPathType_web_nonweb ($path)
	ADMCMD_previewCmds ($pageinfo)
	processParams ($params)
	getListOfBackendModules ($name, $perms_clause, $backPath='', $script='index.php')
	deleteClause ($table)
	getRecord ($table, $uid, $fields='*', $where='')
	getRecordRaw ($table, $where='', $fields='*')
	getRecordsByField ($theTable, $theField, $theValue, $whereClause='', $groupBy='', $orderBy='', $limit='')
	fixVersioningPid ($table, &$rr)
	searchQuery ($searchWords, $fields, $table='')
	listQuery ($field, $value)
	splitTable_Uid ($str)
	getSQLselectableList ($in_list, $tablename, $default_tablename)
	BEenableFields ($table, $inv=0)
	mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause='', $groupBy='', $orderBy='', $limit='')
	DBcompileInsert ($table, $fields_values)
	DBcompileUpdate ($table, $where, $fields_values)
	BEgetRootLine ($uid, $clause='')
	openPageTree ($pid, $clearExpansion)
	getRecordPath ($uid, $clause, $titleLimit, $fullTitleLimit=0)
	getExcludeFields ()
	getExplicitAuthFieldValues ()
	getSystemLanguages ()
	readPageAccess ($id, $perms_clause)
	getTCAtypes ($table, $rec, $useFieldNameAsKey=0)
	getTCAtypeValue ($table, $rec)
	getSpecConfParts ($str, $defaultExtras)
	getSpecConfParametersFromArray ($pArr)
	getFlexFormDS ($conf, $row, $table)
	storeHash ($hash, $data, $ident)
	getHash ($hash, $expTime)
	getPagesTSconfig ($id, $rootLine='', $returnPartArray=0)
	updatePagesTSconfig ($id, $pageTS, $TSconfPrefix, $impParams='')
	implodeTSParams ($p, $k='')
	getUserNames ($fields='username, usergroup, usergroup_cached_list, uid', $where='')
	getGroupNames ($fields='title, uid', $where='')
	getListGroupNames ($fields='title, uid')
	blindUserNames ($usernames, $groupArray, $excludeBlindedFlag=0)
	blindGroupNames ($groups, $groupArray, $excludeBlindedFlag=0)
	daysUntil ($tstamp)
	date ($tstamp)
	datetime ($value)
	time ($value)
	calcAge ($seconds, $labels= 'min\|hrs\|days\|yrs')
	dateTimeAge ($tstamp, $prefix=1, $date='')
	titleAttrib ($content='', $hsc=0)
	titleAltAttrib ($content)
	thumbCode ($row, $table, $field, $backPath, $thumbScript='', $uploaddir=NULL, $abs=0, $tparams='', $size='')
	getThumbNail ($thumbScript, $theFile, $tparams='', $size='')
	titleAttribForPages ($row, $perms_clause='', $includeAttrib=1)
	getRecordIconAltText ($row, $table='pages')
	getLabelFromItemlist ($table, $col, $key)
	getItemLabel ($table, $col, $printAllWrap='')
	getRecordTitle ($table, $row, $prep=0)
	getProcessedValue ($table, $col, $value, $fixed_lgd_chars=0, $defaultPassthrough=0)
	getProcessedValueExtra ($table, $fN, $fV, $fixed_lgd_chars=0)
	getFileIcon ($ext)
	getCommonSelectFields ($table, $prefix)
	makeConfigForm ($configArray, $defaults, $dataPrefix)
	helpTextIcon ($table, $field, $BACK_PATH, $force=0)
	helpText ($table, $field, $BACK_PATH, $styleAttrib='')
	cshItem ($table, $field, $BACK_PATH, $wrap='', $onlyIconMode=FALSE, $styleAttrib='')
	editOnClick ($params, $backPath='', $requestUri='')
	viewOnClick ($id, $backPath='', $rootLine='', $anchor='', $altUrl='', $addGetVars='')
	getModTSconfig ($id, $TSref)
	getFuncMenu ($mainParams, $elementName, $currentValue, $menuItems, $script='', $addparams='')
	getFuncCheck ($mainParams, $elementName, $currentValue, $script='', $addparams='', $tagParams='')
	getFuncInput ($mainParams, $elementName, $currentValue, $size=10, $script="", $addparams="")
	unsetMenuItems ($modTSconfig, $itemArray, $TSref)
	getSetUpdateSignal ($set='')
	getModuleData ($MOD_MENU, $CHANGED_SETTINGS, $modName, $type='', $dontValidateList='', $setDefaultList='')
	lockRecords ($table='', $uid=0, $pid=0)
	isRecordLocked ($table, $uid)
	exec_foreign_table_where_query ($fieldValue, $field='', $TSconfig=array(), $prefix='')
	getTCEFORM_TSconfig ($table, $row)
	getTSconfig_pidValue ($table, $uid, $pid)
	getPidForModTSconfig ($table, $uid, $pid)
	getTSCpid ($table, $uid, $pid)
	firstDomainRecord ($rootLine)
	getDomainStartPage ($domain, $path='')
	selectVersionsOfRecord ($table, $uid, $fields='*')
	RTEsetup ($RTEprop, $table, $field, $type='')
&	RTEgetObj ()
	isModuleSetInTBE_MODULES ($modName)
	typo3PrintError ($header, $text, $js='', $head=1)
	TYPO3_copyRightNotice ()
	getPathType_web_nonweb ($path)
	ADMCMD_previewCmds ($pageinfo)
	processParams ($params)
	getListOfBackendModules ($name, $perms_clause, $backPath='', $script='index.php')

Detailed Description

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

Member Function Documentation

t3lib_BEfunc::ADMCMD_previewCmds ( $ pageinfo )

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

Parameters:

array Page record

Returns:
string Query-parameters

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

t3lib_BEfunc::BEenableFields ( $ table,

$ inv = 0

)

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_EXEC_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 390 of file class.t3lib_befunc.php.

t3lib_BEfunc::BEgetRootLine ( $ uid,

$ clause = ''

)

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 proces if we meet a page, the user has no reading access to.

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

Definition at line 519 of file class.t3lib_befunc.php.
References deleteClause(), and fixVersioningPid().

t3lib_BEfunc::blindGroupNames ( $ groups,

$ groupArray,

$ excludeBlindedFlag = 0

)

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 1334 of file class.t3lib_befunc.php.
References t3lib_div::inArray().

t3lib_BEfunc::blindUserNames ( $ usernames,

$ groupArray,

$ excludeBlindedFlag = 0

)

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 1301 of file class.t3lib_befunc.php.
References t3lib_div::inList().

t3lib_BEfunc::calcAge ( $ seconds,

$ labels = 'min|hrs|days|yrs'

)

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 1428 of file class.t3lib_befunc.php.

t3lib_BEfunc::cshItem ( $ table,

$ field,

$ BACK_PATH,

$ wrap = '',

$ onlyIconMode = FALSE,

$ styleAttrib = ''

)

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 2099 of file class.t3lib_befunc.php.
References helpText(), and helpTextIcon().
Referenced by SC_mod_tools_em_index::alterSettings(), recordHistory::displayHistory(), recordHistory::displaySysHistoryEntry(), SC_mod_web_perm_index::doEdit(), SC_mod_tools_em_index::extensionList_import(), SC_mod_tools_em_index::extensionList_installed(), SC_mod_tools_em_index::extensionList_loaded(), SC_wizard_forms::getFormHTML(), recordList::getSearchBox(), localRecordList::getTable(), tx_cms_layout::getTable_pages(), tx_cms_layout::getTable_tt_content(), SC_wizard_table::getTableHTML(), tx_wizardsortpages_webfunc_2::main(), tx_infopagetsconfig_webinfo::main(), tx_cms_webinfo_lang::main(), tx_cms_webinfo_page::main(), SC_db_new_content_el::main(), SC_db_layout::main(), SC_move_el::main(), SC_file_rename::main(), SC_file_list::main(), SC_file_edit::main(), SC_alt_menu::main(), SC_alt_file_navframe::main(), SC_alt_doc::main(), SC_alt_db_navframe::main(), SC_mod_user_setup_index::main(), SC_mod_web_info_index::main(), SC_mod_web_func_index::main(), SC_alt_doc::makeCmenu(), SC_alt_doc::makeDocSel(), SC_mod_web_perm_index::notEdit(), SC_db_new::pagesOnly(), SC_db_new::regularNew(), SC_db_layout::renderQuickEdit(), SC_mod_user_setup_index::setLabel(), and SC_mod_tools_em_index::showExtDetails().

t3lib_BEfunc::date ( $ tstamp )

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 1389 of file class.t3lib_befunc.php.
Referenced by mod_web_dmail::cmd_default(), mod_web_dmail::cmd_displayPageInfo(), dateTimeAge(), getProcessedValue(), getRecordIconAltText(), tx_cms_webinfo_page::main(), titleAttribForPages(), and tx_cms_layout::tt_content_drawItem().

t3lib_BEfunc::datetime ( $ value )

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 1400 of file class.t3lib_befunc.php.
Referenced by mod_web_dmail::cmd_default(), mod_web_dmail::cmd_send_mail(), dateTimeAge(), recordHistory::displayHistory(), recordHistory::displaySysHistoryEntry(), tx_cms_layout::getPageInfoBox(), SC_mod_tools_isearch_index::getPhashExternalDocs(), SC_mod_tools_isearch_index::getPhashT3pages(), getProcessedValue(), getProcessedValueExtra(), and tx_cms_layout::tt_board_drawItem().

t3lib_BEfunc::dateTimeAge ( $ tstamp,

$ prefix = 1,

$ date = ''

)

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 1454 of file class.t3lib_befunc.php.
References calcAge(), date(), datetime(), and time().

t3lib_BEfunc::daysUntil ( $ tstamp )

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 1377 of file class.t3lib_befunc.php.

t3lib_BEfunc::DBcompileInsert ( $ table,

$ fields_values

)

Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values. DEPRECIATED - $GLOBALS['TYPO3_DB']->INSERTquery() directly instead! But better yet, use $GLOBALS['TYPO3_DB']->exec_INSERTquery()

Parameters:

string Table name

array Field values as key=>value pairs.

Returns:
string Full SQL query for INSERT

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

t3lib_BEfunc::DBcompileUpdate ( $ table,

$ where,

$ fields_values

)

Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values. DEPRECIATED - $GLOBALS['TYPO3_DB']->UPDATEquery() directly instead! But better yet, use $GLOBALS['TYPO3_DB']->exec_UPDATEquery()

Parameters:

string Database tablename

string WHERE clause, eg. "uid=1"

array Field values as key=>value pairs.

Returns:
string Full SQL query for UPDATE

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

t3lib_BEfunc::deleteClause ( $ table )

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

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

Definition at line 188 of file class.t3lib_befunc.php.
Referenced by BEgetRootLine(), mod_web_dmail::cmd_default(), mod_web_dmail::cmd_displayPageInfo(), mod_web_dmail::cmd_fetch(), mod_web_dmail::cmd_finalmail(), mod_web_dmail::cmd_quickmail(), mod_web_dmail::cmd_send_mail(), t3lib_admin::countRecords(), SC_alt_doc::editRegularContentFromId(), exec_foreign_table_where_query(), SC_mod_tools_log_index::exec_listQueryPid(), SC_browse_links::expandPage(), t3lib_transferData::fetchRecord(), t3lib_TCEforms::getAvailableLanguages(), tx_cms_webinfo_lang::getContentElementCount(), t3lib_treeView::getCount(), t3lib_treeView::getDataInit(), t3lib_TCEforms::getDefaultRecord(), getDomainStartPage(), getFlexFormDS(), getGroupNames(), tx_cms_webinfo_lang::getLangStatus(), getListOfBackendModules(), mod_web_dmail::getMailGroups(), SC_db_layout::getNumberOfHiddenElements(), getRecord(), getRecordPath(), getRecordsByField(), t3lib_queryGenerator::getSelectQuery(), tx_cms_webinfo_lang::getSystemLanguages(), getSystemLanguages(), tx_cms_layout::getTable_pages(), tx_cms_layout::getTable_sys_note(), tx_cms_layout::getTable_tt_board(), tx_cms_layout::getTableMenu(), getUserNames(), mod_web_dmail::importRecords(), t3lib_recordList::initializeLanguages(), mod_web_dmail::mailModule_main(), SC_mod_web_ts_index::main(), localRecordList::makeLocalizationPanel(), mod_web_dmail::makePidListQuery(), tx_cms_layout::numberOfRecords(), tx_version_cm1::pageSubContent(), t3lib_positionMap::printContentElementColumns(), t3lib_fullsearch::queryMaker(), tx_sysmessages::renderMessages(), SC_db_layout::renderQuickEdit(), t3lib_fullsearch::saveQueryInAction(), t3lib_fullsearch::search(), selectVersionsOfRecord(), recordList::showSysNotesForPage(), t3lib_admin::testDBRefs(), tx_systodos::todos_getReviewUsers(), and tx_systodos::todos_processIncoming().

t3lib_BEfunc::editOnClick ( $ params,

$ backPath = '',

$ requestUri = ''

)

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 2137 of file class.t3lib_befunc.php.
References t3lib_div::getIndpEnv().

Documentation TYPO3 par Ameos

t3lib_BEfunc Class Reference

Public Member Functions

Detailed Description

Member Function Documentation