t3lib_BEfunc Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	getRecordLocalization ($table, $uid, $language, $andWhereClause= '')
	isTableLocalizable ($table)
	getInlineLocalizationMode ($table, $fieldOrConfig)
	setUpdateSignal ($set= '', $params= '')
	getUpdateSignalCode ()
Öffentliche, statische Methoden
static	deleteClause ($table, $tableAlias= '')
static	getRecord ($table, $uid, $fields= '*', $where= '', $useDeleteClause=true)
static	getRecordWSOL ($table, $uid, $fields= '*', $where= '', $useDeleteClause=true)
static	getRecordRaw ($table, $where= '', $fields= '*')
static	getRecordsByField ($theTable, $theField, $theValue, $whereClause= '', $groupBy= '', $orderBy= '', $limit= '', $useDeleteClause=true)
static	searchQuery ($searchWords, $fields, $table= '')
static	listQuery ($field, $value)
static	splitTable_Uid ($str)
static	getSQLselectableList ($in_list, $tablename, $default_tablename)
static	BEenableFields ($table, $inv=0)
static	mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause= '', $groupBy= '', $orderBy= '', $limit= '')
static	DBcompileInsert ($table, $fields_values)
static	DBcompileUpdate ($table, $where, $fields_values)
static	BEgetRootLine ($uid, $clause= '', $workspaceOL=FALSE)
static	openPageTree ($pid, $clearExpansion)
static	getRecordPath ($uid, $clause, $titleLimit, $fullTitleLimit=0)
static	getExcludeFields ()
static	getExplicitAuthFieldValues ()
static	getSystemLanguages ()
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	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	titleAttrib ($content= '', $hsc=0)
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	helpText ($table, $field, $BACK_PATH, $styleAttrib= '')
static	cshItem ($table, $field, $BACK_PATH, $wrap= '', $onlyIconMode=FALSE, $styleAttrib= '')
static	editOnClick ($params, $backPath= '', $requestUri= '')
static	viewOnClick ($id, $backPath= '', $rootLine= '', $anchor= '', $altUrl= '', $addGetVars= '', $switchFocus=TRUE)
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	getSetUpdateSignal ($set= '')
static	getModuleData ($MOD_MENU, $CHANGED_SETTINGS, $modName, $type= '', $dontValidateList= '', $setDefaultList= '')
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= '')
static	selectVersionsOfRecord ($table, $uid, $fields= '*', $workspace=0, $includeDeletedRecords=FALSE)
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	isPidInVersionizedBranch ($pid, $table= '', $returnStage=FALSE)
static	versioningPlaceholderClause ($table)
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	getListOfBackendModules ($name, $perms_clause, $backPath= '', $script= 'index.php')
static	getBackendScript ($interface= '')

---

Dokumentation der Elementfunktionen

static t3lib_BEfunc::ADMCMD_previewCmds

(

$

pageinfo

)

[static]

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

Parameter:

array

Page record

Rückgabe:

string Query-parameters

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

Parameter:

	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)

Rückgabe:

string WHERE clause part

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

Parameter:

	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!

Rückgabe:

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

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

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

Parameter:

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

Rückgabe:

array

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

Parameter:

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

Rückgabe:

array User names, blinded

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

Parameter:

	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")

Rückgabe:

string Formatted time

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?

Parameter:

	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

Rückgabe:

string Returns keyword to use in URL for ADMCMD_prev=

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

Count number of versions on a page

Parameter:

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

Rückgabe:

array Overview of records

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: ?

Parameter:

	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)

Rückgabe:

string HTML content for help text

Siehe auch:

helpText(), helpTextIcon()

static t3lib_BEfunc::date

(

$

tstamp

)

[static]

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

Parameter:

integer

Time stamp, seconds

Rückgabe:

string Formatted time

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

Parameter:

integer

Time stamp, seconds

Rückgabe:

string Formatted time

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

Parameter:

	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"

Rückgabe:

string

static t3lib_BEfunc::daysUntil

(

$

tstamp

)

[static]

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

Parameter:

integer

Time stamp, seconds

Rückgabe:

integer

static t3lib_BEfunc::DBcompileInsert	(	$	table,
		$	fields_values
	)			[static]

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()

Parameter:

	string	Table name
	array	Field values as key=>value pairs.

Rückgabe:

string Full SQL query for INSERT

Veraltet:

static t3lib_BEfunc::DBcompileUpdate	(	$	table,
		$	where,
		$	fields_values
	)			[static]

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()

Parameter:

	string	Database tablename
	string	WHERE clause, eg. "uid=1"
	array	Field values as key=>value pairs.

Rückgabe:

string Full SQL query for UPDATE

Veraltet:

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

Parameter:

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

Rückgabe:

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

static t3lib_BEfunc::displayWarningMessages

(

)

[static]

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

Rückgabe:

void

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

Parameter:

	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.

Rückgabe:

string

Siehe auch:

template::issueCommand()

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

Parameter:

	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

Rückgabe:

string Part of query

static t3lib_BEfunc::explodeSoftRefParserList

(

$

parserList

)

[static]

Returns array of soft parser references

Parameter:

	string	softRef parser list
	string	Table name
	string	Field name

Rückgabe:

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

static t3lib_BEfunc::firstDomainRecord

(

$

rootLine

)

[static]

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

Parameter:

array

Root line array

Rückgabe:

string Domain name, if found.

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?

Parameter:

	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

Rückgabe:

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.

Siehe auch:

t3lib_page::fixVersioningPid()

static t3lib_BEfunc::getBackendScript

(

$

interface = ''

)

[static]

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

Parameter:

string

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

Rückgabe:

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

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

Parameter:

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

Rückgabe:

string List of fields.

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

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

Parameter:

	string	Domain name
	string	Appended path

Rückgabe:

array Domain record, if found

static t3lib_BEfunc::getExcludeFields

(

)

[static]

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)

Rückgabe:

array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries

static t3lib_BEfunc::getExplicitAuthFieldValues

(

)

[static]

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

Rückgabe:

array Array with information from all of $TCA

static t3lib_BEfunc::getFileIcon

(

$

ext

)

[static]

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

Parameter:

string

File extension, lowercase

Rückgabe:

string File icon filename

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

Parameter:

	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)

Rückgabe:

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

Siehe auch:

t3lib_TCEforms::getSingleField_typeFlex()

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

Parameter:

	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

Rückgabe:

string HTML code for checkbox

Siehe auch:

getFuncMenu()

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

Parameter:

	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.

Rückgabe:

string HTML code for input text field.

Siehe auch:

getFuncMenu()

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

Parameter:

	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.

Rückgabe:

string HTML code for selector box

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")

Parameter:

	string	Field list
	string	WHERE clause

Rückgabe:

array

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

Returns string value stored for the hash string in the table "cache_hash" Can be used to retrieved a cached value IDENTICAL to the function by same name found in t3lib_page Usage: 2

Parameter:

	string	Hash key, 32 bytes hex
	integer	$expTime represents the expire time in seconds. For instance a value of 3600 would allow cached content within the last hour, otherwise nothing is returned.

Rückgabe:

string

t3lib_BEfunc::getInlineLocalizationMode	(	$	table,
		$	fieldOrConfig
	)

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.

Parameter:

	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)

Rückgabe:

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

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

Parameter:

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

Rückgabe:

string

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

Parameter:

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

Rückgabe:

string Label for item entry

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)

Parameter:

string

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

Rückgabe:

array

static t3lib_BEfunc::getListOfBackendModules	(	$	name,
		$	perms_clause,
		$	backPath = '',
		$	script = 'index.php'
	)			[static]

Returns "list of backend modules". Most likely this will be obsolete soon / removed. Don't use. Usage: 3

Parameter:

	array	Module names in array. Must be "addslashes()"ed
	string	Perms clause for SQL query
	string	Backpath
	string	The URL/script to jump to (used in A tag)

Rückgabe:

array Two keys, rows and list

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

Returns live version of record

Parameter:

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

Rückgabe:

array If found, the record, otherwise nothing.

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

Parameter:

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

Rückgabe:

array

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

Parameter:

	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)

Rückgabe:

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

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

Returns move placeholder of online (live) version

Parameter:

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

Rückgabe:

array If found, the record, otherwise nothing.

static t3lib_BEfunc::getNoRecordTitle

(

$

prep = FALSE

)

[static]

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

Parameter:

boolean

$prep: Wrap result in |

Rückgabe:

string Localized [No title] string

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)

Parameter:

	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.

Rückgabe:

array Page TSconfig

Siehe auch:

t3lib_TSparser

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

Parameter:

string

Path to evaluate

Rückgabe:

boolean

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

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

Parameter:

	string	Table name
	integer	Record uid
	integer	Record pid

Rückgabe:

integer

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

Parameter:

	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.

Rückgabe:

string

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

Parameter:

	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.

Rückgabe:

string

Siehe auch:

getProcessedValue()

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

Parameter:

	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)

Rückgabe:

array Returns the row if found, otherwise nothing

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

Parameter:

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

Rückgabe:

string

t3lib_BEfunc::getRecordLocalization	(	$	table,
		$	uid,
		$	language,
		$	andWhereClause = ''
	)

Fetches the localization for a given record.

Parameter:

string

table

Table name present in

TCA

Parameter:

	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: '')

Rückgabe:

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

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

Parameter:

	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)

Rückgabe:

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

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)

Parameter:

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

Rückgabe:

array First row found, if any, FALSE otherwise

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

Parameter:

	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)

Rückgabe:

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

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

Parameter:

	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).

Rückgabe:

string

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.

Parameter:

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

Rückgabe:

string The processed title string, wrapped in | if cropped

static t3lib_BEfunc::getRecordWSOL	(	$	table,
		$	uid,
		$	fields = '*',
		$	where = '',
		$	useDeleteClause = true
	)			[static]

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

Parameter:

	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)

Rückgabe:

array Returns the row if found, otherwise nothing

static t3lib_BEfunc::getSetUpdateSignal

(

$

set = ''

)

[static]

Call to update the page tree frame (or something else..?) after t3lib_BEfunc::getSetUpdateSignal('updatePageTree') -> will set the page tree to be updated. t3lib_BEfunc::getSetUpdateSignal() -> will return some JavaScript that does the update (called in the typo3/template.php file, end() function) please use the setUpdateSignal function instead now, as it allows you to add more parameters Usage: 11

Parameter:

string

Whether to set or clear 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.

Rückgabe:

string HTML code (<script> section)

Siehe auch:

t3lib_BEfunc::getUpdateSignalCode()

t3lib_BEfunc::setUpdateSignal()

Veraltet:

since TYPO3 4.2, please use the setUpdateSignal function instead, as it allows you to add more parameters

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

Parameter:

array

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

Rückgabe:

array

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

Parameter:

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

Rückgabe:

array

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)

Parameter:

	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)

Rückgabe:

string List of ids

static t3lib_BEfunc::getSystemLanguages

(

)

[static]

Returns an array with system languages:

Rückgabe:

array Array with languages

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

Parameter:

	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.

Rückgabe:

array

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

Parameter:

	string	Table name present in TCA
	array	Record from $table

Rückgabe:

string Field value

Siehe auch:

getTCAtypes()

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

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

Parameter:

	string	Table name present in TCA
	array	Row from table

Rückgabe:

array

Siehe auch:

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

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

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

Parameter:

	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"

Rückgabe:

string Image tag

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

Parameter:

	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.

Rückgabe:

integer

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

Parameter:

	string	Table name
	integer	Record uid
	integer	Record pid

Rückgabe:

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)

t3lib_BEfunc::getUpdateSignalCode

(

)

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

Rückgabe:

string HTML javascript code

Siehe auch:

t3lib_BEfunc::setUpdateSignal()

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")

Parameter:

	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

Rückgabe:

array

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

Select the workspace version of a record, if exists

Parameter:

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

Rückgabe:

array If found, return record, otherwise false

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

Parameter:

	string	Table name
	string	Field name
	string	Back path
	string	DEPRECATED: Additional style-attribute content for wrapping table (now: only in function cshItem needed)

Rückgabe:

string HTML content for help text

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

Parameter:

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

Rückgabe:

string HTML content for a help icon/text

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

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

Parameter:

	array	TypoScript structure
	string	Prefix string

Rückgabe:

array Imploded TypoScript objectstring/values

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

Parameter:

string

Module name

Rückgabe:

boolean

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.

Parameter:

	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.

Rückgabe:

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)

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

Parameter:

	string	Table name
	integer	Record uid

Rückgabe:

array

t3lib_BEfunc::isTableLocalizable

(

$

table

)

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

Parameter:

string

$table: The table to check

Rückgabe:

boolean Whether a table is localizable

static t3lib_BEfunc::listQuery	(	$	field,
		$	value
	)			[static]

Returns a WHERE clause that can find a value ($value) in a list field ($field) For instance a record in the database might contain a list of numbers, "34,234,5" (with no spaces between). This query would be able to select that record based on the value "34", "234" or "5" regardless of their positioni in the list (left, middle or right). Is nice to look up list-relations to records or files in TYPO3 database tables. Usage: 0

Parameter:

	string	Table field name
	string	Value to find in list

Rückgabe:

string WHERE clause for a query

Veraltet:

Use $GLOBALS['TYPO3_DB']->listQuery() directly!

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

Parameter:

	string	Table name
	integer	Record uid
	integer	Record pid

Rückgabe:

void

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)

Parameter:

	array	Field configuration code.
	array	Defaults
	string	Prefix for formfields

Rückgabe:

string HTML for a form.

static t3lib_BEfunc::mm_query	(	$	select,
		$	local_table,
		$	mm_table,
		$	foreign_table,
		$	whereClause = '',
		$	groupBy = '',
		$	orderBy = '',
		$	limit = ''
	)			[static]

Returns a SELECT query, selecting fields ($select) from two/three tables joined $local_table and $mm_table is mandatory. $foreign_table is optional. The JOIN is done with [$local_table].uid <--> [$mm_table].uid_local / [$mm_table].uid_foreign <--> [$foreign_table].uid The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $TCA in Inside TYPO3 for more details. DEPRECATED - Use $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query() instead since that will return the result pointer while this returns the query. Using this function may make your application less fitted for DBAL later.

Parameter:

	string	Field list for SELECT
	string	Tablename, local table
	string	Tablename, relation table
	string	Tablename, foreign table
	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.

Rückgabe:

string Full SQL query

Veraltet:

Siehe auch:

t3lib_DB::exec_SELECT_mm_query()

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)

Parameter:

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

Rückgabe:

boolean True if overlay is made.

Siehe auch:

t3lib_page::movePlhOl()

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

Opens the page tree to the specified page id

Parameter:

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

Rückgabe:

void

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

Parameter:

string

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

Rückgabe:

array

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

Parameter:

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

Rückgabe:

array Returns page record if OK, otherwise false.

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

Counting references to a record/file

Parameter:

	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!"

Rückgabe:

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

static& t3lib_BEfunc::RTEgetObj

(

)

[static]

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

Rückgabe:

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

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

Parameter:

	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)

Rückgabe:

array Array with the configuration for the RTE

static t3lib_BEfunc::searchQuery	(	$	searchWords,
		$	fields,
		$	table = ''
	)			[static]

Returns a WHERE clause which will make an AND search for the words in the $searchWords array in any of the fields in array $fields. Usage: 0

Parameter:

	array	Array of search words
	array	Array of fields
	string	Table in which we are searching (for DBAL detection of quoteStr() method)

Rückgabe:

string WHERE clause for search

Veraltet:

Use $GLOBALS['TYPO3_DB']->searchQuery() directly!

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

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

Parameter:

	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!)

Rückgabe:

array Array of versions of table/uid

t3lib_BEfunc::setUpdateSignal	(	$	set = '',
		$	params = ''
	)

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

Parameter:

	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

Rückgabe:

void

Siehe auch:

t3lib_BEfunc::getUpdateSignalCode()

static& t3lib_BEfunc::softRefParserObj

(

$

spKey

)

[static]

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

Parameter:

string

softRef parser key

Rückgabe:

mixed If available, returns Soft link parser object.

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

Parameter:

string

[tablename]_[uid] string to explode

Rückgabe:

array

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

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

Parameter:

	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! May be 20 characters long.

Rückgabe:

void

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

Parameter:

	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.

Rückgabe:

string Thumbnail image tag.

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)

Parameter:

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

Rückgabe:

string Formatted time

static t3lib_BEfunc::titleAltAttrib

(

$

content

)

[static]

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

Parameter:

string

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

Rückgabe:

string

static t3lib_BEfunc::titleAttrib	(	$	content = '',
		$	hsc = 0
	)			[static]

Returns either title = '' or alt = '' attribute. This depends on the client browser and whether it supports title = '' or not (which is the default) If no $content is given only the attribute name is returned. The returned attribute with content will have a leading space char. Warning: Be careful to submit empty $content var - that will return just the attribute name! Usage: 0

Parameter:

	string	String to set as title-attribute. If no $content is given only the attribute name is returned.
	boolean	If $hsc is set, then content of the attribute is htmlspecialchar()'ed (which is good for XHTML and other reasons...)

Rückgabe:

string

Veraltet:

The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead!

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

Parameter:

	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

Rückgabe:

string

static t3lib_BEfunc::TYPO3_copyRightNotice

(

)

[static]

Prints TYPO3 Copyright notice for About Modules etc. modules.

Rückgabe:

void

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

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

Parameter:

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

Rückgabe:

void

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

Parameter:

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

Rückgabe:

array The modified $itemArray is returned.

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)

Parameter:

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

Rückgabe:

void

static t3lib_BEfunc::versioningPlaceholderClause

(

$

table

)

[static]

Will return where clause de-selecting new(/deleted)-versions from other workspaces.

Parameter:

string

Table name

Rückgabe:

string Where clause if applicable.

static t3lib_BEfunc::viewOnClick	(	$	id,
		$	backPath = '',
		$	rootLine = '',
		$	anchor = '',
		$	altUrl = '',
		$	addGetVars = '',
		$	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

Parameter:

	integer	$id is page id
	string	$backpath must point back to TYPO3_mainDir (where the site is assumed to be one level above)
	array	If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
	string	$anchor is optional anchor to the URL
	string	$altUrl 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	Additional GET variables.
	boolean	If true, then the preview window will gain the focus.

Rückgabe:

string

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.

Parameter:

	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

Rückgabe:

void (Passed by ref).

Siehe auch:

fixVersioningPid()

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

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

Parameter:

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

Rückgabe:

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

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_befunc.php