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, $tableAlias='')
	getRecord ($table, $uid, $fields='*', $where='')
	getRecordWSOL ($table, $uid, $fields='*', $where='')
	getRecordRaw ($table, $where='', $fields='*')
	getRecordsByField ($theTable, $theField, $theValue, $whereClause='', $groupBy='', $orderBy='', $limit='')
	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='', $workspaceOL=FALSE)
	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, $fieldName='', $WSOL=TRUE)
	storeHash ($hash, $data, $ident)
	getHash ($hash, $expTime=0)
	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, $noRecordLookup=FALSE, $uid=0)
	getProcessedValueExtra ($table, $fN, $fV, $fixed_lgd_chars=0, $uid=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='', $switchFocus=TRUE)
	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='')
	compilePreviewKeyword ($getVarsStr, $beUserUid, $ttl=172800)
	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='')
	RTEsetup ($RTEprop, $table, $field, $type='')
&	RTEgetObj ()
&	softRefParserObj ($spKey)
	explodeSoftRefParserList ($parserList)
	isModuleSetInTBE_MODULES ($modName)
	referenceCount ($table, $ref, $msg='')
	selectVersionsOfRecord ($table, $uid, $fields='*', $workspace=0)
	fixVersioningPid ($table, &$rr, $ignoreWorkspaceMatch=FALSE)
	workspaceOL ($table, &$row, $wsid=-99)
	getWorkspaceVersionOfRecord ($workspace, $table, $uid, $fields='*')
	getLiveVersionOfRecord ($table, $uid, $fields='*')
	isPidInVersionizedBranch ($pid, $table='', $returnStage=FALSE)
	versioningPlaceholderClause ($table)
	countVersionsOfRecordsOnPage ($workspace, $pageId, $allTables=FALSE)
	wsMapId ($table, $uid)
	typo3PrintError ($header, $text, $js='', $head=1)
	TYPO3_copyRightNotice ()
	displayWarningMessages ()
	getPathType_web_nonweb ($path)
	ADMCMD_previewCmds ($pageinfo)
	processParams ($params)
	getListOfBackendModules ($name, $perms_clause, $backPath='', $script='index.php')

Detailed Description

Definition at line 183 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 3538 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 403 of file class.t3lib_befunc.php.
Referenced by tx_rtehtmlarea_base::buildJSAcronymArray(), tx_rtehtmlarea_base::drawRTE(), SC_db_layout::getNumberOfHiddenElements(), tx_cms_layout::getTable_tt_content(), t3lib_positionMap::printContentElementColumns(), and SC_db_layout::renderQuickEdit().

t3lib_BEfunc::BEgetRootLine ( $ uid,

$ clause = '',

$ workspaceOL = FALSE

)

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 533 of file class.t3lib_befunc.php.
References deleteClause(), fixVersioningPid(), and workspaceOL().
Referenced by clickMenu::DB_view(), SC_mod_user_ws_index::displayWorkspaceOverview(), t3lib_tsparser_ext::ext_prevPageWithTemplate(), getPagesTSconfig(), getTCEFORM_TSconfig(), t3lib_userAuthGroup::isInWebMount(), isPidInVersionizedBranch(), SC_db_layout::main(), SC_mod_web_view_index::main(), SC_mod_web_ts_index::main(), and openPageTree().

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 1387 of file class.t3lib_befunc.php.
References t3lib_div::inArray().
Referenced by SC_mod_web_perm_index::doEdit(), SC_mod_web_perm_index::notEdit(), and user_SC_mod_user_ws_workspaceForms::processUserAndGroups().

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 1354 of file class.t3lib_befunc.php.
References t3lib_div::inList().
Referenced by tx_version_cm1::displayWorkspaceOverview(), SC_mod_user_ws_index::displayWorkspaceOverview(), SC_mod_web_perm_index::doEdit(), tx_cms_layout::getPageInfoBox(), mod_user_task::getUserAndGroupArrays(), tx_belog_webinfo::main(), SC_mod_tools_log_index::main(), SC_mod_web_perm_index::notEdit(), and user_SC_mod_user_ws_workspaceForms::processUserAndGroups().

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 1479 of file class.t3lib_befunc.php.
Referenced by dateTimeAge(), recordHistory::displayHistory(), tx_cms_layout::getPageInfoBox(), getProcessedValue(), isRecordLocked(), and tx_cms_layout::tt_board_drawItem().

t3lib_BEfunc::compilePreviewKeyword ( $ getVarsStr,

$ beUserUid,

$ ttl = 172800

)

Set preview keyword, eg: $previewUrl = t3lib_div::getIndpEnv('TYPO3_SITE_URL').'?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

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

Definition at line 2565 of file class.t3lib_befunc.php.
References time().

t3lib_BEfunc::countVersionsOfRecordsOnPage ( $ workspace,

$ pageId,

$ allTables = FALSE

)

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 3336 of file class.t3lib_befunc.php.
References deleteClause().
Referenced by t3lib_treeView::getDataNext(), and template::getVersionSelector().

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 2219 of file class.t3lib_befunc.php.
References helpText(), and helpTextIcon().
Referenced by recordHistory::displayHistory(), 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_shortcut::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_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 1440 of file class.t3lib_befunc.php.
Referenced by datetime(), 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 1451 of file class.t3lib_befunc.php.
References date().
Referenced by dateTimeAge(), recordHistory::displayHistory(), tx_cms_layout::getPageInfoBox(), SC_mod_tools_isearch_index::getPhashExternalDocs(), SC_mod_tools_isearch_index::getPhashT3pages(), getProcessedValue(), getProcessedValueExtra(), SC_mod_user_ws_index::showStageChangeLog(), tx_cms_layout::tt_board_drawItem(), and SC_mod_user_ws_index::workspaceList_formatWorkspaceData().

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 1505 of file class.t3lib_befunc.php.
References calcAge(), date(), datetime(), and time().
Referenced by mod_user_task::dateTimeAge(), and titleAttribForPages().

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 1428 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. DEPRECATED - $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

Deprecated:

Definition at line 489 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. DEPRECATED - $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

Deprecated:

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

t3lib_BEfunc::deleteClause ( $ table,

$ tableAlias = ''

)

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 204 of file class.t3lib_befunc.php.
Referenced by t3lib_TCEmain::addDefaultPermittedLanguageIfNotSet(), wslib::autoPublishWorkspaces(), BEgetRootLine(), tx_rtehtmlarea_base::buildJSAcronymArray(), t3lib_userAuthGroup::checkWorkspace(), SC_mod_user_ws_workspaceForms::checkWorkspaceAccess(), tx_indexedsearch_crawler::cleanUpOldRunningConfigurations(), t3lib_admin::countRecords(), countVersionsOfRecordsOnPage(), tx_indexedsearch_crawler::crawler_execute_type1(), tx_indexedsearch_crawler::crawler_execute_type4(), tx_indexedsearch_crawler::crawler_init(), tx_rtehtmlarea_base::drawRTE(), SC_alt_doc::editRegularContentFromId(), exec_foreign_table_where_query(), SC_mod_tools_log_index::exec_listQueryPid(), browse_links::expandPage(), tx_rtehtmlarea_browse_links::expandPage(), local_beUserAuth::ext_workspaceMembership(), t3lib_transferData::fetchRecord(), tx_version_cm1::formatWorkspace(), SC_mod_user_ws_index::formatWorkspace(), t3lib_admin::genTree_records(), t3lib_TCEforms::getAvailableLanguages(), t3lib_flexformtools::getAvailableLanguages(), tx_cms_webinfo_lang::getContentElementCount(), t3lib_treeView::getCount(), t3lib_treeView::getDataInit(), t3lib_TCEforms::getDefaultRecord(), t3lib_userAuthGroup::getDefaultWorkspace(), getDomainStartPage(), getFlexFormDS(), getGroupNames(), tx_cms_webinfo_lang::getLangStatus(), getListOfBackendModules(), tx_cms_webinfo_lang::getLocalizedElementInfo(), SC_db_layout::getNumberOfHiddenElements(), getProcessedValue(), 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(), t3lib_queryGenerator::getTreeList(), t3lib_fullsearch::getTreeList(), getUserNames(), getWorkspaceVersionOfRecord(), t3lib_recordList::initializeLanguages(), SC_alt_doc::languageSwitch(), recordList::localizationRedirect(), SC_alt_doc::localizationRedirect(), SC_mod_web_ts_index::main(), localRecordList::makeLocalizationPanel(), t3lib_queryGenerator::makeOptionList(), recordList::makeQueryArray(), t3lib_fullsearch::makeValueList(), tx_version_cm1::menuConfig(), SC_mod_user_ws_index::menuConfig(), t3lib_TCEmain::noRecordsFromUnallowedTables(), tx_cms_layout::numberOfRecords(), tx_version_cm1::pageSubContent(), t3lib_positionMap::printContentElementColumns(), tx_indexedsearch_crawler::processDatamap_afterDatabaseOperations(), t3lib_fullsearch::queryMaker(), SC_db_layout::renderQuickEdit(), t3lib_fullsearch::saveQueryInAction(), t3lib_fullsearch::search(), wslib::selectVersionsInWorkspace(), selectVersionsOfRecord(), recordList::showSysNotesForPage(), tx_version_cm1::subElements_getNonPageRecords(), SC_mod_user_ws_index::subElements_getNonPageRecords(), t3lib_admin::testDBRefs(), tx_version_cm1::versionsInOtherWS(), SC_mod_user_ws_index::versionsInOtherWS(), SC_mod_user_ws_index::workspaceList_getUserWorkspaceList(), and SC_alt_shortcut::workspaceSelector().

t3lib_BEfunc::displayWarningMessages ( )

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

Returns:
void

Definition at line 3469 of file class.t3lib_befunc.php.
References t3lib_div::compat_version().

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 2257 of file class.t3lib_befunc.php.
References t3lib_div::getIndpEnv().
Referenced by tx_cms_layout::getTable_tt_content(), tx_cms_layout::linkEditContent(), SC_db_new::linkWrap(), tx_infopagetsconfig_webinfo::main(), SC_alt_shortcut::main(), tx_cms_layout::newContentElementOnClick(), t3lib_positionMap::onClickEvent(), and tx_cms_layout::tt_content_drawHeader().

t3lib_BEfunc::exec_foreign_table_where_query ( $ fieldValue,

$ field = '',

$ TSconfig = array(),

$ prefix = ''

)

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 2662 of file class.t3lib_befunc.php.
References deleteClause(), and getCommonSelectFields().
Referenced by t3lib_TCEforms::foreignTable(), and t3lib_transferData::selectAddForeign().

t3lib_BEfunc::explodeSoftRefParserList ( $ parserList )

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 2998 of file class.t3lib_befunc.php.
References t3lib_div::trimExplode().
Referenced by t3lib_refindex::getRelations(), and t3lib_refindex::getRelations_flexFormCallBack().

t3lib_BEfunc::firstDomainRecord ( $ rootLine )

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 2856 of file class.t3lib_befunc.php.
References getRecordsByField(), and t3lib_extMgm::isLoaded().
Referenced by SC_mod_web_view_index::main(), and viewOnClick().

t3lib_BEfunc::fixVersioningPid ( $ table,

&$ rr,

$ ignoreWorkspaceMatch = FALSE

)

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 3160 of file class.t3lib_befunc.php.
References getRecord().
Referenced by BEgetRootLine(), SC_wizard_rte::checkEditAccess(), t3lib_TCEmain::destNotInsideSelf(), t3lib_TCEmain::doesRecordExist(), t3lib_transferData::fetchRecord(), getFlexFormDS(), t3lib_TCEforms::getRecordPath(), getRecordPath(), t3lib_TCEmain::getRecordProperties(), t3lib_TCEforms::getSingleField_typeText(), getTCEFORM_TSconfig(), tx_cms_layout::isRTEforField(), SC_wizard_rte::main(), SC_alt_doc::makeEditForm(), and readPageAccess().

t3lib_BEfunc::getCommonSelectFields ( $ table,

$ prefix = ''

)

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

Returns:
string List of fields.

Definition at line 2027 of file class.t3lib_befunc.php.
References t3lib_div::trimExplode().
Referenced by exec_foreign_table_where_query(), and t3lib_admin::genTree_records().

t3lib_BEfunc::getDomainStartPage ( $ domain,

$ path = ''

)

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 2878 of file class.t3lib_befunc.php.
References deleteClause(), and t3lib_extMgm::isLoaded().
Referenced by SC_mod_web_view_index::main(), and viewOnClick().

t3lib_BEfunc::getExcludeFields ( )

Returns an array with the exclude-fields as defined in TCA 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

Definition at line 677 of file class.t3lib_befunc.php.
References t3lib_div::loadTCA().
Referenced by t3lib_TCEforms::addSelectOptionsToItemArray(), and t3lib_transferData::selectAddSpecial().

t3lib_BEfunc::getExplicitAuthFieldValues ( )

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 707 of file class.t3lib_befunc.php.
References t3lib_div::loadTCA().
Referenced by t3lib_TCEforms::addSelectOptionsToItemArray(), local_beUserAuth::ext_printOverview(), and t3lib_transferData::selectAddSpecial().

t3lib_BEfunc::getFileIcon ( $ ext )

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 2013 of file class.t3lib_befunc.php.
Referenced by tx_rtehtmlarea_select_image::expandFolder(), browse_links::expandFolder(), tx_rtehtmlarea_browse_links::expandFolder(), browse_links::fileList(), tx_rtehtmlarea_browse_links::fileList(), fileList::formatFileList(), t3lib_TCEforms::getSingleField_typeGroup(), t3lib_clipboard::printContentFromTab(), clickMenu::printFileClickMenu(), SC_show_item::renderFileInfo(), browse_links::TBE_dragNDrop(), tx_rtehtmlarea_browse_links::TBE_dragNDrop(), and thumbCode().

t3lib_BEfunc::getFlexFormDS ( $ conf,

$ row,

$ table,

$ fieldName = '',

$ WSOL = TRUE

)

Finds the Data Structure for a FlexForm field 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.

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 969 of file class.t3lib_befunc.php.
References deleteClause(), fixVersioningPid(), t3lib_div::getFileAbsFileName(), getRecord(), t3lib_div::getUserObj(), t3lib_div::testInt(), workspaceOL(), and t3lib_div::xml2array().
Referenced by t3lib_TCEmain::checkValue_flex(), t3lib_TCEmain::copyRecord_procBasedOnFieldType(), t3lib_refindex::getRelations(), t3lib_TCEforms::getSingleField_typeFlex(), tx_impexp::processSoftReferences(), t3lib_TCEmain::remapListedDBRecords(), t3lib_transferData::renderRecord_flexProc(), tx_impexp::setFlexFormRelations(), and t3lib_flexformtools::traverseFlexFormXMLData().

t3lib_BEfunc::getFuncCheck ( $ mainParams,

$ elementName,

$ currentValue,

$ script = '',

$ addparams = '',

$ tagParams = ''

)

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 2372 of file class.t3lib_befunc.php.
References t3lib_div::implodeArrayForUrl().
Referenced by SC_mod_tools_dbint_index::func_search(), tx_tstemplateanalyzer::main(), tx_rtehtmlarea_select_image::main(), tx_indexedsearch_modfunc2::main(), tx_cms_webinfo_lang::main(), SC_file_list::main(), browse_links::main_file(), tx_rtehtmlarea_browse_links::main_file(), SC_mod_user_ws_index::moduleContent_publish(), SC_db_layout::renderListContent(), and tx_version_cm1::workspaceMgm().

t3lib_BEfunc::getFuncInput ( $ mainParams,

$ elementName,

$ currentValue,

$ size = 10,

$ script = "",

$ addparams = ""

)

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

t3lib_BEfunc::getFuncMenu ( $ mainParams,

$ elementName,

$ currentValue,

$ menuItems,

$ script = '',

$ addparams = ''

)

Returns a selector box "function menu" for a module Requires the JS function jumpToUrl() to be available See Inside

Documentation TYPO3 par Ameos

t3lib_BEfunc Class Reference

Public Member Functions

Detailed Description

Member Function Documentation