class.t3lib_befunc.php File Reference

Go to the source code of this file.

Namespaces
namespace	TYPO3
Classes
class	t3lib_BEfunc
Functions
	getTCEFORM_TSconfig ($table, $row)
	Returns TSConfig for the TCEFORM object in Page TSconfig.
	getTSconfig_pidValue ($table, $uid, $pid)
	Find the real PID of the record (with $uid from $table).
	getPidForModTSconfig ($table, $uid, $pid)
	Return $uid if $table is pages and $uid is integer - otherwise the $pid Usage: 1.
	getTSCpid ($table, $uid, $pid)
	Returns the REAL pid of the record, if possible.
	firstDomainRecord ($rootLine)
	Returns first found domain record "domainName" (without trailing slash) if found in the input $rootLine Usage: 2.
	getDomainStartPage ($domain, $path='')
	Returns the sys_domain record for $domain, optionally with $path appended.
	selectVersionsOfRecord ($table, $uid, $fields='*')
	Select all versions of a record, ordered by version id (DESC).
	RTEsetup ($RTEprop, $table, $field, $type='')
	Returns overlayered RTE setup from an array with TSconfig.
&	RTEgetObj ()
	Returns first possible RTE object if available.
	isModuleSetInTBE_MODULES ($modName)
	Returns true if $modName is set and is found as a main- or submodule in $TBE_MODULES array Usage: 1.
	typo3PrintError ($header, $text, $js='', $head=1)
	Print error message with header, text etc.
	TYPO3_copyRightNotice ()
	Prints TYPO3 Copyright notice for About Modules etc.
	getPathType_web_nonweb ($path)
	Returns "web" if the $path (absolute) is within the DOCUMENT ROOT - and thereby qualifies as a "web" folder.
	ADMCMD_previewCmds ($pageinfo)
	Creates ADMCMD parameters for the "viewpage" extension / "cms" frontend Usage: 1.
	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.
	getListOfBackendModules ($name, $perms_clause, $backPath='', $script='index.php')
	Returns "list of backend modules".

---

Function Documentation

ADMCMD_previewCmds (  $  pageinfo  )

Creates ADMCMD parameters for the "viewpage" extension / "cms" frontend Usage: 1. Parameters: array  Page record Returns: string Query-parameters Definition at line 2979 of file class.t3lib_befunc.php. References t3lib_BEfunc::time(). { if ($pageinfo['fe_group']>0) { $simUser = '&ADMCMD_simUser='.$pageinfo['fe_group']; } if ($pageinfo['starttime']>time()) { $simTime = '&ADMCMD_simTime='.$pageinfo['starttime']; } if ($pageinfo['endtime']<time() && $pageinfo['endtime']!=0) { $simTime = '&ADMCMD_simTime='.($pageinfo['endtime']-1); } return $simUser.$simTime; }

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 2697 of file class.t3lib_befunc.php. References t3lib_BEfunc::getRecordsByField(), and t3lib_extMgm::isLoaded(). Referenced by t3lib_BEfunc::viewOnClick(). { if (t3lib_extMgm::isLoaded('cms')) { reset($rootLine); while(list(,$row)=each($rootLine)) { $dRec = t3lib_BEfunc::getRecordsByField('sys_domain','pid',$row['uid'],' AND redirectTo="" AND hidden=0', '', 'sorting'); if (is_array($dRec)) { reset($dRec); $dRecord = current($dRec); return ereg_replace('\/$','',$dRecord['domainName']); } } } }

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 2719 of file class.t3lib_befunc.php. References t3lib_extMgm::isLoaded(). Referenced by t3lib_BEfunc::viewOnClick(). { if (t3lib_extMgm::isLoaded('cms')) { $domain = explode(':',$domain); $domain = strtolower(ereg_replace('\.$','',$domain[0])); // path is calculated. $path = trim(ereg_replace('\/[^\/]*$','',$path)); // stuff: $domain.=$path; $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('sys_domain.*', 'pages,sys_domain', ' pages.uid=sys_domain.pid AND NOT sys_domain.hidden AND (sys_domain.domainName="'.$GLOBALS['TYPO3_DB']->quoteStr($domain, 'sys_domain').'" or sys_domain.domainName="'.$GLOBALS['TYPO3_DB']->quoteStr($domain.'/', 'sys_domain').'")'. t3lib_BEfunc::deleteClause('pages'), '', '', '1'); return $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res); } }

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 3027 of file class.t3lib_befunc.php. References $out, and t3lib_iconWorks::getIconImage(). { $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'pages', 'doktype!=255 AND module IN ("'.implode('","',$name).'") AND'.$perms_clause.t3lib_BEfunc::deleteClause('pages')); if (!$GLOBALS['TYPO3_DB']->sql_num_rows($res)) return false; $out=''; $theRows=array(); while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { $theRows[]=$row; $out.='<span class="nobr"><a href="'.htmlspecialchars($script.'?id='.$row['uid']).'">'. t3lib_iconWorks::getIconImage('pages',$row,$backPath,'title="'.htmlspecialchars(t3lib_BEfunc::getRecordPath($row['uid'],$perms_clause,20)).'" align="top"'). htmlspecialchars($row['title']). '</a></span><br />'; } return array('rows'=>$theRows,'list'=>$out); }

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 2967 of file class.t3lib_befunc.php. Referenced by localFolderTree::ext_isLinkable(), and t3lib_folderTree::getFolderTree(). { return t3lib_div::isFirstPartOfStr($path,t3lib_div::getIndpEnv('TYPO3_DOCUMENT_ROOT')) ? 'web' : ''; }

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 2665 of file class.t3lib_befunc.php. Referenced by getTSCpid(). { $retVal = ($table=='pages' && t3lib_div::testInt($uid)) ? $uid : $pid; return $retVal; }

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 2590 of file class.t3lib_befunc.php. References t3lib_BEfunc::BEgetRootLine(), t3lib_BEfunc::getTCAtypeValue(), getTSCpid(), and table(). Referenced by getSingleField_typeFlex_sheetMenu(), SC_wizard_add::init(), SC_wizard_list::main(), and t3lib_transferData::renderRecord(). { $res = array(); $typeVal = t3lib_BEfunc::getTCAtypeValue($table,$row); // Get main config for the table list($TScID,$cPid) = t3lib_BEfunc::getTSCpid($table,$row['uid'],$row['pid']); $rootLine = t3lib_BEfunc::BEgetRootLine($TScID,''); if ($TScID>=0) { $tempConf = $GLOBALS['BE_USER']->getTSConfig('TCEFORM.'.$table,t3lib_BEfunc::getPagesTSconfig($TScID,$rootLine)); if (is_array($tempConf['properties'])) { while(list($key,$val)=each($tempConf['properties'])) { if (is_array($val)) { $fieldN = substr($key,0,-1); $res[$fieldN] = $val; unset($res[$fieldN]['types.']); if (strcmp($typeVal,'') && is_array($val['types.'][$typeVal.'.'])) { $res[$fieldN] = t3lib_div::array_merge_recursive_overrule($res[$fieldN],$val['types.'][$typeVal.'.']); } } } } } $res['_CURRENT_PID']=$cPid; $res['_THIS_UID']=$row['uid']; $res['_THIS_CID']=$row['cid']; $res['_THIS_ROW']=$row; // So the row will be passed to foreign_table_where_query() reset($rootLine); while(list(,$rC)=each($rootLine)) { if (!$res['_STORAGE_PID']) $res['_STORAGE_PID']=intval($rC['storage_pid']); if (!$res['_SITEROOT']) $res['_SITEROOT']=$rC['is_siteroot']?intval($rC['uid']):0; } return $res; }

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). Usage: 2 Parameters: string  Table name integer  Record uid integer  Record pid Returns: integer Definition at line 2637 of file class.t3lib_befunc.php. References t3lib_BEfunc::getRecord(), and table(). Referenced by t3lib_TCEmain::copyRecord(), getSingleField_typeFlex_sheetMenu(), and getTSCpid(). { if (t3lib_div::testInt($pid)) { // If pid is an integer this takes precedence in our lookup. $thePidValue = intval($pid); if ($thePidValue<0) { // If ref to another record, look that record up. $pidRec = t3lib_BEfunc::getRecord($table,abs($thePidValue),'pid'); $thePidValue= is_array($pidRec) ? $pidRec['pid'] : -2; // Returns -2 if the record did not exist. } // ... else the pos/zero pid is just returned here. } else { // No integer pid and we are forced to look up the $pid $rr = t3lib_BEfunc::getRecord($table,$uid,'pid'); // Try to fetch the record pid from uid. If the uid is 'NEW...' then this will of course return nothing... if (is_array($rr)) { $thePidValue = $rr['pid']; // Returning the 'pid' of the record } else $thePidValue=-1; // Returns -1 if the record with the pid was not found. } return $thePidValue; }

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 2681 of file class.t3lib_befunc.php. References getPidForModTSconfig(), getTSconfig_pidValue(), and table(). Referenced by t3lib_TCEmain::clear_cache(), getSingleField_typeFlex_sheetMenu(), getSingleField_typeText(), getTCEFORM_TSconfig(), tx_cms_layout::isRTEforField(), t3lib_TCEmain::process_datamap(), t3lib_transferData::renderRecord(), and t3lib_TCEmain::setHistory(). { // If pid is negative (referring to another record) the pid of the other record is fetched and returned. $cPid = t3lib_BEfunc::getTSconfig_pidValue($table,$uid,$pid); // $TScID is the id of $table=pages, else it's the pid of the record. $TScID = t3lib_BEfunc::getPidForModTSconfig($table,$uid,$cPid); return array($TScID,$cPid); }

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 2849 of file class.t3lib_befunc.php. Referenced by SC_alt_main::generateJScode(), SC_alt_doc_nodoc::main(), and t3lib_userAuthGroup::modAccess(). { reset($GLOBALS['TBE_MODULES']); $loaded=array(); while(list($mkey,$list)=each($GLOBALS['TBE_MODULES'])) { $loaded[$mkey]=1; if (trim($list)) { $subList = t3lib_div::trimExplode(',',$list,1); while(list(,$skey)=each($subList)) { $loaded[$mkey.'_'.$skey]=1; } } } return $modName && isset($loaded[$modName]); }

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 3001 of file class.t3lib_befunc.php. References $val. Referenced by typoLink(). { $paramArr=array(); $lines=explode(chr(10),$params); while(list(,$val)=each($lines)) { $val = trim($val); if ($val) { $pair = explode('=',$val,2); $paramArr[trim($pair[0])] = trim($pair[1]); } } return $paramArr; }

& RTEgetObj (   )

Returns first possible RTE object if available. Returns: mixed If available, returns RTE object, otherwise an array of messages from possible RTEs Definition at line 2810 of file class.t3lib_befunc.php. Referenced by t3lib_TCEmain::checkValue_flex_procInData_travDS(), t3lib_TCEmain::fillInFieldArray(), getSingleField_typeText(), and t3lib_userAuthGroup::isRTE(). { // If no RTE object has been set previously, try to create it: if (!isset($GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'])) { // Set the object string to blank by default: $GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'] = array(); // Traverse registered RTEs: if (is_array($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_reg'])) { foreach($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_reg'] as $extKey => $rteObjCfg) { $rteObj = &t3lib_div::getUserObj($rteObjCfg['objRef']); if (is_object($rteObj)) { if ($rteObj->isAvailable()) { $GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'] = &$rteObj; break; } else { $GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'] = array_merge($GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'], $rteObj->errorLog); } } } } if (!count($GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'])) { $GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj'][] = 'No RTEs configured at all'; } } // Return RTE object (if any!) return $GLOBALS['TYPO3_CONF_VARS']['T3_VAR']['RTEobj']; }

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 2792 of file class.t3lib_befunc.php. References table(). Referenced by t3lib_TCEmain::checkValue_flex_procInData_travDS(), t3lib_TCEmain::fillInFieldArray(), getSingleField_typeText(), localFolderTree::SC_browse_links::init(), and tx_cms_layout::isRTEforField(). { $thisConfig = is_array($RTEprop['default.']) ? $RTEprop['default.'] : array(); $thisFieldConf = $RTEprop['config.'][$table.'.'][$field.'.']; if (is_array($thisFieldConf)) { unset($thisFieldConf['types.']); $thisConfig = t3lib_div::array_merge_recursive_overrule($thisConfig,$thisFieldConf); } if ($type && is_array($RTEprop['config.'][$table.'.'][$field.'.']['types.'][$type.'.'])) { $thisConfig = t3lib_div::array_merge_recursive_overrule($thisConfig,$RTEprop['config.'][$table.'.'][$field.'.']['types.'][$type.'.']); } return $thisConfig; }

selectVersionsOfRecord (  $  table, $  uid, $  fields = '*' )

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 Returns: array Array of versions of table/uid Definition at line 2746 of file class.t3lib_befunc.php. References $TCA, and table(). Referenced by getVersionSelector(). { global $TCA; if ($TCA[$table] && $TCA[$table]['ctrl']['versioning']) { // Select all versions of record: $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery( $fields, $table, '(t3ver_oid='.intval($uid).' || uid='.intval($uid).')'. t3lib_BEfunc::deleteClause($table), '', 't3ver_id DESC' ); // Add rows to output array: $realPid = 0; $outputRows = array(); while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { if ($uid==$row['uid']) { $row['_CURRENT_VERSION']=TRUE; $realPid = $row['pid']; } $outputRows[] = $row; } // Set real-pid: foreach($outputRows as $idx => $oRow) { $outputRows[$idx]['_REAL_PID'] = $realPid; } return $outputRows; } }

TYPO3_copyRightNotice (   )

Prints TYPO3 Copyright notice for About Modules etc. modules. Returns: void Definition at line 2942 of file class.t3lib_befunc.php. Referenced by SC_alt_intro::main(). { global $TYPO3_CONF_VARS; // COPYRIGHT NOTICE: $loginCopyrightWarrantyProvider = strip_tags(trim($TYPO3_CONF_VARS['SYS']['loginCopyrightWarrantyProvider'])); $loginCopyrightWarrantyURL = strip_tags(trim($TYPO3_CONF_VARS['SYS']['loginCopyrightWarrantyURL'])); if (strlen($loginCopyrightWarrantyProvider)>=2 && strlen($loginCopyrightWarrantyURL)>=10) { $warrantyNote='Warranty is supplied by '.htmlspecialchars($loginCopyrightWarrantyProvider).'; <a href="'.htmlspecialchars($loginCopyrightWarrantyURL).'" target="_blank">click for details.</a>'; } else { $warrantyNote='TYPO3 comes with ABSOLUTELY NO WARRANTY; <a href="http://typo3.com/1316.0.html" target="_blank">click for details.</a>'; } $cNotice = '<a href="http://typo3.com/" target="_blank"><img src="gfx/loginlogo_transp.gif" width="75" vspace="2" height="19" alt="TYPO3 logo" align="left" />TYPO3 CMS ver. '.htmlspecialchars($GLOBALS['TYPO_VERSION']).'</a>. Copyright &copy; 1998-2004 Kasper Sk&aring;rh&oslash;j. Extensions are copyright of their respective owners. Go to <a href="http://typo3.com/" target="_blank">http://typo3.com/</a> for details. '.strip_tags($warrantyNote,'<a>').' This is free software, and you are welcome to redistribute it under certain conditions; <a href="http://typo3.com/1316.0.html" target="_blank">click for details</a>. Obstructing the appearance of this notice is prohibited by law.'; return $cNotice; }

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 2898 of file class.t3lib_befunc.php. References header(), and table(). Referenced by t3lib_beUserAuth::backendCheckLogin(), SC_index::checkRedirect(), SC_wizard_forms::formsWizard(), language::init(), t3lib_userAuthGroup::isInWebMount(), t3lib_userAuthGroup::modAccess(), and SC_wizard_table::tableWizard(). { // This prints out a TYPO3 error message. // If $js is set the message will be output in JavaScript if ($js) { echo "alert('".t3lib_div::slashJS($header.'\n'.$text)."');"; } else { echo $head?'<html> <head> <title>Error!</title> </head> <body bgcolor="white" topmargin="0" leftmargin="0" marginwidth="0" marginheight="0">':''; echo '<div align="center"> <table border="0" cellspacing="0" cellpadding="0" width="333"> <tr> <td align="center">'. ($GLOBALS['TBE_STYLES']['logo_login']?'<img src="'.$GLOBALS['BACK_PATH'].$GLOBALS['TBE_STYLES']['logo_login'].'" alt="" />':'<img src="'.$GLOBALS['BACK_PATH'].'gfx/typo3logo.gif" width="333" height="43" vspace="10" />'). '</td> </tr> <tr> <td bgcolor="black"> <table width="100%" border="0" cellspacing="1" cellpadding="10"> <tr> <td bgcolor="#F4F0E8"> <font face="verdana,arial,helvetica" size="2">'; echo '<b><center><font size="+1">'.$header.'</font></center></b><br />'.$text; echo ' </font> </td> </tr> </table> </td> </tr> </table> </div>'; echo $head?' </body> </html>':''; } }

---