Oblady

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

Paramètres:

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

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

t3lib_BEfunc::getRecord	(	$	table,
		$	uid,
		$	fields = `'*'`,
		$	where = `''`,
		$	useDeleteClause = `true`
	)

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

Paramètres:

	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)

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

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

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

Paramètres:

	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)

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

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

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)

Paramètres:

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

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

t3lib_BEfunc::getRecordsByField	(	$	theTable,
		$	theField,
		$	theValue,
		$	whereClause = `''`,
		$	groupBy = `''`,
		$	orderBy = `''`,
		$	limit = `''`,
		$	useDeleteClause = `true`
	)

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

Paramètres:

	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)

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

t3lib_BEfunc::searchQuery	(	$	searchWords,
		$	fields,
		$	table = `''`
	)

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

Paramètres:

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

Renvoie:: string WHERE clause for search

Obsolète:: Use $GLOBALS['TYPO3_DB']->searchQuery() directly!

t3lib_BEfunc::listQuery	(	$	field,
		$	value
	)

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

Paramètres:

	string	Table field name
	string	Value to find in list

Renvoie:: string WHERE clause for a query

Obsolète:: Use $GLOBALS['TYPO3_DB']->listQuery() directly!

t3lib_BEfunc::splitTable_Uid ( $ str )

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

Paramètres:

string

[tablename]_[uid] string to explode

Renvoie:: array

t3lib_BEfunc::getSQLselectableList	(	$	in_list,
		$	tablename,
		$	default_tablename
	)

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)

Paramètres:

	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)

Renvoie:: string List of ids

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

Paramètres:

	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)

Renvoie:: string WHERE clause part

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

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.

Paramètres:

	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.

Renvoie:: string Full SQL query

Obsolète:

Voir également:: t3lib_DB::exec_SELECT_mm_query()

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

Paramètres:

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

Renvoie:: string Full SQL query for INSERT

Obsolète:

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

Paramètres:

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

Renvoie:: string Full SQL query for UPDATE

Obsolète:

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

Paramètres:

	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!

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

t3lib_BEfunc::openPageTree	(	$	pid,
		$	clearExpansion
	)

Opens the page tree to the specified page id

Paramètres:

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

Renvoie:: void

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

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

Paramètres:

	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)

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

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)

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

t3lib_BEfunc::getExplicitAuthFieldValues ( )

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

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

t3lib_BEfunc::getSystemLanguages ( )

Returns an array with system languages:

Renvoie:: array Array with languages

t3lib_BEfunc::readPageAccess	(	$	id,
		$	perms_clause
	)

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

Paramètres:

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

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

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

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

Paramètres:

	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.

Renvoie:: array

t3lib_BEfunc::getTCAtypeValue	(	$	table,
		$	rec
	)

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

Paramètres:

	string	Table name present in TCA
	array	Record from $table

Renvoie:: string Field value

Voir également:: getTCAtypes()

t3lib_BEfunc::getSpecConfParts	(	$	str,
		$	defaultExtras
	)

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

Paramètres:

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

Renvoie:: array

t3lib_BEfunc::getSpecConfParametersFromArray ( $ pArr )

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

Paramètres:

array

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

Renvoie:: array

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

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

Paramètres:

	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)

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

Voir également:: t3lib_TCEforms::getSingleField_typeFlex()

t3lib_BEfunc::storeHash	(	$	hash,
		$	data,
		$	ident
	)

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

Paramètres:

	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.

Renvoie:: void

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

Retrieves the string content stored with hash key, $hash, in cache_hash IDENTICAL to the function by same name found in t3lib_page: Usage: 2

Paramètres:

	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.

Renvoie:: string

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

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

Paramètres:

	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.

Renvoie:: array Page TSconfig

Voir également:: t3lib_TSparser

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

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)

Paramètres:

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

Renvoie:: void

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

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

Paramètres:

	array	TypoScript structure
	string	Prefix string

Renvoie:: array Imploded TypoScript objectstring/values

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

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

Paramètres:

	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

Renvoie:: array

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

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

Paramètres:

	string	Field list
	string	WHERE clause

Renvoie:: array

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

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)

Paramètres:

string

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

Renvoie:: array

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

Paramètres:

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

Renvoie:: array User names, blinded

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

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

Paramètres:

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

Renvoie:: array

t3lib_BEfunc::daysUntil ( $ tstamp )

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

Paramètres:

integer

Time stamp, seconds

Renvoie:: integer

t3lib_BEfunc::date ( $ tstamp )

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

Paramètres:

integer

Time stamp, seconds

Renvoie:: string Formatted time

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

Paramètres:

integer

Time stamp, seconds

Renvoie:: string Formatted time

t3lib_BEfunc::time ( $ value )

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)

Paramètres:

integer

Time stamp, seconds

Renvoie:: string Formatted time

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

Paramètres:

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

Renvoie:: string Formatted time

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

Paramètres:

	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"

Renvoie:: string

t3lib_BEfunc::titleAttrib	(	$	content = `''`,
		$	hsc = `0`
	)

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

Paramètres:

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

Renvoie:: string

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

t3lib_BEfunc::titleAltAttrib ( $ content )

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

Paramètres:

string

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

Renvoie:: string

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

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

Paramètres:

	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.

Renvoie:: string Thumbnail image tag.

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

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

Paramètres:

	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"

Renvoie:: string Image tag

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

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

Paramètres:

	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

Renvoie:: string

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

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

Paramètres:

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

Renvoie:: string

t3lib_BEfunc::getLabelFromItemlist	(	$	table,
		$	col,
		$	key
	)

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

Paramètres:

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

Renvoie:: string Label for item entry

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

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

Paramètres:

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

Renvoie:: string

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

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

Paramètres:

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

Renvoie:: string

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

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.

Paramètres:

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

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

t3lib_BEfunc::getNoRecordTitle ( $ prep = FALSE )

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

Paramètres:


Fonctions membres publiques
	deleteClause ($table, $tableAlias='')
	getRecord ($table, $uid, $fields='*', $where='', $useDeleteClause=true)
	getRecordWSOL ($table, $uid, $fields='*', $where='', $useDeleteClause=true)
	getRecordRaw ($table, $where='', $fields='*')
	getRecordsByField ($theTable, $theField, $theValue, $whereClause='', $groupBy='', $orderBy='', $limit='', $useDeleteClause=true)
	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, $newRecordPidValue=0)
	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=FALSE, $forceResult=TRUE)
	getRecordTitlePrep ($title, $titleLength=0)
	getNoRecordTitle ($prep=FALSE)
	getProcessedValue ($table, $col, $value, $fixed_lgd_chars=0, $defaultPassthrough=0, $noRecordLookup=FALSE, $uid=0, $forceResult=TRUE)
	getProcessedValueExtra ($table, $fN, $fV, $fixed_lgd_chars=0, $uid=0, $forceResult=TRUE)
	getFileIcon ($ext)
	getCommonSelectFields ($table, $prefix='', $fields=array())
	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, $includeDeletedRecords=FALSE)
	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')

Référence de la classe t3lib_BEfunc

Fonctions membres publiques

Documentation des fonctions membres