t3lib_BEfunc Class Reference

List of all members.

Public Member Functions

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

Detailed Description

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

Member Function Documentation

t3lib_BEfunc::deleteClause ( $  table,
$  tableAlias = '' 
)

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

Parameters:
string Table name present in $TCA
string Table alias if any
Returns:
string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0"

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

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

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

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

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

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

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

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

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)

Parameters:
string Table name (not necessarily in TCA)
string WHERE clause
string $fields is a list of fields to select, default is '*'
Returns:
array First row found, if any, FALSE otherwise

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

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

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

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

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

Parameters:
array Array of search words
array Array of fields
string Table in which we are searching (for DBAL detection of quoteStr() method)
Returns:
string WHERE clause for search
Deprecated:
Use $GLOBALS['TYPO3_DB']->searchQuery() directly!

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

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

Parameters:
string Table field name
string Value to find in list
Returns:
string WHERE clause for a query
Deprecated:
Use $GLOBALS['TYPO3_DB']->listQuery() directly!

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

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

Parameters:
string [tablename]_[uid] string to explode
Returns:
array

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

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)

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

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

t3lib_BEfunc::BEenableFields ( $  table,
$  inv = 0 
)

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

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

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

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.

Parameters:
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.
Returns:
string Full SQL query
Deprecated:
See also:
t3lib_DB::exec_SELECT_mm_query()

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

t3lib_BEfunc::DBcompileInsert ( $  table,
$  fields_values 
)

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

Parameters:
string Table name
array Field values as key=>value pairs.
Returns:
string Full SQL query for INSERT
Deprecated:

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

t3lib_BEfunc::DBcompileUpdate ( $  table,
$  where,
$  fields_values 
)

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

Parameters:
string Database tablename
string WHERE clause, eg. "uid=1"
array Field values as key=>value pairs.
Returns:
string Full SQL query for UPDATE
Deprecated:

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

t3lib_BEfunc::BEgetRootLine ( $  uid,
$  clause = '',
$  workspaceOL = FALSE 
)

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

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

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

t3lib_BEfunc::openPageTree ( $  pid,
$  clearExpansion 
)

Opens the page tree to the specified page id

Parameters:
integer Page id.
boolean If set, then other open branches are closed.
Returns:
void

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

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

Parameters:
integer Page uid for which to create record path
string $clause is additional where clauses, eg. "
integer Title limit
integer Title limit of Full title (typ. set to 1000 or so)
Returns:
mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.

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

t3lib_BEfunc::getExcludeFields (  ) 

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

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

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

t3lib_BEfunc::getExplicitAuthFieldValues (  ) 

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

Returns:
array Array with information from all of $TCA

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

t3lib_BEfunc::getSystemLanguages (  ) 

Returns an array with system languages:

Returns:
array Array with languages

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

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

Parameters:
integer Page uid for which to check read-access
string $perms_clause is typically a value generated with $BE_USER->getPagePermsClause(1);
Returns:
array Returns page record if OK, otherwise false.

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

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

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

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

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

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

Parameters:
string Table name present in TCA
array Record from $table
Returns:
string Field value
See also:
getTCAtypes()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:
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.
Returns:
string

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

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)

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

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

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)

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

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

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

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

Parameters:
array TypoScript structure
string Prefix string
Returns:
array Imploded TypoScript objectstring/values

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

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

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

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

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

Parameters:
string Field list
string WHERE clause
Returns:
array

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

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

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

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

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

t3lib_BEfunc::blindUserNames ( $  usernames,
$  groupArray,
$  excludeBlindedFlag = 0 
)

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

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

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

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

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

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

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

t3lib_BEfunc::daysUntil ( $  tstamp  ) 

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

Parameters:
integer Time stamp, seconds
Returns:
integer

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

t3lib_BEfunc::date ( $  tstamp  ) 

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

Parameters:
integer Time stamp, seconds
Returns:
string Formatted time

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

t3lib_BEfunc::datetime ( $  value  ) 

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

Parameters:
integer Time stamp, seconds
Returns:
string Formatted time

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

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)

Parameters:
integer Time stamp, seconds
Returns:
string Formatted time

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

t3lib_BEfunc::calcAge ( $  seconds,
$  labels = 'min|hrs|days|yrs' 
)

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

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

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

t3lib_BEfunc::dateTimeAge ( $  tstamp,
$  prefix = 1,
$  date = '' 
)

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

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

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

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

Parameters:
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...)
Returns:
string
Deprecated:
The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead!

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

t3lib_BEfunc::titleAltAttrib ( $  content  ) 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:
string Table name, present in $TCA
string Field name, present in $TCA
string items-array value to match
Returns:
string Label for item entry

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

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

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

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

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

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

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

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.

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

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

t3lib_BEfunc::getNoRecordTitle ( $  prep = FALSE  ) 

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

Parameters:
boolean $prep: Wrap result in |
Returns:
string Localized [No title] string

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

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

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

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

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

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

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

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

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

t3lib_BEfunc::getFileIcon ( $  ext  ) 

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

Parameters:
string File extension, lowercase
Returns:
string File icon filename

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

t3lib_BEfunc::getCommonSelectFields ( $  table,
$  prefix = '',
$  fields = array() 
)

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

Parameters:
string Table name, present in TCA
string Table prefix
array Preset fields (must include prefix if that is used)
Returns:
string List of fields.

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

t3lib_BEfunc::makeConfigForm ( $  configArray,
$  defaults,
$  dataPrefix 
)

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

Parameters:
array Field configuration code.
array Defaults
string Prefix for formfields
Returns:
string HTML for a form.

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

t3lib_BEfunc::helpTextIcon ( $  table,
$  field,
$  BACK_PATH,
$  force = 0 
)

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

Parameters:
string Table name
string Field name
string Back path
boolean Force display of icon nomatter BE_USER setting for help
Returns:
string HTML content for a help icon/text

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

t3lib_BEfunc::helpText ( $  table,
$  field,
$  BACK_PATH,
$  styleAttrib = '' 
)

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

Parameters:
string Table name
string Field name
string Back path
string Additional style-attribute content for wrapping table
Returns:
string HTML content for help text

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

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

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

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

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

t3lib_BEfunc::editOnClick ( $  params,
$  backPath = '',
$  requestUri = '' 
)

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

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

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

t3lib_BEfunc::viewOnClick ( $  id,
$  backPath = '',
$  rootLine = '',
$  anchor = '',
$  altUrl = '',
$  addGetVars = '',
$  switchFocus = TRUE 
)

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

Parameters:
integer $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.
Returns:
string

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

t3lib_BEfunc::getModTSconfig ( $  id,
$  TSref 
)

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

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

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

t3lib_BEfunc::getFuncMenu ( $  mainParams,
$  elementName,
$  currentValue,
$  menuItems,
$  script = '',
$  addparams = '' 
)

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

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

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

t3lib_BEfunc::getFuncCheck ( $  mainParams,
$  elementName,
$  currentValue,
$  script = '',
$  addparams = '',
$  tagParams = '' 
)

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

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

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

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

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

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

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

t3lib_BEfunc::unsetMenuItems ( $  modTSconfig,
$  itemArray,
$  TSref 
)

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

Parameters:
array Module TS config array
array Array of items from which to remove items.
string $TSref points to the "object string" in $modTSconfig
Returns:
array The modified $itemArray is returned.

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

t3lib_BEfunc::getSetUpdateSignal ( $  set = ''  ) 

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) Usage: 11

Parameters:
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.
Returns:
string HTML code (<script> section)

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

t3lib_BEfunc::getModuleData ( $  MOD_MENU,
$  CHANGED_SETTINGS,
$  modName,
$  type = '',
$  dontValidateList = '',
$  setDefaultList = '' 
)

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

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

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

t3lib_BEfunc::compilePreviewKeyword ( $  getVarsStr,
$  beUserUid,
$  ttl = 172800 
)

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:

Parameters:
string Get variables to preview, eg. 'id=1150&L=0&ADMCMD_view=1&ADMCMD_editIcons=1&ADMCMD_previewWS=8'
string 32 byte MD5 hash keyword for the URL: "?ADMCMD_prev=[keyword]"
integer Time-To-Live for keyword
Returns:
string Returns keyword to use in URL for ADMCMD_prev=

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

t3lib_BEfunc::lockRecords ( $  table = '',
$  uid = 0,
$  pid = 0 
)

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

Parameters:
string Table name
integer Record uid
integer Record pid
Returns:
void

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

t3lib_BEfunc::isRecordLocked ( $  table,
$  uid 
)

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

Parameters:
string Table name
integer Record uid
Returns:
array

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

t3lib_BEfunc::exec_foreign_table_where_query ( $  fieldValue,
$  field = '',
$  TSconfig = array(),
$  prefix = '' 
)

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

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

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

t3lib_BEfunc::getTCEFORM_TSconfig ( $  table,
$  row 
)

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

Parameters:
string Table name present in TCA
array Row from table
Returns:
array
See also:
t3lib_transferData::renderRecord(), t3lib_TCEforms::setTSconfig(), SC_wizard_list::main(), SC_wizard_add::main()

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

t3lib_BEfunc::getTSconfig_pidValue ( $  table,
$  uid,
$  pid 
)

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

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

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

t3lib_BEfunc::getPidForModTSconfig ( $  table,
$  uid,
$  pid 
)

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

Parameters:
string Table name
integer Record uid
integer Record pid
Returns:
integer

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

t3lib_BEfunc::getTSCpid ( $  table,
$  uid,
$  pid 
)

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

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

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

t3lib_BEfunc::firstDomainRecord ( $  rootLine  ) 

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

Parameters:
array Root line array
Returns:
string Domain name, if found.

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

t3lib_BEfunc::getDomainStartPage ( $  domain,
$  path = '' 
)

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

Parameters:
string Domain name
string Appended path
Returns:
array Domain record, if found

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

t3lib_BEfunc::RTEsetup ( $  RTEprop,
$  table,
$  field,
$  type = '' 
)

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

Parameters:
array The properties of Page TSconfig in the key "RTE."
string Table name
string Field name
string Type value of the current record (like from CType of tt_content)
Returns:
array Array with the configuration for the RTE

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

& t3lib_BEfunc::RTEgetObj (  ) 

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

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

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

& t3lib_BEfunc::softRefParserObj ( $  spKey  ) 

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

Parameters:
string softRef parser key
Returns:
mixed If available, returns Soft link parser object.

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

t3lib_BEfunc::explodeSoftRefParserList ( $  parserList  ) 

Returns array of soft parser references

Parameters:
string softRef parser list
string Table name
string Field name
Returns:
array Array where the parser key is the key and the value is the parameter string

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

t3lib_BEfunc::isModuleSetInTBE_MODULES ( $  modName  ) 

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

Parameters:
string Module name
Returns:
boolean

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

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

Counting references to a record/file

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

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

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

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

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

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

t3lib_BEfunc::fixVersioningPid ( $  table,
&$  rr,
$  ignoreWorkspaceMatch = FALSE 
)

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

Parameters:
string Table name
array Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
boolean Ignore workspace match
Returns:
void (Passed by ref). If the record had its pid corrected to the online versions pid, then "_ORIG_pid" is set to the original pid value (-1 of course). The field "_ORIG_pid" is used by various other functions to detect if a record was in fact in a versionized branch.
See also:
t3lib_page::fixVersioningPid()

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

t3lib_BEfunc::workspaceOL ( $  table,
&$  row,
$  wsid = -99 
)

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?

Parameters:
string Table name
array Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_swapmode" (pages) fields must exist! Fake fields cannot exist since the fields in the array is used as field names in the SQL look up.
integer Workspace ID, if not specified will use $GLOBALS['BE_USER']->workspace
Returns:
void (Passed by ref).
See also:
fixVersioningPid()

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

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

Select the workspace version of a record, if exists

Parameters:
integer Workspace ID
string Table name to select from
integer Record uid for which to find workspace version.
string Field list to select
Returns:
array If found, return record, otherwise false

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

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

Returns live version of record

Parameters:
string Table name
integer Record UID of draft, offline version
string Field list, default is *
Returns:
array If found, the record, otherwise nothing.

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

t3lib_BEfunc::isPidInVersionizedBranch ( $  pid,
$  table = '',
$  returnStage = FALSE 
)

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

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

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

t3lib_BEfunc::versioningPlaceholderClause ( $  table  ) 

Will return where clause de-selecting new-versions from other workspaces.

Parameters:
string Table name
Returns:
string Where clause if applicable.

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

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

Count number of versions on a page

Parameters:
integer Workspace ID
integer Page ID
boolean If set, then all tables and not only "versioning_followPages" are found (except other pages)
Returns:
array Overview of records

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

t3lib_BEfunc::wsMapId ( $  table,
$  uid 
)

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

Parameters:
string Table name
integer Record uid (of live record placeholder)
Returns:
integer Uid of offline version if any, otherwise live uid.

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

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

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

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

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

t3lib_BEfunc::TYPO3_copyRightNotice (  ) 

Prints TYPO3 Copyright notice for About Modules etc. modules.

Returns:
void

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

t3lib_BEfunc::displayWarningMessages (  ) 

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

Returns:
void

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

t3lib_BEfunc::getPathType_web_nonweb ( $  path  ) 

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

Parameters:
string Path to evaluate
Returns:
boolean

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

t3lib_BEfunc::ADMCMD_previewCmds ( $  pageinfo  ) 

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

Parameters:
array Page record
Returns:
string Query-parameters

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

t3lib_BEfunc::processParams ( $  params  ) 

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

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

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

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

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

Parameters:
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)
Returns:
array Two keys, rows and list

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

The documentation for this class was generated from the following file:
This documentation has been generated automatically from TYPO3 source code using Doxygen and is provided as is by Cast Iron Coding as a courtesy to other TYPO3 developers and users. Please consider Cast Iron Coding — a full-service web development agency in Portland, Oregon specializing in TYPO3 extension development — for all of your TYPO3 development and consulting needs!