This is the MAIN DOCUMENT of the TypoScript driven standard front-end (from the "cms" extension) Basically this is the "index.php" script which all requests for TYPO3 delivered pages goes to in the frontend (the website)
tslib
News: I had once said that when PHP 4.0.5 comes out I will reccomend the built in ob_gzhandler over my code unless you are generating flash or images on the fly.
I was wrong. PHP 4.0.5 is out and ob_gzhandler doesn't work for me.
Note: This is rather cool: http://leknor.com/code/gziped.php It will calculate the effects of this class on a page. compression level, cpu time, download time, etc
Note: this may be better for some sites: http://www.remotecommunications.com/apache/mod_gzip/ I've read that the above doesn't work with PHP output.
Changes compared to the upstream version:
2007-03-27 Oliver Hader <oh@inpublica.de>
53: class gzip_encode 193: function gzip_encode($level = 3, $debug=false, $outputCompressedSizes=false) 268: function gzip_accepted() 317: function get_complevel() 342: function linux_loadavg() 363: function freebsd_loadavg()
TOTAL FUNCTIONS: 5 (This index is automatically created/updated by the extension "extdeveval") gzip_encode - a class to gzip encode php output
t3lib
Contains a class for evaluation of database integrity according to $TCA Most of these functions are considered obsolete!
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
93: class t3lib_admin 128: function genTree($theID, $depthData, $versions=FALSE) 217: function genTree_records($theID, $depthData, $table='', $versions=FALSE) 292: function genTreeStatus() 315: function lostRecords($pid_list) 346: function fixLostRecord($table,$uid) 367: function countRecords($pid_list) 395: function getGroupFields($mode) 429: function getFileFields($uploadfolder) 452: function getDBFields($theSearchTable) 480: function selectNonEmptyRecordsWithFkeys($fkey_arrays) 569: function testFileRefs () 620: function testDBRefs($theArray) 658: function whereIsRecordReferenced($searchTable,$id) 695: function whereIsFileReferenced($uploadfolder,$filename)
TOTAL FUNCTIONS: 14 (This index is automatically created/updated by the extension "extdeveval") This class holds functions used by the TYPO3 backend to check the integrity of the database (The DBint module, 'lowlevel' extension)
Depends on: Depends on loaddbgroup from t3lib/
t3lib
Contains the class "t3lib_ajax" containing functions for doing XMLHTTP requests to the TYPO3 backend and as well for generating replys. This technology is also known as ajax. Call ALL methods without making an object!
IMPORTANT NOTICE: The API the class provides is still NOT STABLE and SUBJECT TO CHANGE! It is planned to integrate an external AJAX library, so the API will most likely change again.
t3lib
Class for displaying an array as a tree
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
77: class t3lib_arrayBrowser 96: function tree($arr, $depth_in, $depthData) 160: function wrapValue($theValue,$depth) 172: function wrapArrayKey($label,$depth,$theValue) 196: function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray) 228: function fixed_lgd($string,$chars) 245: function depthKeys($arr,$settings)
TOTAL FUNCTIONS: 6 (This index is automatically created/updated by the extension "extdeveval") Class for displaying an array as a tree See the extension 'lowlevel' /config (Backend module 'Tools > Configuration')
t3lib
Contains class with basic file management functions
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
81: class t3lib_basicFileFunctions
SECTION: Checking functions 133: function init($mounts, $f_ext) 152: function getTotalFileInfo($wholePath) 172: function is_allowed($iconkey,$type) 197: function checkIfFullAccess($theDest) 211: function is_webpath($path) 231: function checkIfAllowed($ext, $theDest, $filename='') 241: function checkFileNameLen($fileName) 251: function is_directory($theDir) 268: function isPathValid($theFile) 283: function getUniqueName($theFile, $theDest, $dontCheckForUnique=0) 326: function checkPathAgainstMounts($thePath) 342: function findFirstWebFolder() 362: function blindPath($thePath) 378: function findTempFolder()
SECTION: Cleaning functions 412: function cleanDirectoryName($theDir) 422: function rmDoubleSlash($string) 432: function slashPath($path) 446: function cleanFileName($fileName,$charset='') 480: function formatSize($sizeInBytes)
TOTAL FUNCTIONS: 19 (This index is automatically created/updated by the extension "extdeveval") Contains functions for management, validation etc of files in TYPO3, using the concepts of web- and ftp-space. Please see the comment for the init() function
t3lib
Contains class for display of backend log
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
81: class t3lib_BEDisplayLog 106: function initArray() 123: function getTimeLabel($code) 139: function getUserLabel($code,$workspace=0) 154: function getTypeLabel($code) 168: function getActionLabel($code) 186: function getDetails($code,$text,$data,$sys_log_uid=0) 220: function reset() 234: function getErrorFormatting($sign, $error=0) 244: function formatDetailsForList($row) 261: function stripPath($inArr)
TOTAL FUNCTIONS: 10 (This index is automatically created/updated by the extension "extdeveval") This class holds some functions used to display the sys_log table-content. Used in the status-scripts and the log-module.
t3lib
Standard functions available for the TYPO3 backend. You are encouraged to use this class in your own applications (Backend Modules)
Call ALL methods without making an object! Eg. to get a page-record 51 do this: 't3lib_BEfuncgetRecord('pages',51)'
Usage counts are based on search 22/2 2003 through whole backend source of typo3/ Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
185: class t3lib_BEfunc
SECTION: SQL-related, selecting records, searching 206: function deleteClause($table,$tableAlias='') 230: function getRecord($table,$uid,$fields='*',$where='',$useDeleteClause=true) 253: function getRecordWSOL($table,$uid,$fields='*',$where='',$useDeleteClause=true) 286: function getRecordRaw($table,$where='',$fields='*') 309: function getRecordsByField($theTable,$theField,$theValue,$whereClause='',$groupBy='',$orderBy='',$limit='',$useDeleteClause=true) 342: function searchQuery($searchWords,$fields,$table='') 357: function listQuery($field,$value) 369: function splitTable_Uid($str) 384: function getSQLselectableList($in_list,$tablename,$default_tablename) 412: function BEenableFields($table,$inv=0)
SECTION: SQL-related, DEPRECATED functions 476: function mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='') 498: function DBcompileInsert($table,$fields_values) 512: function DBcompileUpdate($table,$where,$fields_values)
SECTION: Page tree, TCA related 542: function BEgetRootLine($uid,$clause='',$workspaceOL=FALSE) 598: function openPageTree($pid,$clearExpansion) 643: function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit=0) 686: function getExcludeFields() 716: function getExplicitAuthFieldValues() 787: function getSystemLanguages() 812: function readPageAccess($id,$perms_clause) 843: function getTCAtypes($table,$rec,$useFieldNameAsKey=0) 896: function getTCAtypeValue($table,$rec) 919: function getSpecConfParts($str, $defaultExtras) 950: function getSpecConfParametersFromArray($pArr) 978: function getFlexFormDS($conf,$row,$table,$fieldName='',$WSOL=TRUE)
SECTION: Caching related 1105: function storeHash($hash,$data,$ident) 1125: function getHash($hash,$expTime=0)
SECTION: TypoScript related 1161: function getPagesTSconfig($id,$rootLine='',$returnPartArray=0) 1217: function updatePagesTSconfig($id,$pageTS,$TSconfPrefix,$impParams='') 1272: function implodeTSParams($p,$k='')
SECTION: Users / Groups related 1309: function getUserNames($fields='username,usergroup,usergroup_cached_list,uid',$where='') 1327: function getGroupNames($fields='title,uid', $where='') 1344: function getListGroupNames($fields='title,uid') 1363: function blindUserNames($usernames,$groupArray,$excludeBlindedFlag=0) 1396: function blindGroupNames($groups,$groupArray,$excludeBlindedFlag=0)
SECTION: Output related 1437: function daysUntil($tstamp) 1449: function date($tstamp) 1460: function datetime($value) 1472: function time($value) 1488: function calcAge($seconds,$labels = 'min|hrs|days|yrs') 1514: function dateTimeAge($tstamp,$prefix=1,$date='') 1532: function titleAttrib($content='',$hsc=0) 1545: function titleAltAttrib($content) 1569: function thumbCode($row,$table,$field,$backPath,$thumbScript='',$uploaddir=NULL,$abs=0,$tparams='',$size='') 1637: function getThumbNail($thumbScript,$theFile,$tparams='',$size='') 1654: function titleAttribForPages($row,$perms_clause='',$includeAttrib=1) 1716: function getRecordIconAltText($row,$table='pages') 1758: function getLabelFromItemlist($table,$col,$key) 1784: function getItemLabel($table,$col,$printAllWrap='') 1809: function getRecordTitle($table,$row,$prep=0) 1847: function getProcessedValue($table,$col,$value,$fixed_lgd_chars=0,$defaultPassthrough=0,$noRecordLookup=FALSE,$uid=0) 2009: function getProcessedValueExtra($table,$fN,$fV,$fixed_lgd_chars=0,$uid=0) 2033: function getFileIcon($ext) 2047: function getCommonSelectFields($table,$prefix='') 2090: function makeConfigForm($configArray,$defaults,$dataPrefix)
SECTION: Backend Modules API functions 2165: function helpTextIcon($table,$field,$BACK_PATH,$force=0) 2187: function helpText($table,$field,$BACK_PATH,$styleAttrib='') 2239: function cshItem($table,$field,$BACK_PATH,$wrap='',$onlyIconMode=FALSE, $styleAttrib='') 2277: function editOnClick($params,$backPath='',$requestUri='') 2296: function viewOnClick($id,$backPath='',$rootLine='',$anchor='',$altUrl='',$addGetVars='',$switchFocus=TRUE) 2328: function getModTSconfig($id,$TSref) 2349: function getFuncMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') 2392: function getFuncCheck($mainParams,$elementName,$currentValue,$script='',$addparams='',$tagParams='') 2417: function getFuncInput($mainParams,$elementName,$currentValue,$size=10,$script="",$addparams="") 2438: function unsetMenuItems($modTSconfig,$itemArray,$TSref) 2461: function getSetUpdateSignal($set='') 2512: function getModuleData($MOD_MENU, $CHANGED_SETTINGS, $modName, $type='', $dontValidateList='', $setDefaultList='')
SECTION: Core 2585: function compilePreviewKeyword($getVarsStr, $beUserUid, $ttl=172800) 2613: function lockRecords($table='',$uid=0,$pid=0) 2642: function isRecordLocked($table,$uid) 2682: function exec_foreign_table_where_query($fieldValue,$field='',$TSconfig=array(),$prefix='') 2763: function getTCEFORM_TSconfig($table,$row) 2814: function getTSconfig_pidValue($table,$uid,$pid) 2844: function getPidForModTSconfig($table,$uid,$pid) 2860: function getTSCpid($table,$uid,$pid) 2876: function firstDomainRecord($rootLine) 2898: function getDomainStartPage($domain, $path='') 2928: function RTEsetup($RTEprop,$table,$field,$type='') 2947: function &RTEgetObj() 2986: function &softRefParserObj($spKey) 3018: function explodeSoftRefParserList($parserList) 3050: function isModuleSetInTBE_MODULES($modName) 3073: function referenceCount($table,$ref,$msg='')
SECTION: Workspaces / Versioning 3132: function selectVersionsOfRecord($table, $uid, $fields='*', $workspace=0) 3180: function fixVersioningPid($table,&$rr,$ignoreWorkspaceMatch=FALSE) 3220: function workspaceOL($table,&$row,$wsid=-99) 3268: function getWorkspaceVersionOfRecord($workspace, $table, $uid, $fields='*') 3297: function getLiveVersionOfRecord($table,$uid,$fields='*') 3319: function isPidInVersionizedBranch($pid, $table='',$returnStage=FALSE) 3342: function versioningPlaceholderClause($table) 3356: function countVersionsOfRecordsOnPage($workspace,$pageId, $allTables=FALSE) 3391: function wsMapId($table,$uid)
SECTION: Miscellaneous 3421: function typo3PrintError($header,$text,$js='',$head=1) 3465: function TYPO3_copyRightNotice() 3489: function displayWarningMessages() 3546: function getPathType_web_nonweb($path) 3558: function ADMCMD_previewCmds($pageinfo) 3580: function processParams($params) 3606: function getListOfBackendModules($name,$perms_clause,$backPath='',$script='index.php')
TOTAL FUNCTIONS: 99 (This index is automatically created/updated by the extension "extdeveval") Standard functions available for the TYPO3 backend. Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
t3lib
Contains class for TYPO3 backend user authentication
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
76: class t3lib_beUserAuth extends t3lib_userAuthGroup 150: function trackBeUser($flag) 168: function checkLockToIP() 188: function backendCheckLogin() 216: function checkCLIuser() 240: function backendSetUC() 278: function overrideUC() 288: function resetUC() 301: function emailAtLogin() 353: function veriCode()
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") TYPO3 user authentication, backend Could technically have been the same class as t3lib_userauthgroup since these two are always used together and only together. t3lib_userauthgroup contains most of the functions used for checking permissions, authenticating users, setting up the user etc. This class is most interesting in terms of an API for user from outside. This class contains the configuration of the database fields used plus some functions for the authentication process of backend users.
t3lib
Generate a page-tree, browsable.
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
74: class t3lib_browseTree extends t3lib_treeView 83: function init($clause='') 116: function getTitleAttrib($row) 128: function wrapIcon($icon,$row) 150: function getTitleStr($row,$titleLen=30)
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Extension class for the t3lib_treeView class, specially made for browsing pages
t3lib
Contains base class for TYPO3 cli scripts
60: class t3lib_cli 83: function t3lib_cli() 96: function cli_getArg($option,$argv) 112: function cli_getArgIndex() 131: function cli_keyboardInput() 142: function cli_keyboardInput_yes() 154: function cli_echo($string='',$force=FALSE) 169: function cli_help() 207: function cli_indent($str,$indent)
TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") TYPO3 cli script basis
t3lib
Contains class for TYPO3 clipboard for records and files
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
97: class t3lib_clipboard
SECTION: Initialize 150: function initializeClipboard() 179: function lockToNormal() 196: function setCmd($cmd) 243: function setCurrentPad($padIdent) 258: function endClipboard() 271: function cleanUpCBC($CBarr,$table,$removeDeselected=0)
SECTION: Clipboard HTML renderings 306: function printClipboard() 413: function printContentFromTab($pad) 487: function padTitleWrap($str,$pad) 504: function linkItemText($str,$rec,$table='') 531: function selUrlDB($table,$uid,$copy=0,$deselect=0,$baseArray=array()) 547: function selUrlFile($path,$copy=0,$deselect=0,$baseArray=array()) 564: function pasteUrl($table,$uid,$setRedirect=1) 581: function deleteUrl($setRedirect=1,$file=0) 598: function editUrl() 619: function removeUrl($table,$uid) 632: function confirmMsg($table,$rec,$type,$clElements) 680: function clLabel($key,$Akey='labels') 689: function exportClipElementParameters()
SECTION: Helper functions 739: function removeElement($el) 751: function saveClipboard() 761: function currentMode() 771: function cleanCurrent() 798: function elFromTable($matchTable='',$pad='') 829: function isSelected($table,$uid) 843: function getSelectedRecord($table='',$uid='') 861: function isElements()
SECTION: FOR USE IN tce_db.php: 902: function makePasteCmdArray($ref,$CMD) 931: function makeDeleteCmdArray($CMD)
SECTION: FOR USE IN tce_file.php: 974: function makePasteCmdArray_file($ref,$FILE) 996: function makeDeleteCmdArray_file($FILE)
TOTAL FUNCTIONS: 31 (This index is automatically created/updated by the extension "extdeveval") TYPO3 clipboard for records and files
t3lib
Class for conversion between charsets.
136: class t3lib_cs 488: function parse_charset($charset) 507: function get_locale_charset($locale)
SECTION: Charset Conversion functions 560: function conv($str,$fromCS,$toCS,$useEntityForNoChar=0) 600: function convArray(&$array,$fromCS,$toCS,$useEntityForNoChar=0) 617: function utf8_encode($str,$charset) 663: function utf8_decode($str,$charset,$useEntityForNoChar=0) 706: function utf8_to_entities($str) 739: function entities_to_utf8($str,$alsoStdHtmlEnt=0) 773: function utf8_to_numberarray($str,$convEntities=0,$retChar=0) 823: function UnumberToChar($cbyte) 868: function utf8CharToUnumber($str,$hex=0)
SECTION: Init functions 911: function initCharset($charset) 973: function initUnicodeData($mode=null) 1198: function initCaseFolding($charset) 1260: function initToASCII($charset)
SECTION: String operation functions 1331: function substr($charset,$string,$start,$len=null) 1384: function strlen($charset,$string) 1414: function crop($charset,$string,$len,$crop='') 1467: function strtrunc($charset,$string,$len) 1501: function conv_case($charset,$string,$case) 1527: function specCharsToASCII($charset,$string)
SECTION: Internal string operation functions 1567: function sb_char_mapping($str,$charset,$mode,$opt='')
SECTION: Internal UTF-8 string operation functions 1622: function utf8_substr($str,$start,$len=null) 1655: function utf8_strlen($str) 1676: function utf8_strtrunc($str,$len) 1698: function utf8_strpos($haystack,$needle,$offset=0) 1723: function utf8_strrpos($haystack,$needle) 1745: function utf8_char2byte_pos($str,$pos) 1786: function utf8_byte2char_pos($str,$pos) 1809: function utf8_char_mapping($str,$mode,$opt='')
SECTION: Internal EUC string operation functions 1885: function euc_strtrunc($str,$len,$charset) 1914: function euc_substr($str,$start,$charset,$len=null) 1939: function euc_strlen($str,$charset) 1966: function euc_char2byte_pos($str,$pos,$charset) 2007: function euc_char_mapping($str,$charset,$mode,$opt='')
TOTAL FUNCTIONS: 35 (This index is automatically created/updated by the extension "extdeveval") Notes on UTF-8
Functions working on UTF-8 strings:
Functions nearly working on UTF-8 strings:
Functions NOT working on UTF-8 strings:
t3lib
Contains the class "t3lib_db" containing functions for building SQL queries and mysql wrappers, thus providing a foundational API to all database interaction. This class is instantiated globally as $TYPO3_DB in TYPO3 scripts.
138: class t3lib_DB
SECTION: Query execution 175: function exec_INSERTquery($table,$fields_values,$no_quote_fields=FALSE) 192: function exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE) 206: function exec_DELETEquery($table,$where) 225: function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='') 250: function exec_SELECT_mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='') 278: function exec_SELECT_queryArray($queryParts) 301: function exec_SELECTgetRows($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='',$uidIndexField='')
SECTION: Query building 346: function INSERTquery($table,$fields_values,$no_quote_fields=FALSE) 381: function UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE) 422: function DELETEquery($table,$where) 451: function SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='') 492: function listQuery($field, $value, $table) 506: function searchQuery($searchWords,$fields,$table)
SECTION: Various helper functions 552: function fullQuoteStr($str, $table) 569: function fullQuoteArray($arr, $table, $noQuote=FALSE) 596: function quoteStr($str, $table) 612: function escapeStrForLike($str, $table) 625: function cleanIntArray($arr) 641: function cleanIntList($list) 655: function stripOrderBy($str) 669: function stripGroupBy($str) 681: function splitGroupOrderLimit($str)
SECTION: MySQL wrapper functions 749: function sql($db,$query) 763: function sql_query($query) 776: function sql_error() 788: function sql_num_rows($res) 800: function sql_fetch_assoc($res) 813: function sql_fetch_row($res) 825: function sql_free_result($res) 836: function sql_insert_id() 847: function sql_affected_rows() 860: function sql_data_seek($res,$seek) 873: function sql_field_type($res,$pointer) 887: function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password) 915: function sql_select_db($TYPO3_db)
SECTION: SQL admin functions 947: function admin_get_dbs() 965: function admin_get_tables() 984: function admin_get_fields($tableName) 1002: function admin_get_keys($tableName) 1020: function admin_query($query)
SECTION: Connecting service 1048: function connectDB()
SECTION: Debugging 1086: function debug($func)
TOTAL FUNCTIONS: 42 (This index is automatically created/updated by the extension "extdeveval") TYPO3 "database wrapper" class (new in 3.6.0) This class contains
This class is not in itself a complete database abstraction layer but can be extended to be a DBAL (by extensions, see "dbal" for example) ALL connectivity to the database in TYPO3 must be done through this class! The points of this class are:
USE: In all TYPO3 scripts the global variable $TYPO3_DB is an instance of this class. Use that. Eg. $GLOBALS['TYPO3_DB']->sql_fetch_assoc()
t3lib
Contains class which has functions that generates a difference output of a content string
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj XHTML Compliant
66: class t3lib_diff 86: function makeDiffDisplay($str1,$str2,$wrapTag='span') 163: function getDiff($str1,$str2) 189: function addClearBuffer($clearBuffer,$last=0) 205: function explodeStringIntoWords($str) 226: function tagSpace($str,$rev=0)
TOTAL FUNCTIONS: 5 (This index is automatically created/updated by the extension "extdeveval") This class has functions which generates a difference output of a content string
t3lib
Contains the reknown class "t3lib_div" with general purpose functions
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant Usage counts are based on search 22/2 2003 through whole source including tslib/
279: public static function _GP($var) 297: public static function _GET($var=NULL) 314: public static function _POST($var=NULL) 330: public static function _GETset($inputGet,$key='') 357: public static function GPvar($var,$strip=0) 374: public static function GParrayMerged($var) 391: public function removeXSS($string)
SECTION: IMAGE FUNCTIONS 432: public static function gif_compress($theFile, $type) 459: public static function png_to_gif_by_imagemagick($theFile) 483: public static function read_png_gif($theFile,$output_png=0)
SECTION: STRING FUNCTIONS 533: public static function fixed_lgd($string,$origChars,$preStr='...') 558: public static function fixed_lgd_pre($string,$chars) 572: public static function fixed_lgd_cs($string,$chars) 590: public static function breakTextForEmail($str,$implChar="\n",$charWidth=76) 609: public static function breakLinesForEmail($str,$implChar="\n",$charWidth=76) 645: public static function cmpIP($baseIP, $list) 666: public static function cmpIPv4($baseIP, $list) 707: public static function cmpIPv6($baseIP, $list) 750: public static function IPv6Hex2Bin ($hex) 765: public static function normalizeIPv6($address) 821: public static function validIP($ip) 837: public static function validIPv4($ip) 858: public static function validIPv6($ip) 881: public static function cmpFQDN($baseIP, $list) 911: public static function inList($list, $item) 923: public static function rmFromList($element,$list) 941: public static function expandList($list) 971: public static function intInRange($theInt,$min,$max=2000000000,$zeroValue=0) 987: public static function intval_positive($theInt) 1000: public static function int_from_ver($verNumberStr) 1013: public static function compat_version($verNumberStr) 1031: public static function md5int($str) 1044: public static function shortMD5($input, $len=10) 1057: public static function uniqueList($in_list, $secondParameter=NULL) 1071: public static function split_fileref($fileref) 1109: public static function dirname($path) 1125: public static function modifyHTMLColor($color,$R,$G,$B) 1145: public static function modifyHTMLColorAll($color,$all) 1156: public static function rm_endcomma($string) 1169: public static function danish_strtoupper($string) 1184: public static function convUmlauts($str) 1197: public static function testInt($var) 1209: public static function isFirstPartOfStr($str,$partStr) 1225: public static function formatSize($sizeInBytes,$labels='') 1260: public static function convertMicrotime($microtime) 1274: public static function splitCalc($string,$operators) 1296: public static function calcPriority($string) 1338: public static function calcParenthesis($string) 1364: public static function htmlspecialchars_decode($value) 1379: public static function deHSCentities($str) 1392: public static function slashJS($string,$extended=0,$char="'") 1405: public static function rawUrlEncodeJS($str) 1417: public static function rawUrlEncodeFP($str) 1428: public static function validEmail($email) 1448: public static function isBrokenEmailEnvironment() 1459: public static function normalizeMailAddress($address) 1476: public static function formatForTextarea($content) 1489: public static function strtoupper($str) 1502: public static function strtolower($str)
SECTION: ARRAY FUNCTIONS 1546: public static function inArray(array $in_array, $item) 1564: public static function intExplode($delim, $string) 1583: public static function revExplode($delim, $string, $count=0) 1603: public static function trimExplode($delim, $string, $onlyNonEmptyValues=0) 1636: public static function uniqueArray(array $valueArray) 1648: public static function removeArrayEntryByValue(array $array, $cmpValue) 1672: public static function implodeArrayForUrl($name,array $theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) 1695: public static function explodeUrl2Array($string,$multidim=FALSE) 1721: public static function compileSelectedGetVarsFromArray($varList,array $getArray,$GPvarAlt=1) 1744: public static function addSlashesOnArray(array &$theArray) 1765: public static function stripSlashesOnArray(array &$theArray) 1784: public static function slashArray(array $arr,$cmd) 1801: public static function array_merge_recursive_overrule(array $arr0,array $arr1,$notAddKeys=0,$includeEmtpyValues=true) 1833: public static function array_merge(array $arr1,array $arr2) 1846: public static function csvValues(array $row,$delim=',',$quote='') 1863: public static function array2json(array $jsonArray) 1878: public static function removeDotsFromTS(array $ts)
SECTION: HTML/XML PROCESSING 1921: public static function get_tag_attributes($tag) 1955: public static function split_tag_attributes($tag) 1990: public static function implodeAttributes(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) 2015: public static function implodeParams(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) 2030: public static function wrapJS($string, $linebreak=TRUE) 2061: public static function xml2tree($string,$depth=999) 2137: public static function array2xml_cs(array $array,$docTag='phparray',array $options=array(),$charset='') 2178: public static function array2xml(array $array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0,array $options=array(),array $stackData=array()) 2303: public static function xml2array($string,$NSprefix='',$reportDocTag=FALSE) 2408: public static function xmlRecompileFromStructValArray(array $vals) 2452: public static function xmlGetHeaderAttribs($xmlData) 2466: public static function minifyJavaScript($script, &$error = '')
SECTION: FILES FUNCTIONS 2504: public static function getURL($url, $includeHeader = 0, $requestHeaders = false, &$report = NULL) 2694: public static function writeFile($file,$content) 2719: public static function fixPermissions($file) 2736: public static function writeFileToTypo3tempDir($filepath,$content) 2779: public static function mkdir($theNewFolder) 2800: public static function mkdir_deep($destination,$deepDir) 2821: public static function rmdir($path,$removeNonEmpty=false) 2856: public static function get_dirs($path) 2882: public static function getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='') 2936: public static function getAllFilesAndFoldersInPath(array $fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99,$excludePattern='') 2959: public static function removePrefixPathFromList(array $fileArr,$prefixToRemove) 2977: public static function fixWindowsFilePath($theFile) 2989: public static function resolveBackPath($pathStr) 3017: public static function locationHeaderUrl($path)
SECTION: DEBUG helper FUNCTIONS 3056: public static function debug_ordvalue($string,$characters=100) 3073: public static function view_array($array_in) 3123: public static function print_array($array_in) 3138: public static function debug($var='',$brOrHeader=0) 3174: public static function debug_trail() 3195: public static function debugRows($rows,$header='',$returnHTML=FALSE)
SECTION: SYSTEM INFORMATION 3275: public static function getThisUrl() 3291: public static function linkThisScript(array $getParams=array()) 3315: public static function linkThisUrl($url,array $getParams=array()) 3338: public static function getIndpEnv($getEnvName) 3612: public static function milliseconds() 3624: public static function clientInfo($useragent='') 3682: public static function getHostname($requestHost=TRUE)
SECTION: TYPO3 SPECIFIC FUNCTIONS 3743: public static function getFileAbsFileName($filename,$onlyRelative=TRUE,$relToTYPO3_mainDir=FALSE) 3779: public static function validPathStr($theFile) 3792: public static function isAbsPath($path) 3803: public static function isAllowedAbsPath($path) 3820: public static function verifyFilenameAgainstDenyPattern($filename) 3838: public static function upload_copy_move($source,$destination) 3864: public static function upload_to_tempfile($uploadedFileName) 3882: public static function unlink_tempfile($uploadedTempFileName) 3898: public static function tempnam($filePrefix) 3911: public static function stdAuthCode($uid_or_record,$fields='',$codeLength=8) 3941: public static function cHashParams($addQueryParams) 3980: public static function hideIfNotTranslated($l18n_cfg_fieldValue) 3996: public static function readLLfile($fileRef, $langKey, $charset='') 4029: function readLLPHPfile($fileRef, $langKey, $charset='') 4104: public static function readLLXMLfile($fileRef, $langKey, $charset='') 4245: public static function llXmlAutoFileName($fileRef,$language) 4294: public static function loadTCA($table) 4321: public static function resolveSheetDefInDS($dataStructArray,$sheet='sDEF') 4354: public static function resolveAllSheetsInDS(array $dataStructArray) 4383: public static function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$errorMode=0) 4500: public static function &getUserObj($classRef,$checkPrefix='user_',$silent=0) 4558: public static function &makeInstance($className) 4582: public static function makeInstanceClassName($className) 4596: public static function &makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array()) 4652: public static function requireOnce($requireFile) 4673: public static function plainMailEncoded($email,$subject,$message,$headers='',$encoding='quoted-printable',$charset='',$dontEncodeHeader=false) 4749: public static function quoted_printable($string,$maxlen=76) 4796: public static function encodeHeader($line,$enc='quoted-printable',$charset='iso-8859-1') 4842: public static function substUrlsInPlainText($message,$urlmode='76',$index_script_url='') 4877: public static function makeRedirectUrl($inUrl,$l=0,$index_script_url='') 4905: public static function freetypeDpiComp($font_size) 4917: public static function initSysLog() 4967: public static function sysLog($msg, $extKey, $severity=0) 5050: public static function devLog($msg, $extKey, $severity=0, $dataVar=FALSE) 5071: public static function arrayToLogString(array $arr, $valueList=array(), $valueLength=20) 5093: public static function imageMagickCommand($command, $parameters, $path='') 5140: public static function unQuoteFilenames($parameters,$unQuote=FALSE) 5174: public static function quoteJSvalue($value, $inScriptTags = false)
TOTAL FUNCTIONS: 153 (This index is automatically created/updated by the extension "extdeveval") The legendary "t3lib_div" class - Miscellaneous functions for general purpose. Most of the functions does not relate specifically to TYPO3 However a section of functions requires certain TYPO3 features available See comments in the source. You are encouraged to use this library in your own scripts!
USE: The class is intended to be used without creating an instance of it. So: Don't instantiate - call functions with "t3lib_div::" prefixed the function name. So use t3lib_div::[method-name] to refer to the functions, eg. 't3lib_divmilliseconds()'
t3lib
t3lib_exec finds executables (programs) on Unix and Windows without knowing where they are
85: class t3lib_exec 95: function checkCommand($cmd, $handler='') 166: function getCommand($cmd, $handler='', $handlerOpt='') 199: function addPaths($paths) 211: function getPaths($addInvalid=false) 237: function _init() 259: function _initPaths($paths='') 312: function _getConfiguredApps() 339: function _getPaths() 400: function _fixPath($path)
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") returns exec command for a program or false
This class is meant to be used without instance: $cmd = t3lib_exec::getCommand ('awstats','perl');
The data of this class is hold in a global variable. Doing it this way the setup is cached. That means if a program is found once it don't have to be searched again.
user functions:
addPaths() could be used to extend the search paths getCommand() get a command string checkCommand() returns true if a command is available
Search paths that are included: $TYPO3_CONF_VARS['GFX']['im_path_lzw'] or $TYPO3_CONF_VARS['GFX']['im_path'] $TYPO3_CONF_VARS['SYS']['binPath'] $GLOBALS['_SERVER']['PATH'] '/usr/bin/,/usr/local/bin/' on Unix
binaries can be preconfigured with $TYPO3_CONF_VARS['SYS']['binSetup']
t3lib
extending class to class t3lib_basicFileFunctions
Revised for TYPO3 3.6 May/2004 by Kasper Skaarhoj
105: class t3lib_extFileFunctions extends t3lib_basicFileFunctions 151: function start($fileCmds) 181: function init_actionPerms($setup) 213: function processData() 270: function printLogErrorMessages($redirect='') 328: function findRecycler($theFile) 357: function writeLog($action,$error,$details_nr,$details,$data)
SECTION: File operation functions 384: function func_delete($cmds) 451: function func_copy($cmds) 542: function func_move($cmds) 637: function func_rename($cmds) 683: function func_newfolder($cmds) 713: function func_newfile($cmds) 750: function func_edit($cmds) 782: function func_upload($cmds) 821: function func_unzip($cmds)
TOTAL FUNCTIONS: 15 (This index is automatically created/updated by the extension "extdeveval") Contains functions for performing file operations like copying, pasting, uploading, moving, deleting etc. through the TCE Extending class to class t3lib_basicFileFunctions.
see basicFileFunctions see document "TYPO3 Core API" for syntax
This class contains functions primarily used by tce_file.php (TYPO3 Core Engine for file manipulation) Functions include copying, moving, deleting, uploading and so on...
Important internal variables:
$filemounts (see basicFileFunctions) $f_ext (see basicFileFunctions) ... All fileoperations must be within the filemount-paths. Further the fileextension MUST validate true with the f_ext array
The unzip-function allows unzip only if the destination path has it's f_ext[]['allow'] set to '*'!! You are allowed to copy/move folders within the same 'space' (web/ftp). You are allowed to copy/move folders between spaces (web/ftp) IF the destination has it's f_ext[]['allow'] set to '*'!
Advice: You should always exclude php-files from the webspace. This will keep people from uploading, copy/moving and renaming files to become executable php scripts. You should never mount a ftp_space 'below' the webspace so that it reaches into the webspace. This is because if somebody unzips a zip-file in the ftp-space so that it reaches out into the webspace this will be a violation of the safety For example this is a bad idea: you have an ftp-space that is '/www/' and a web-space that is '/www/htdocs/'
t3lib
Contains a class with Extension Management functions
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
114: class t3lib_extMgm
SECTION: PATHS and other evaluation 131: function isLoaded($key,$exitOnError = 0) 147: function extPath($key,$script='') 165: function extRelPath($key) 182: function siteRelPath($key) 194: function getCN($key)
SECTION: Adding BACKEND features 227: function addTCAcolumns($table,$columnArray,$addTofeInterface=0) 251: function addToAllTCAtypes($table,$str,$specificTypesList='',$position='') 309: function allowTableOnStandardPages($table) 326: function addModule($main,$sub='',$position='',$path='') 389: function insertModuleFunction($modname,$className,$classPath,$title,$MM_key='function',$WS='') 408: function addPageTSConfig($content) 422: function addUserTSConfig($content) 437: function addLLrefForTCAdescr($tca_descr_key,$file_ref)
SECTION: Adding SERVICES features 479: function addService($extKey, $serviceType, $serviceKey, $info) 547: function findService($serviceType, $serviceSubType='', $excludeServiceKeys=array()) 618: function deactivateService($serviceType, $serviceKey)
SECTION: Adding FRONTEND features 657: function addPlugin($itemArray,$type='list_type') 682: function addPiFlexFormValue($piKeyToMatch,$value) 702: function addToInsertRecords($table,$content_table='tt_content',$content_field='records') 733: function addPItoST43($key,$classFile='',$prefix='',$type='list_type',$cached=0) 808: function addStaticFile($extKey,$path,$title) 827: function addTypoScriptSetup($content) 841: function addTypoScriptConstants($content) 858: function addTypoScript($key,$type,$content,$afterStaticUid=0)
SECTION: INTERNAL EXTENSION MANAGEMENT: 921: function typo3_loadExtensions() 998: function _makeIncludeHeader($key,$file) 1019: function isCacheFilesAvailable($cacheFilePrefix) 1032: function isLocalconfWritable() 1045: function cannotCacheFilesWritable($cacheFilePrefix) 1069: function currentCacheFiles() 1092: function writeCacheFiles($extensions,$cacheFilePrefix) 1130: function removeCacheFiles()
TOTAL FUNCTIONS: 32 (This index is automatically created/updated by the extension "extdeveval") Extension Management functions
This class is never instantiated, rather the methods inside is called as functions like t3lib_extMgm::isLoaded('my_extension');
t3lib
Contains the base class for 'Extension Objects' in backend modules.
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
145: class t3lib_extobjbase 197: function init(&$pObj,$conf) 221: function handleExternalFunctionValue() 237: function incLocalLang() 253: function checkExtObj() 268: function extObjContent() 279: function modMenu()
TOTAL FUNCTIONS: 6 (This index is automatically created/updated by the extension "extdeveval") EXAMPLE: One level.
This can be seen in the extension 'cms' where the info module have a function added. In 'ext_tables.php' this is done by this function call:
t3lib_extMgm::insertModuleFunction( 'web_info', 'tx_cms_webinfo_page', t3lib_extMgm::extPath($_EXTKEY).'web_info/class.tx_cms_webinfo.php', 'LLL:EXT:cms/locallang_tca.php:mod_tx_cms_webinfo_page' );
EXAMPLE: Two levels. This is the advanced example. You can see it with the extension 'func_wizards' which is the first layer but then providing another layer for extensions to connect by. The key used in TBE_MODULES_EXT is normally 'function' (for the 'function menu') but the 'func_wizards' extension uses an alternative key for its configuration: 'wiz'. In the 'ext_tables.php' file of an extension ('wizard_crpages') which uses the framework provided by 'func_wizards' this looks like this:
t3lib_extMgm::insertModuleFunction( 'web_func', 'tx_wizardcrpages_webfunc_2', t3lib_extMgm::extPath($_EXTKEY).'class.tx_wizardcrpages_webfunc_2.php', 'LLL:EXT:wizard_crpages/locallang.php:wiz_crMany', 'wiz' );
But for this two-level thing to work it also requires that the parent module (the real backend module) supports it. This is the case for the modules web_func and web_info since they have two times inclusion sections in their index.php scripts. For example (from web_func):
// Make instance: $SOBE = t3lib_div::makeInstance("SC_mod_web_func_index"); $SOBE->init();
// Include files? foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE); $SOBE->checkExtObj(); // Checking for first level external objects
// Repeat Include files! - if any files has been added by second-level extensions foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE); $SOBE->checkSubExtObj(); // Checking second level external objects
$SOBE->main(); $SOBE->printContent();
Notice that the first part is as usual: Include classes and call $SOBE->checkExtObj() to initialize any level-1 sub-modules But then again ->include_once is traversed IF the initialization of the level-1 modules might have added more files!! And after that $SOBE->checkSubExtObj() is called to initialize the second level. In this way even a third level could be supported - but most likely that is a too layered model to be practical.
Anyways, the final interesting thing is to see what the framework "func_wizard" actually does:
require_once(PATH_t3lib."class.t3lib_extobjbase.php"); class tx_funcwizards_webfunc extends t3lib_extobjbase { var $localLangFile = "locallang.php"; var $function_key = "wiz"; function init(&$pObj,$conf) { // OK, handles ordinary init. This includes setting up the menu array with ->modMenu parent::init($pObj,$conf); // Making sure that any further external classes are added to the include_once array. Notice that inclusion happens twice in the main script because of this!!! $this->handleExternalFunctionValue(); } ....
Notice that the handleExternalFunctionValue of this class (t3lib_extobjbase) is called and that the ->function_key internal var is set!
The two level-2 sub-module "wizard_crpages" and "wizard_sortpages" are totally normal "submodules". Parent class for 'Extension Objects' in backend modules. Used for 'submodules' to other modules. Also called 'Function menu modules' in t3lib_extMgm. And now its even called 'Extension Objects'. Or 'Module functions'. Wish we had just one name. Or a name at all...(?) Thank God its not so advanced when it works... In other words this class is used for backend modules which is not true backend modules appearing in the menu but rather adds themselves as a new entry in the function menu which typically exists for a backend module (like Web>Functions, Web>Info or Tools etc...) The magic that binds this together is stored in the global variable $TBE_MODULES_EXT where extensions wanting to connect a module based on this class to an existing backend module store configuration which consists of the classname, script-path and a label (title/name) For more information about this, please see the large example comment for the class t3lib_SCbase. This will show the principle of a 'level-1' connection. The more advanced example - having two layers as it is done by the 'func_wizards' extension with the 'web_info' module - can be seen in the comment above.
t3lib
Contains functions for manipulating flex form data
71: class t3lib_flexformtools 105: function traverseFlexFormXMLData($table,$field,$row,&$callBackObj,$callBackMethod_value) 203: function traverseFlexFormXMLData_recurse($dataStruct,$editData,&$PA,$path='') 274: function getAvailableLanguages()
SECTION: Processing functions 323: function cleanFlexFormXML($table,$field,$row) 347: function cleanFlexFormXML_callBackFunction($dsArr, $data, $PA, $path, &$pObj)
SECTION: Multi purpose functions 374: function &getArrayValueByPath($pathArray,&$array) 403: function setArrayValueByPath($pathArray,&$array,$value) 433: function flexArray2Xml($array, $addPrologue=FALSE)
TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Contains functions for manipulating flex form data
t3lib
Generate a folder tree
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
82: class t3lib_folderTree extends t3lib_treeView 89: function t3lib_folderTree() 107: function wrapIcon($icon,$row) 130: function wrapTitle($title,$row,$bank=0) 145: function getId($v) 155: function getJumpToParam($v) 167: function getTitleStr($row,$titleLen=30) 177: function getBrowsableTree() 240: function getFolderTree($files_path, $depth=999, $depthData='') 320: function getCount($files_path) 336: function initializePositionSaving()
TOTAL FUNCTIONS: 10 (This index is automatically created/updated by the extension "extdeveval") Extension class for the t3lib_treeView class, specially made for browsing folders in the File module
t3lib
Contains a class for formmail
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
69: class t3lib_formmail extends t3lib_htmlmail 95: function start($V,$base64=false) 172: function addAttachment($file, $filename)
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Formmail class, used by the TYPO3 "cms" extension (default frontend) to send email forms.
t3lib
Class used in module tools/dbint (advanced search) and which may hold code specific for that module However the class has a general principle in it which may be used in the web/export module.
88: class t3lib_fullsearch 103: function form() 117: function makeStoreControl() 156: function initStoreArray() 176: function cleanStoreQueryConfigs($storeQueryConfigs,$storeArray) 193: function addToStoreQueryConfigs($storeQueryConfigs,$index) 209: function saveQueryInAction($uid) 256: function loadStoreQueryConfigs($storeQueryConfigs,$storeIndex,$writeArray) 272: function procesStoreControl() 344: function queryMaker() 414: function getQueryResultCode($mQ,$res,$table) 534: function csvValues($row, $delim=',', $quote='', $conf=array(), $table='') 550: function tableWrap($str) 559: function search() 614: function resultRowDisplay($row,$conf,$table) 662: function getProcessedValueExtra($table, $fN, $fV, $conf, $splitString) 781: function getTreeList($id, $depth, $begin = 0, $perms_clause) 818: function makeValueList($fN, $fV, $conf, $table, $splitString) 1028: function resultRowTitles($row,$conf,$table) 1058: function csvRowTitles($row, $conf, $table)
TOTAL FUNCTIONS: 19 (This index is automatically created/updated by the extension "extdeveval") Class used in module tools/dbint (advanced search) and which may hold code specific for that module However the class has a general principle in it which may be used in the web/export module.
t3lib
HTML mail class
193: class t3lib_htmlmail 261: function t3lib_htmlmail () 268: function start () 305: function useQuotedPrintable() 315: function useBase64() 326: function use8Bit() 338: function encodeMsg($content) 348: function addPlain ($content) 360: function addAttachment($file) 378: function addHTML ($file) 401: function extractHtmlInit($html,$url) 412: function send($recipient)
SECTION: Main functions 441: function setHeaders() 500: function setRecipient ($recip) 518: function getHTMLContentType() 527: function setContent() 554: function constructMixed ($boundary) 593: function constructHTML ($boundary) 617: function constructAlternative($boundary) 638: function constructHTML_media ($boundary) 691: function sendTheMail () 757: function getBoundary() 769: function setPlain ($content) 780: function setHtml ($content) 791: function add_header($header) 812: function add_message($string) 823: function getContent($type) 832: function preview()
SECTION: Functions for acquiring attachments, HTML, analyzing and so on ** 860: function fetchHTML($file) 878: function fetchHTMLMedia() 899: function extractMediaLinks() 976: function extractHyperLinks() 1025: function extractFramesInfo() 1051: function substMediaNamesInHTML($absolute) 1078: function substHREFsInHTML() 1106: function substHTTPurlsInPlainText($content) 1142: function fixRollOvers()
SECTION: File and URL-functions 1189: function makeBase64($inputstr) 1200: function getExtendedURL($url) 1222: function addUserPass($url) 1238: function getURL($url) 1250: function getStrippedURL($url) 1271: function getMimeType($url) 1300: function absRef($ref) 1320: function split_fileref($fileref) 1347: function extParseUrl($path) 1362: function tag_regex($tagArray) 1384: function get_tag_attributes($tag) 1426: function quoted_printable($string) 1437: function convertName($name)
TOTAL FUNCTIONS: 49 (This index is automatically created/updated by the extension "extdeveval") NOTES on MIME mail structures:
Plain + HTML multipart/alternative (text, html) multipart/alternative (text, html)
Plain + HTML + image multipart/related (m/a, cids) multipart/alternative (text, html)
multipart/related (m/a, cids) multipart/alternative (text, html)
plain + attachment multipart/mixed
HTML + Attachment: multipart/mixed (text/html , attachments)
Plain + HTML + Attachments: multipart/mixed (m/a, attachments) multipart/alternative (text, html)
Plain + HTML + image + attachment
Outlook expr. multipart/mixed (m/r, attachments) multipart/related (m/a, cids) multipart/alternative (text, html)
FROM RFC 1521:
5.1 Quoted-Printable Content-Transfer-Encoding The Quoted-Printable encoding is intended to represent data that largely consists of octets that correspond to printable characters in the ASCII character set. It encodes the data in such a way that the resulting octets are unlikely to be modified by mail transport. If the data being encoded are mostly ASCII text, the encoded form of the data remains largely recognizable by humans. A body which is entirely ASCII may also be encoded in Quoted-Printable to ensure the integrity of the data should the message pass through a character- translating, and/or line-wrapping gateway.
In this encoding, octets are to be represented as determined by the following rules: Rule #1: (General 8-bit representation) Any octet, except those indicating a line break according to the newline convention of the canonical (standard) form of the data being encoded, may be represented by an "=" followed by a two digit hexadecimal representation of the octet's value. The digits of the hexadecimal alphabet, for this purpose, are "0123456789ABCDEF". Uppercase letters must be used when sending hexadecimal data, though a robust implementation may choose to recognize lowercase letters on receipt. Thus, for example, the value 12 (ASCII form feed) can be represented by "=0C", and the value 61 (ASCII EQUAL SIGN) can be represented by "=3D". Except when the following rules allow an alternative encoding, this rule is mandatory. Rule #2: (Literal representation) Octets with decimal values of 33 through 60 inclusive, and 62 through 126, inclusive, MAY be represented as the ASCII characters which correspond to those octets (EXCLAMATION POINT through LESS THAN, and GREATER THAN through TILDE, respectively). Rule #3: (White Space): Octets with values of 9 and 32 MAY be represented as ASCII TAB (HT) and SPACE characters, respectively, but MUST NOT be so represented at the end of an encoded line. Any TAB (HT) or SPACE characters on an encoded line MUST thus be followed on that line by a printable character. In particular, an "=" at the end of an encoded line, indicating a soft line break (see rule #5) may follow one or more TAB (HT) or SPACE characters. It follows that an octet with value 9 or 32 appearing at the end of an encoded line must be represented according to Rule #1. This rule is necessary because some MTAs (Message Transport Agents, programs which transport messages from one user to another, or perform a part of such transfers) are known to pad lines of text with SPACEs, and others are known to remove "white space" characters from the end of a line. Therefore, when decoding a Quoted-Printable body, any trailing white space on a line must be deleted, as it will necessarily have been added by intermediate transport agents. Rule #4 (Line Breaks): A line break in a text body, independent of what its representation is following the canonical representation of the data being encoded, must be represented by a (RFC 822) line break, which is a CRLF sequence, in the Quoted-Printable encoding. Since the canonical representation of types other than text do not generally include the representation of line breaks, no hard line breaks (i.e. line breaks that are intended to be meaningful and to be displayed to the user) should occur in the quoted-printable encoding of such types. Of course, occurrences of "=0D", "=0A", "0A=0D" and "=0D=0A" will eventually be encountered. In general, however, base64 is preferred over quoted-printable for binary data. Note that many implementations may elect to encode the local representation of various content types directly, as described in Appendix G. In particular, this may apply to plain text material on systems that use newline conventions other than CRLF delimiters. Such an implementation is permissible, but the generation of line breaks must be generalized to account for the case where alternate representations of newline sequences are used. Rule #5 (Soft Line Breaks): The Quoted-Printable encoding REQUIRES that encoded lines be no more than 76 characters long. If longer lines are to be encoded with the Quoted-Printable encoding, 'soft' line breaks must be used. An equal sign as the last character on a encoded line indicates such a non-significant ('soft') line break in the encoded text. Thus if the "raw" form of the line is a single unencoded line that says: Now's the time for all folk to come to the aid of their country.
This can be represented, in the Quoted-Printable encoding, as
Now's the time = for all folk to come= to the aid of their country.
This provides a mechanism with which long lines are encoded in such a way as to be restored by the user agent. The 76 character limit does not count the trailing CRLF, but counts all other characters, including any equal signs. Since the hyphen character ("-") is represented as itself in the Quoted-Printable encoding, care must be taken, when encapsulating a quoted-printable encoded body in a multipart entity, to ensure that the encapsulation boundary does not appear anywhere in the encoded body. (A good strategy is to choose a boundary that includes a character sequence such as "=_" which can never appear in a quoted- printable body. See the definition of multipart messages later in this document.) NOTE: The quoted-printable encoding represents something of a compromise between readability and reliability in transport. Bodies encoded with the quoted-printable encoding will work reliably over most mail gateways, but may not work perfectly over a few gateways, notably those involving translation into EBCDIC. (In theory, an EBCDIC gateway could decode a quoted-printable body and re-encode it using base64, but such gateways do not yet exist.) A higher level of confidence is offered by the base64 Content-Transfer-Encoding. A way to get reasonably reliable transport through EBCDIC gateways is to also quote the ASCII characters !#$@[\]^`{|}~ according to rule #1. See Appendix B for more information. Because quoted-printable data is generally assumed to be line- oriented, it is to be expected that the representation of the breaks between the lines of quoted printable data may be altered in transport, in the same manner that plain text mail has always been altered in Internet mail when passing between systems with differing newline conventions. If such alterations are likely to constitute a corruption of the data, it is probably more sensible to use the base64 encoding rather than the quoted-printable encoding. WARNING TO IMPLEMENTORS: If binary data are encoded in quoted- printable, care must be taken to encode CR and LF characters as "=0D" and "=0A", respectively. In particular, a CRLF sequence in binary data should be encoded as "=0D=0A". Otherwise, if CRLF were represented as a hard line break, it might be incorrectly decoded on platforms with different line break conventions. For formalists, the syntax of quoted-printable data is described by the following grammar:
quoted-printable := ([*(ptext / SPACE / TAB) ptext] ["="] CRLF) ; Maximum line length of 76 characters excluding CRLF
ptext := octet /<any ASCII character except "=", SPACE, or TAB> ; characters not listed as "mail-safe" in Appendix B ; are also not recommended.
octet := "=" 2(DIGIT / "A" / "B" / "C" / "D" / "E" / "F") ; octet must be used for characters > 127, =, SPACE, or TAB, ; and is recommended for any characters not listed in ; Appendix B as "mail-safe". HTML mail class
t3lib
Contains class for icon generation in the backend
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
85: class t3lib_iconWorks 100: function getIconImage($table,$row=array(),$backPath,$params='',$shaded=FALSE) 118: function getIcon($table,$row=array(),$shaded=FALSE) 264: function skinImg($backPath,$src,$wHattribs='',$outputMode=0)
SECTION: Other functions 353: function makeIcon($iconfile,$mode, $user, $protectSection,$absFile,$iconFileName_stateTagged) 475: function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h) 505: function imagecreatefrom($file) 522: function imagemake($im, $path)
TOTAL FUNCTIONS: 7 (This index is automatically created/updated by the extension "extdeveval") Icon generation, backend This library has functions that returns - and if necessary creates - the icon for an element in TYPO3
Expects global vars:
Notes: These functions are strongly related to the interface of TYPO3. The class is included in eg. init.php ALL functions called without making a class instance, eg. "t3lib_iconWorks::getIconImage()"
t3lib
Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
83: class t3lib_install 108: function t3lib_install()
SECTION: Writing to localconf.php 132: function setValueInLocalconfFile(&$line_array, $variable, $value) 183: function writeToLocalconf_control($inlines='',$absFullPath='') 253: function checkForBadString($string) 266: function slashValueForSingleDashes($value)
SECTION: SQL 291: function getFieldDefinitions_fileContent($fileContent) 359: function getFieldDefinitions_sqlContent_parseTypes(&$total) 406: function getFieldDefinitions_database() 450: function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='') 496: function getUpdateSuggestions($diffArr,$keyList='extra,diff') 589: function assembleFieldDefinition($row) 611: function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='') 649: function getCreateTables($statements, $insertCountFlag=0) 683: function getTableInsertStatements($statements, $table) 704: function performUpdateQueries($arr,$keyArr) 720: function getListOfTables() 736: function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0)
TOTAL FUNCTIONS: 17 (This index is automatically created/updated by the extension "extdeveval") Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
t3lib
Contains class for loading database groups
Revised for TYPO3 3.6 September/2003 by Kasper Skaarhoj
76: class t3lib_loadDBGroup 111: function start($itemlist, $tablelist, $MMtable='', $MMuid=0, $currentTable='', $conf=array()) 179: function readList($itemlist) 225: function readMM($tableName,$uid) 276: function writeMM($tableName,$uid,$prependTableName=0) 352: function readForeignField($uid, $conf) 435: function writeForeignField($conf, $parentUid, $updateToUid=0) 510: function getValueArray($prependTableName='') 538: function convertPosNeg($valueArray,$fTable,$nfTable) 560: function getFromDB() 595: function readyForInterface() 621: function countItems($returnAsArray = true) 636: function updateRefIndex($table,$id)
TOTAL FUNCTIONS: 12 (This index is automatically created/updated by the extension "extdeveval") Load database groups (relations) Used to process the relations created by the TCA element types "group" and "select" for database records. Manages MM-relations as well.
t3lib
This document provides a class that loads the modules for the TYPO3 interface.
Modifications by Rene Fritz, 2001 Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
79: class t3lib_loadModules 99: function load($modulesArray,$BE_USER='') 370: function checkExtensionModule($name) 389: function checkMod($name, $fullpath) 471: function checkModAccess($name,$MCONF) 495: function checkModWorkspace($name,$MCONF) 519: function parseModulesArray($arr) 548: function cleanName ($str) 559: function getRelativePath($baseDir,$destDir)
TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Load Backend Interface modules
Typically instantiated like this: $this->loadModules = t3lib_div::makeInstance('t3lib_loadModules'); $this->loadModules->load($TBE_MODULES);
t3lib
Class for providing locking features in TYPO3
It is intended to blocks requests until some data has been generated. This is especially useful if two clients are requesting the same website short after each other. While the request of client 1 triggers building and caching of the website, client 2 will be waiting at this lock.
t3lib
Contains class for Matching TypoScript conditions
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
80: class t3lib_matchCondition 87: function __construct() 105: function t3lib_matchCondition() 115: function match($condition_line) 160: function evalConditionStr($string) 381: function testNumber($test,$value) 405: function matchWild($haystack,$needle) 429: function whichDevice($useragent) 498: function browserInfo($useragent) 611: function browserInfo_version($tmp) 624: function getGlobal($var, $source=NULL) 658: function getGP_ENV_TSFE($var)
TOTAL FUNCTIONS: 11 (This index is automatically created/updated by the extension "extdeveval") Matching TypoScript conditions
Used with the TypoScript parser. Matches browserinfo, IPnumbers for use with templates
t3lib
Manage storing and restoring of $GLOBALS['SOBE']->MOD_SETTINGS settings. Provides a presets box for BE modules.
inspired by t3lib_fullsearch
125: class t3lib_modSettings
SECTION: Init / setup 181: function init($prefix='', $storeList='') 197: function setSessionType($type='ses')
SECTION: Store list - which values should be stored 218: function setStoreList($storeList) 231: function addToStoreList($storeList) 245: function addToStoreListFromPrefix($prefix='')
SECTION: Process storage array 279: function initStorage() 294: function cleanupStorageArray($storedSettings) 316: function compileEntry($data) 343: function getStoredData($storeIndex, $writeArray=array()) 360: function processStoreControl($mconfName='') 442: function writeStoredSetting($writeArray=array(), $mconfName='')
SECTION: GUI 474: function getStoreControl($showElements='load,remove,save', $useOwnForm=TRUE)
SECTION: Misc 576: function processEntry($storageArr)
TOTAL FUNCTIONS: 13 (This index is automatically created/updated by the extension "extdeveval") usage inside of scbase class
....
$this->MOD_MENU = array( 'function' => array( 'xxx ... ), 'tx_dam_select_storedSettings' => '',
....
function main() { // reStore settings $store = t3lib_div::makeInstance('t3lib_modSettings'); $store->init('tx_dam_select'); $store->setStoreList('tx_dam_select'); $store->processStoreControl();
// show control panel $this->content.= $this->doc->section('Settings',$store->getStoreControl(),0,1);
Format of saved settings
$SOBE->MOD_SETTINGS[$this->prefix.'_storedSettings'] = serialize( array ( 'any id' => array ( 'title' => 'title for saved settings', 'desc' => 'descritpion text, not mandatory', 'data' => array(), // data from MOD_SETTINGS 'user' => NULL, // can be used for extra data used by the application to identify this entry 'tstamp' => 12345, // time() ), 'another id' => ...
) ); Manage storing and restoring of $GLOBALS['SOBE']->MOD_SETTINGS settings. Provides a presets box for BE modules.
t3lib
Contains a class with "Page functions" mainly for the frontend
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML-trans compliant
109: class t3lib_pageSelect 134: function init($show_hidden)
SECTION: Selecting page records 184: function getPage($uid, $disableGroupAccessCheck=FALSE) 200: function getPage_noCheck($uid) 216: function getFirstWebPage($uid) 234: function getPageIdFromAlias($alias) 250: function getPageOverlay($pageInput,$lUid=-1) 314: function getRecordOverlay($table,$row,$sys_language_content,$OLmode='')
SECTION: Page related: Menu, Domain record, Root line 413: function getMenu($uid,$fields='*',$sortField='sorting',$addWhere='',$checkShortcuts=1) 471: function getDomainStartPage($domain, $path='',$request_uri='') 519: function getRootLine($uid, $MP='', $ignoreMPerrors=FALSE) 640: function getPathFromRootline($rl,$len=20) 661: function getExtURL($pagerow,$disable=0) 685: function getMountPointInfo($pageId, $pageRec=FALSE, $prevMountPids=array(), $firstPageUid=0)
SECTION: Selecting records in general 762: function checkRecord($table,$uid,$checkPage=0) 797: function getRawRecord($table,$uid,$fields='*',$noWSOL=FALSE) 823: function getRecordsByField($theTable,$theField,$theValue,$whereClause='',$groupBy='',$orderBy='',$limit='')
SECTION: Caching and standard clauses 875: function getHash($hash,$expTime=0) 898: function storeHash($hash,$data,$ident) 916: function deleteClause($table) 936: function enableFields($table,$show_hidden=-1,$ignore_array=array(),$noVersionPreview=FALSE) 1008: function getMultipleGroupsWhereClause($field, $table)
SECTION: Versioning Preview 1055: function fixVersioningPid($table,&$rr) 1096: function versionOL($table,&$row) 1151: function getWorkspaceVersionOfRecord($workspace, $table, $uid, $fields='*')
TOTAL FUNCTIONS: 24 (This index is automatically created/updated by the extension "extdeveval") Page functions, a lot of sql/pages-related functions Mainly used in the frontend but also in some cases in the backend. It's important to set the right $where_hid_del in the object so that the functions operate properly
t3lib
Generate a page-tree, non-browsable.
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
78: class t3lib_pageTree extends t3lib_treeView 90: function init($clause='') 106: function expandNext($id) 123: function PMicon($row,$a,$c,$nextCount,$exp) 138: function initializePositionSaving()
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Class for generating a page tree.
t3lib
Contains class with functions for parsing HTML code.
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
106: class t3lib_parsehtml 123: function getSubpart($content, $marker) 156: function substituteSubpart($content,$marker,$subpartContent,$recursive=1,$keepMarker=0)
SECTION: Parsing HTML code 247: function splitIntoBlock($tag,$content,$eliminateExtraEndTags=0) 308: function splitIntoBlockRecursiveProc($tag,$content,&$procObj,$callBackContent,$callBackTags,$level=0) 344: function splitTags($tag,$content) 378: function getAllParts($parts,$tag_parts=1,$include_tag=1) 396: function removeFirstAndLastTag($str) 412: function getFirstTag($str) 426: function getFirstTagName($str,$preserveCase=FALSE) 445: function get_tag_attributes($tag,$deHSC=0) 486: function split_tag_attributes($tag) 524: function checkTagTypeCounts($content,$blockTags='a,b,blockquote,body,div,em,font,form,h1,h2,h3,h4,h5,h6,i,li,map,ol,option,p,pre,select,span,strong,table,td,textarea,tr,u,ul', $soloTags='br,hr,img,input,area')
SECTION: Clean HTML code 617: function HTMLcleaner($content, $tags=array(),$keepAll=0,$hSC=0,$addConfig=array()) 814: function bidir_htmlspecialchars($value,$dir) 837: function prefixResourcePath($main_prefix,$content,$alternatives=array(),$suffix='') 919: function prefixRelPath($prefix,$srcVal,$suffix='') 937: function cleanFontTags($value,$keepFace=0,$keepSize=0,$keepColor=0) 967: function mapTags($value,$tags=array(),$ltChar='<',$ltChar2='<') 982: function unprotectTags($content,$tagList='') 1015: function stripTagsExcept($value,$tagList) 1038: function caseShift($str,$flag,$cacheKey='') 1065: function compileTagAttribs($tagAttrib,$meta=array(), $xhtmlClean=0) 1093: function get_tag_attributes_classic($tag,$deHSC=0) 1106: function indentLines($content, $number=1, $indentChar="\t") 1123: function HTMLparserConfig($TSconfig,$keepTags=array()) 1247: function XHTML_clean($content) 1269: function processTag($value,$conf,$endTag,$protected=0) 1315: function processContent($value,$dir,$conf)
TOTAL FUNCTIONS: 28 (This index is automatically created/updated by the extension "extdeveval") Functions for parsing HTML. You are encouraged to use this class in your own applications
t3lib
Functions for parsing HTML, specially for TYPO3 processing in relation to TCEmain and Rich Text Editor (RTE)
Revised for TYPO3 3.6 December/2003 by Kasper Skaarhoj XHTML compatible.
103: class t3lib_parsehtml_proc extends t3lib_parsehtml 138: function init($elRef='',$recPid=0) 150: function setRelPath($path) 174: function evalWriteFile($pArr,$currentRecord)
SECTION: Main function 232: function RTE_transform($value,$specConf,$direction='rte',$thisConfig=array())
SECTION: Specific RTE TRANSFORMATION functions 398: function TS_images_db($value) 550: function TS_images_rte($value) 589: function TS_reglinks($value,$direction) 626: function TS_links_db($value) 675: function TS_links_rte($value) 760: function TS_preserve_db($value) 784: function TS_preserve_rte($value) 805: function TS_transform_db($value,$css=FALSE) 922: function transformStyledATags($value) 948: function TS_transform_rte($value,$css=0) 1019: function TS_strip_db($value)
SECTION: Generic RTE transformation, analysis and helper functions 1050: function getURL($url) 1064: function HTMLcleaner_db($content,$tagList='') 1091: function getKeepTags($direction='rte',$tagList='') 1200: function divideIntoLines($value,$count=5,$returnArray=FALSE) 1304: function setDivTags($value,$dT='p') 1349: function internalizeFontTags($value) 1385: function siteUrl() 1395: function rteImageStorageDir() 1407: function removeTables($value,$breakChar='
') 1439: function defaultTStagMapping($code,$direction='rte') 1462: function getWHFromAttribs($attribArray) 1489: function urlInfoForLinkTags($url) 1548: function TS_AtagToAbs($value,$dontSetRTEKEEP=FALSE)
TOTAL FUNCTIONS: 28 (This index is automatically created/updated by the extension "extdeveval") Class for parsing HTML for the Rich Text Editor. (also called transformations)
t3lib
Contains class for creating a position map.
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj XHTML compliant (should be)
85: class t3lib_positionMap
SECTION: Page position map: 132: function positionTree($id,$pageinfo,$perms_clause,$R_URI) 246: function JSimgFunc($prefix='') 276: function boldTitle($t_code,$dat,$id) 293: function onClickEvent($pid,$newPagePID) 312: function insertlabel() 324: function linkPageTitle($str,$rec) 335: function checkNewPageInPid($pid) 351: function getModConfig($pid) 366: function insertQuadLines($codes,$allBlank=0)
SECTION: Content element positioning: 404: function printContentElementColumns($pid,$moveUid,$colPosList,$showHidden,$R_URI) 442: function printRecordMap($lines,$colPosArray) 480: function wrapColumnHeader($str,$vv) 494: function insertPositionIcon($row,$vv,$kk,$moveUid,$pid) 511: function onClickInsertRecord($row,$vv,$moveUid,$pid,$sys_lang=0) 531: function wrapRecordHeader($str,$row) 541: function getRecordHeader($row) 554: function wrapRecordTitle($str,$row)
TOTAL FUNCTIONS: 17 (This index is automatically created/updated by the extension "extdeveval") Position map class - generating a page tree / content element list which links for inserting (copy/move) of records. Used for pages / tt_content element wizards of various kinds.
t3lib
Class for generating front end for building queries
98: class t3lib_queryGenerator 245: function makeFieldList() 273: function init($name,$table,$fieldList='') 410: function setAndCleanUpExternalLists($name,$list,$force='') 426: function procesData($qC='') 529: function cleanUpQueryConfig($queryConfig) 586: function getFormElements($subLevel=0,$queryConfig='',$parent='') 744: function makeOptionList($fN, $conf, $table) 953: function printCodeArray($codeArr,$l=0) 976: function formatQ($str) 989: function mkOperatorSelect($name,$op,$draw,$submit) 1011: function mkTypeSelect($name,$fieldName,$prepend='FIELD_') 1032: function verifyType($fieldName) 1049: function verifyComparison($comparison,$neg) 1068: function mkFieldToInputSelect($name,$fieldName) 1091: function mkTableSelect($name,$cur) 1113: function mkCompSelect($name,$comparison,$neg) 1131: function getSubscript($arr) 1146: function initUserDef() 1155: function userDef() 1164: function userDefCleanUp($queryConfig) 1175: function getQuery ($queryConfig,$pad='') 1205: function getQuerySingle($conf,$first) 1245: function cleanInputVal($conf,$suffix='') 1270: function getUserDefQuery ($qcArr) 1278: function updateIcon() 1287: function getLabelCol() 1299: function makeSelectorTable($modSettings,$enableList='table,fields,query,group,order,limit') 1431: function getTreeList($id, $depth, $begin=0, $perms_clause) 1465: function getSelectQuery($qString = '', $fN = '') 1504: function JSbottom($formname='forms[0]') 1510: function typo3FormFieldSet(theField, evallist, is_in, checkbox, checkboxValue) 1528: function typo3FormFieldGet(theField, evallist, is_in, checkbox, checkboxValue, checkbox_off)
TOTAL FUNCTIONS: 32 (This index is automatically created/updated by the extension "extdeveval") Class for generating front end for building queries
t3lib
Contains a class with functions used to read email content
Revised for TYPO3 3.6 May 2003 by Kasper Skaarhoj
83: class t3lib_readmail
SECTION: General 113: function getMessage($mailParts) 138: function getTextContent($content) 153: function getMailBoundaryParts($boundary,$content) 173: function getCType($str) 196: function analyseReturnError($c) 251: function decodeHeaderString($str) 279: function extractNameEmail($str) 308: function getContentTypeData($contentTypeStr) 331: function makeUnixDate($dateStr) 354: function getGMToffset($GMT) 368: function extractMailHeader($content,$limit=0) 399: function fullParse($content)
TOTAL FUNCTIONS: 12 (This index is automatically created/updated by the extension "extdeveval") Functions used to read email content The class is still just a bunch of miscellaneous functions used to read content out of emails
t3lib
Library with a single function addElement that returns tablerows based on some input.
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
80: class t3lib_recordList 123: function addElement($h,$icon,$data,$tdParams='',$lMargin='',$altLine='') 198: function writeTop() 206: function writeBottom() 225: function fwd_rwd_nav($table='') 258: function fwd_rwd_HTML($type,$pointer,$table='') 284: function listURL($altId='') 294: function CBfunctions() 344: function initializeLanguages() 411: function languageFlag($sys_language_uid)
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") This class is the base for listing of database records and files in the modules Web>List and File>Filelist
t3lib
[CLASS/FUNCTION INDEX of SCRIPT]
89: class t3lib_refindex 107: function updateRefIndexTable($table,$uid,$testOnly=FALSE) 178: function generateRefIndexData($table,$uid) 255: function createEntryData($table,$uid,$field,$flexpointer,$deleted,$ref_table,$ref_uid,$ref_string='',$sort=-1,$softref_key='',$softref_id='') 282: function createEntryData_dbRels($table,$uid,$fieldname,$flexpointer,$deleted,$items) 299: function createEntryData_fileRels($table,$uid,$fieldname,$flexpointer,$deleted,$items) 320: function createEntryData_softreferences($table,$uid,$fieldname,$flexpointer,$deleted,$keys)
SECTION: Get relations from table row 376: function getRelations($table,$row,$onlyField='') 473: function getRelations_flexFormCallBack($dsArr, $dataValue, $PA, $structurePath, &$pObj) 523: function getRelations_procFiles($value, $conf, $uid) 573: function getRelations_procDB($value, $conf, $uid)
SECTION: Setting values 616: function setReferenceValue($hash,$newValue,$returnDataArray=FALSE) 699: function setReferenceValue_dbRels($refRec,$itemArray,$newValue,&$dataArray,$flexpointer='') 737: function setReferenceValue_fileRels($refRec,$itemArray,$newValue,&$dataArray,$flexpointer='') 775: function setReferenceValue_softreferences($refRec,$softref,$newValue,&$dataArray,$flexpointer='')
SECTION: Helper functions 822: function isReferenceField($conf) 832: function destPathFromUploadFolder($folder) 842: function error($msg) 853: function updateIndex($testOnly,$cli_echo=FALSE)
TOTAL FUNCTIONS: 18 (This index is automatically created/updated by the extension "extdeveval") Reference index processing and relation extraction
NOTICE: When the reference index is updated for an offline version the results may not be correct. First, lets assumed that the reference update happens in LIVE workspace (ALWAYS update from Live workspace if you analyse whole database!) Secondly, lets assume that in a Draft workspace you have changed the data structure of a parent page record - this is (in TemplaVoila) inherited by subpages. When in the LIVE workspace the data structure for the records/pages in the offline workspace will not be evaluated to the right one simply because the data structure is taken from a rootline traversal and in the Live workspace that will NOT include the changed DataSTructure! Thus the evaluation will be based on the Data Structure set in the Live workspace! Somehow this scenario is rarely going to happen. Yet, it is an inconsistency and I see now practical way to handle it - other than simply ignoring maintaining the index for workspace records. Or we can say that the index is precise for all Live elements while glitches might happen in an offline workspace? Anyway, I just wanted to document this finding - I don't think we can find a solution for it. And its very TemplaVoila specific.
t3lib
RTE API parent class.
64: class t3lib_rteapi
SECTION: Main API functions; 93: function isAvailable() 118: function drawRTE(&$pObj,$table,$field,$row,$PA,$specConf,$thisConfig,$RTEtypeVal,$RTErelPath,$thePidValue) 151: function transformContent($dirRTE,$value,$table,$field,$row,$specConf,$thisConfig,$RTErelPath,$pid)
SECTION: Helper functions 197: function triggerField($fieldName)
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") RTE base class: Delivers browser-detection, TCEforms binding and transformation routines for the "rte" extension, registering it with the RTE API in TYPO3 3.6.0 See "rte" extension for usage.
t3lib
Contains the parent class for 'ScriptClasses' in backend modules.
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
133: class t3lib_SCbase 249: function init() 269: function menuConfig() 292: function mergeExternalItems($modName,$menuKey,$menuArr) 317: function handleExternalFunctionValue($MM_key='function', $MS_value=NULL) 335: function getExternalItemConfig($modName,$menuKey,$value='') 349: function checkExtObj() 363: function checkSubExtObj() 375: function extObjHeader() 384: function extObjContent()
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") EXAMPLE PROTOTYPE
As for examples there are lots of them if you search for classes which extends 't3lib_SCbase'. However you can see a prototype example of how a module might use this class in an index.php file typically hosting a backend module. NOTICE: This example only outlines the basic structure of how this class is used. You should consult the documentation and other real-world examples for some actual things to do when building modules.
// TYPICAL 'HEADER' OF A BACKEND MODULE: unset($MCONF); require ('conf.php'); require ($BACK_PATH.'init.php'); require ($BACK_PATH.'template.php'); $LANG->includeLLFile('EXT:prototype/locallang.php'); require_once(PATH_t3lib.'class.t3lib_scbase.php'); // NOTICE THE INCLUSION OF t3lib_SCbase $BE_USER->modAccess($MCONF,1);
// SC_mod_prototype EXTENDS THE CLASS t3lib_SCbase with a main() and printContent() function: class SC_mod_prototype extends t3lib_SCbase { // MAIN FUNCTION - HERE YOU CREATE THE MODULE CONTENT IN $this->content function main() { // TYPICALLY THE INTERNAL VAR, $this->doc is instantiated like this: $this->doc = t3lib_div::makeInstance('mediumDoc'); // TYPICALLY THE INTERNAL VAR, $this->backPath is set like this: $this->backPath = $this->doc->backPath = $GLOBALS['BACK_PATH']; // ... AND OF COURSE A LOT OF OTHER THINGS GOES ON - LIKE PUTTING CONTENT INTO $this->content $this->content=''; } // PRINT CONTENT - DONE AS THE LAST THING function printContent() { echo $this->content; } }
// CHECKING IF THERE ARE AN EXTENSION CLASS CONFIGURED FOR THIS CLASS: if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/prototype/index.php']) { include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/prototype/index.php']); }
// MAKE INSTANCE OF THE SCRIPT CLASS AND CALL init() $SOBE = t3lib_div::makeInstance('SC_mod_prototype'); $SOBE->init();
// AFTER INIT THE INTERNAL ARRAY ->include_once MAY HOLD FILENAMES TO INCLUDE foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
// THEN WE WILL CHECK IF THERE IS A 'SUBMODULE' REGISTERED TO BE INITIALIZED AS WELL: $SOBE->checkExtObj();
// THEN WE CALL THE main() METHOD AND THIS SHOULD SPARK THE CREATION OF THE MODULE OUTPUT. $SOBE->main(); // FINALLY THE printContent() FUNCTION WILL OUTPUT THE ACCUMULATED CONTENT $SOBE->printContent(); Parent class for 'ScriptClasses' in backend modules. See example comment above.
t3lib
Soft Reference processing class "Soft References" are references to database elements, files, email addresses, URls etc. which are found in-text in content. The <link [page_id]> tag from typical bodytext fields are an example of this. This class contains generic parsers for the most well-known types which are default for most TYPO3 installations. Soft References can also be userdefined. The Soft Reference parsers are used by the system to find these references and process them accordingly in import/export actions and copy operations.
116: class t3lib_softrefproc 137: function findRef($table, $field, $uid, $content, $spKey, $spParams, $structurePath='') 213: function findRef_images($content, $spParams) 280: function findRef_typolink($content, $spParams) 317: function findRef_typolink_tag($content, $spParams) 352: function findRef_TStemplate($content, $spParams) 434: function findRef_TSconfig($content, $spParams) 457: function findRef_email($content, $spParams) 497: function findRef_url($content, $spParams) 539: function findRef_extension_fileref($content, $spParams)
SECTION: Helper functions 591: function fileadminReferences($content, &$elements) 634: function getTypoLinkParts($typolinkValue) 718: function setTypoLinkPartsElement($tLP, &$elements, $content, $idx) 833: function getPageIdFromAlias($link_param) 845: function makeTokenID($index='')
TOTAL FUNCTIONS: 14 (This index is automatically created/updated by the extension "extdeveval") Example of usage // Soft References: if ($conf['softref'] && strlen($value)) { // Check if a TCA configured field has softreferences defined (see TYPO3 Core API document) $softRefs = t3lib_BEfunc::explodeSoftRefParserList($conf['softref']); // Explode the list of softreferences/parameters foreach($softRefs as $spKey => $spParams) { // Traverse soft references $softRefObj = &t3lib_BEfunc::softRefParserObj($spKey); // create / get object if (is_object($softRefObj)) { // If there was an object returned...: $resultArray = $softRefObj->findRef($table, $field, $uid, $softRefValue, $spKey, $spParams); // Do processing
Result Array: The Result array should contain two keys: "content" and "elements". "content" is a string containing the input content but possibly with tokens inside. Tokens are strings like {softref:[tokenID]} which is a placeholder for a value extracted by a softref parser For each token there MUST be an entry in the "elements" key which has a "subst" key defining the tokenID and the tokenValue. See below. "elements" is an array where the keys are insignificant, but the values are arrays with these keys: "matchString" => The value of the match. This is only for informational purposes to show what was found. "error" => An error message can be set here, like "file not found" etc. "subst" => array( // If this array is found there MUST be a token in the output content as well! "tokenID" => The tokenID string corresponding to the token in output content, {softref:[tokenID]}. This is typically an md5 hash of a string defining uniquely the position of the element. "tokenValue" => The value that the token substitutes in the text. Basically, if this value is inserted instead of the token the content should match what was inputted originally. "type" => file / db / string = the type of substitution. "file" means it is a relative file [automatically mapped], "db" means a database record reference [automatically mapped], "string" means it is manually modified string content (eg. an email address) "relFileName" => (for "file" type): Relative filename. May not necessarily exist. This could be noticed in the error key. "recordRef" => (for "db" type) : Reference to DB record on the form [table]:[uid]. May not necessarily exist. "title" => Title of element (for backend information) "description" => Description of element (for backend information) ) Class for processing of the default soft reference types for CMS:
t3lib
PHP SQL engine EXPERIMENTAL!
104: class t3lib_sqlengine extends t3lib_sqlparser 126: function init($config, &$pObj) 134: function resetStatusVars() 150: function processAccordingToConfig(&$value,$fInfo)
SECTION: SQL queries 205: function exec_INSERTquery($table,$fields_values) 273: function exec_UPDATEquery($table,$where,$fields_values) 332: function exec_DELETEquery($table,$where) 383: function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit) 426: function sql_query($query) 437: function sql_error() 446: function sql_insert_id() 455: function sql_affected_rows() 465: function quoteStr($str)
SECTION: SQL admin functions 490: function admin_get_tables() 501: function admin_get_fields($tableName) 512: function admin_get_keys($tableName) 523: function admin_query($query)
SECTION: Data Source I/O 548: function readDataSource($table) 560: function saveDataSource($table)
SECTION: SQL engine functions (PHP simulation of SQL) - still experimental 590: function selectFromData($table,$where) 628: function select_evalSingle($table,$config,&$itemKeys) 747: function getResultSet($keys, $table, $fieldList)
SECTION: Debugging 790: function debug_printResultSet($array)
829: class t3lib_sqlengine_resultobj 843: function sql_num_rows() 852: function sql_fetch_assoc() 863: function sql_fetch_row() 881: function sql_data_seek($pointer) 894: function sql_field_type()
TOTAL FUNCTIONS: 27 (This index is automatically created/updated by the extension "extdeveval") PHP SQL engine / server Basically this is trying to emulation SQL record selection by PHP, thus allowing SQL queries into alternative data storages managed by PHP. EXPERIMENTAL!
t3lib
PHP SQL engine, result object
t3lib
TYPO3 SQL parser
107: class t3lib_sqlparser
SECTION: SQL Parsing, full queries 129: function parseSQL($parseString) 192: function parseSELECT($parseString) 261: function parseUPDATE($parseString) 315: function parseINSERT($parseString) 375: function parseDELETE($parseString) 413: function parseEXPLAIN($parseString) 435: function parseCREATETABLE($parseString) 514: function parseALTERTABLE($parseString) 583: function parseDROPTABLE($parseString) 616: function parseCREATEDATABASE($parseString)
SECTION: SQL Parsing, helper functions for parts of queries 670: function parseFieldList(&$parseString, $stopRegex='') 791: function parseFromTables(&$parseString, $stopRegex='') 882: function parseWhereClause(&$parseString, $stopRegex='') 990: function parseFieldDef(&$parseString, $stopRegex='')
SECTION: Parsing: Helper functions 1053: function nextPart(&$parseString,$regex,$trimAll=FALSE) 1068: function getValue(&$parseString,$comparator='') 1127: function getValueInQuotes(&$parseString,$quote) 1153: function parseStripslashes($str) 1167: function compileAddslashes($str) 1182: function parseError($msg,$restQuery) 1196: function trimSQL($str)
SECTION: Compiling queries 1225: function compileSQL($components) 1263: function compileSELECT($components) 1294: function compileUPDATE($components) 1322: function compileINSERT($components) 1362: function compileDELETE($components) 1382: function compileCREATETABLE($components) 1415: function compileALTERTABLE($components)
SECTION: Compiling queries, helper functions for parts of queries 1468: function compileFieldList($selectFields) 1510: function compileFromTables($tablesArray) 1551: function compileWhereClause($clauseArray) 1605: function compileFieldCfg($fieldCfg)
SECTION: Debugging 1654: function debug_parseSQLpart($part,$str) 1679: function debug_parseSQLpartCompare($str,$newStr,$caseInsensitive=FALSE) 1712: function debug_testSQL($SQLquery)
TOTAL FUNCTIONS: 35 (This index is automatically created/updated by the extension "extdeveval") TYPO3 SQL parser class.
t3lib
Standard graphical functions
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
155: class t3lib_stdGraphic 236: function init()
SECTION: Layering images / "IMAGE" GIFBUILDER object 366: function maskImageOntoImage(&$im,$conf,$workArea) 436: function copyImageOntoImage(&$im,$conf,$workArea) 458: function copyGifOntoGif(&$im,$cpImg,$conf,$workArea) 537: function imagecopyresized(&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h)
SECTION: Text / "TEXT" GIFBUILDER object 587: function makeText(&$im,$conf,$workArea) 707: function txtPosition($conf,$workArea,$BB) 761: function calcBBox($conf) 820: function addToMap($cords,$conf) 843: function calcTextCordsForMap($cords,$offset, $conf) 878: function SpacedImageTTFText(&$im, $fontSize, $angle, $x, $y, $Fcolor, $fontFile, $text, $spacing, $wordSpacing, $splitRenderingConf, $sF=1) 915: function fontResize($conf) 958: function ImageTTFBBoxWrapper($fontSize, $angle, $fontFile, $string, $splitRendering, $sF=1) 1005: function ImageTTFTextWrapper($im, $fontSize, $angle, $x, $y, $color, $fontFile, $string, $splitRendering,$sF=1) 1058: function splitString($string,$splitRendering,$fontSize,$fontFile) 1208: function calcWordSpacing($conf, $scaleFactor=1) 1227: function getTextScalFactor($conf)
SECTION: Other GIFBUILDER objects related to TEXT 1262: function makeOutline(&$im,$conf,$workArea,$txtConf) 1291: function circleOffset($distance, $iterations) 1315: function makeEmboss(&$im,$conf,$workArea,$txtConf) 1337: function makeShadow(&$im,$conf,$workArea,$txtConf)
SECTION: Other GIFBUILDER objects 1469: function makeBox(&$im,$conf,$workArea) 1491: function makeEffect(&$im, $conf) 1506: function IMparams($setup) 1589: function adjust(&$im, $conf) 1621: function crop(&$im,$conf) 1652: function scale(&$im,$conf) 1684: function setWorkArea($workArea)
SECTION: Adjustment functions 1725: function autolevels(&$im) 1756: function outputLevels(&$im,$low,$high,$swap='') 1788: function inputLevels(&$im,$low,$high,$swap='') 1819: function reduceColors(&$im,$limit, $cols) 1832: function IMreduceColors($file, $cols)
SECTION: GIFBUILDER Helper functions 1875: function prependAbsolutePath($fontFile) 1889: function v5_sharpen($factor) 1908: function v5_blur($factor) 1925: function randomName() 1938: function applyOffset($cords,$OFFSET) 1951: function convertColor($string) 2001: function recodeString($string) 2023: function singleChars($theText,$returnUnicodeNumber=FALSE) 2046: function objPosition($conf,$workArea,$BB)
SECTION: Scaling, Dimensions of images 2125: function imageMagickConvert($imagefile,$newExt='',$w='',$h='',$params='',$frame='',$options='',$mustCreate=0) 2238: function getImageDimensions($imageFile) 2266: function cacheImageDimensions($identifyResult) 2298: function getCachedImageDimensions($imageFile) 2332: function getImageScale($info,$w,$h,$options) 2438: function file_exists_typo3temp_file($output,$orig='')
SECTION: ImageMagick API functions 2499: function imageMagickIdentify($imagefile) 2534: function imageMagickExec($input,$output,$params) 2557: function combineExec($input,$overlay,$mask,$output, $handleNegation = false) 2588: function wrapFileName($inputName)
SECTION: Various IO functions 2629: function checkFile($file) 2643: function createTempSubDir($dirName) 2665: function applyImageMagickToPHPGif(&$im, $command) 2691: function gif_or_jpg($type,$w,$h) 2708: function output($file) 2748: function destroy() 2758: function imgTag ($imgInfo) 2770: function ImageWrite($destImg, $theImage) 2808: function imageGif($destImg, $theImage) 2820: function imageCreateFromGif($sourceImg) 2831: function imageCreateFromFile($sourceImg) 2870: function imagecreate($w, $h) 2885: function hexColor($col) 2903: function unifyColors(&$img, $colArr, $closest = false)
TOTAL FUNCTIONS: 66 (This index is automatically created/updated by the extension "extdeveval") Class contains a bunch of cool functions for manipulating graphics with GDlib/Freetype and ImageMagick VERY OFTEN used with gifbuilder that extends this class and provides a TypoScript API to using these functions
t3lib
Super Admin class has functions for the administration of multiple TYPO3 sites in folders NOTICE: Only compliant with single MySQL database usage per installation!
t3lib
Parent class for "Services" classes
t3lib
Contains a class for various syntax highlighting.
84: class t3lib_syntaxhl
SECTION: Markup of Data Structure, <T3DataStructure> 156: function highLight_DS($str) 183: function highLight_DS_markUpRecursively($struct,$parent='',$app='')
SECTION: Markup of Data Structure, <T3FlexForms> 268: function highLight_FF($str) 295: function highLight_FF_markUpRecursively($struct,$parent='',$app='')
SECTION: Various 376: function getAllTags($str) 407: function splitXMLbyTags($tagList,$str)
TOTAL FUNCTIONS: 6 (This index is automatically created/updated by the extension "extdeveval") Syntax Highlighting class.
t3lib
Contains TYPO3 Core Form generator - AKA "TCEforms"
Revised for TYPO3 3.6 August/2003 by Kasper Skaarhoj XHTML compliant
196: class t3lib_TCEforms 302: function t3lib_TCEforms() 338: function initDefaultBEmode()
SECTION: Rendering the forms, fields etc 385: function getSoloField($table,$row,$theFieldToReturn) 424: function getMainFields($table,$row,$depth=0) 618: function getListedFields($table,$row,$list) 660: function getPaletteFields($table,$row,$palette,$header='',$itemList='',$collapsedHeader='') 737: function getSingleField($table,$field,$row,$altName='',$palette=0,$extra='',$pal=0) 900: function getSingleField_SW($table,$field,$row,&$PA)
SECTION: Rendering of each TCEform field type 976: function getSingleField_typeInput($table,$field,$row,&$PA) 1057: function getSingleField_typeText($table,$field,$row,&$PA) 1178: function getSingleField_typeCheck($table,$field,$row,&$PA) 1244: function getSingleField_typeRadio($table,$field,$row,&$PA) 1279: function getSingleField_typeSelect($table,$field,$row,&$PA) 1359: function getSingleField_typeSelect_single($table,$field,$row,&$PA,$config,$selItems,$nMV_label) 1490: function getSingleField_typeSelect_checkbox($table,$field,$row,&$PA,$config,$selItems,$nMV_label) 1609: function getSingleField_typeSelect_singlebox($table,$field,$row,&$PA,$config,$selItems,$nMV_label) 1719: function getSingleField_typeSelect_multiple($table,$field,$row,&$PA,$config,$selItems,$nMV_label) 1823: function getSingleField_typeGroup($table,$field,$row,&$PA) 1992: function getSingleField_typeNone($table,$field,$row,&$PA) 2008: function getSingleField_typeNone_render($config,$itemValue) 2070: function getSingleField_typeFlex($table,$field,$row,&$PA) 2205: function getSingleField_typeFlex_langMenu($languages,$elName,$selectedLanguage,$multi=1) 2224: function getSingleField_typeFlex_sheetMenu($sArr,$elName,$sheetKey) 2259: function getSingleField_typeFlex_draw($dataStruct,$editData,$cmdData,$table,$field,$row,&$PA,$formPrefix='',$level=0,$tRows=array()) 2452: function getSingleField_typeUnknown($table,$field,$row,&$PA) 2467: function getSingleField_typeUser($table,$field,$row,&$PA)
SECTION: Field content processing 2496: function formatValue ($config, $itemValue)
SECTION: "Configuration" fetching/processing functions 2588: function getRTypeNum($table,$row) 2614: function rearrange($fields) 2640: function getExcludeElements($table,$row,$typeNum) 2688: function getFieldsToAdd($table,$row,$typeNum) 2713: function mergeFieldsWithAddedFields($fields,$fieldsToAdd) 2745: function setTSconfig($table,$row,$field='') 2767: function getSpecConfForField($table,$row,$field) 2788: function getSpecConfFromString($extraString, $defaultExtras) 3007: function loadPaletteElements($table, $row, $palette, $itemList='')
SECTION: Display of localized content etc. 2816: function registerDefaultLanguageData($table,$rec) 2848: function getLanguageOverlayRawValue($table, $row, $field, $fieldConf) 2876: function renderDefaultLanguageContent($table,$field,$row,$item) 2899: function renderDefaultLanguageDiff($table,$field,$row,$item)
SECTION: Form element helper functions 2955: function dbFileIcons($fName,$mode,$allowed,$itemArray,$selector='',$params=array(),$onFocus='') 3108: function getClipboardElements($allowed,$mode) 3157: function getClickMenu($str,$table,$uid='') 3178: function renderWizards($itemKinds,$wizConf,$table,$row,$field,&$PA,$itemName,$specConf,$RTE=0) 3382: function getIcon($icon) 3409: function optionTagStyle($iconString) 3425: function extractValuesOnlyFromValueLabelList($itemFormElValue) 3447: function wrapOpenPalette($header,$table,$row,$palette,$retFunc=0) 3471: function checkBoxParams($itemName,$thisValue,$c,$iCount,$addFunc='') 3485: function elName($itemName) 3496: function noTitle($str,$wrapParts=array()) 3505: function blur() 3514: function thisReturnUrl() 3527: function getSingleHiddenField($table,$field,$row) 3549: function formWidth($size=48,$textarea=0) 3576: function formWidthText($size=48,$wrap='') 3592: function formElStyle($type) 3603: function formElClass($type) 3614: function formElStyleClassValue($type, $class=FALSE) 3638: function insertDefStyle($type) 3657: function getDynTabMenu($parts, $idString)
SECTION: Item-array manipulation functions (check/select/radio) 3696: function initItemArray($fieldValue) 3714: function addItems($items,$iArray) 3736: function procItems($items,$iArray,$config,$table,$row,$field) 3760: function addSelectOptionsToItemArray($items,$fieldValue,$TSconfig,$field) 3980: function addSelectOptionsToItemArray_makeModuleData($value) 4002: function foreignTable($items,$fieldValue,$TSconfig,$field,$pFFlag=0)
SECTION: Template functions 4083: function setNewBEDesign() 4138: function intoTemplate($inArr,$altTemplate='') 4162: function addUserTemplateMarkers($marker,$table,$field,$row,&$PA) 4173: function wrapLabels($str) 4186: function wrapTotal($c,$rec,$table) 4199: function replaceTableWrap($arr,$rec,$table) 4236: function wrapBorder(&$out_array,&$out_pointer) 4258: function rplColorScheme($inTemplate) 4278: function getDivider() 4288: function printPalette($palArr) 4339: function helpTextIcon($table,$field,$force=0) 4359: function helpText($table,$field) 4380: function setColorScheme($scheme) 4404: function resetSchemes() 4415: function storeSchemes() 4427: function restoreSchemes()
SECTION: JavaScript related functions 4457: function JStop() 4508: function JSbottom($formname='forms[0]') 4835: function dbFileCon($formObj='document.forms[0]') 5053: function printNeededJSFunctions() 5080: function printNeededJSFunctions_top()
SECTION: Various helper functions 5128: function getDefaultRecord($table,$pid=0) 5167: function getRecordPath($table,$rec) 5181: function readPerms() 5195: function sL($str) 5208: function getLL($str) 5229: function isPalettesCollapsed($table,$palette) 5245: function isDisplayCondition($displayCond,$row,$ffValueKey='') 5349: function getTSCpid($table,$uid,$pid) 5363: function doLoadTableDescr($table) 5375: function getAvailableLanguages($onlyIsoCoded=1,$setDefault=1)
5417: class t3lib_TCEforms_FE extends t3lib_TCEforms 5425: function wrapLabels($str) 5435: function printPalette($palArr) 5460: function setFancyDesign()
TOTAL FUNCTIONS: 100 (This index is automatically created/updated by the extension "extdeveval") 'TCEforms' - Class for creating the backend editing forms.
t3lib
Contains the TYPO3 Core Engine
Revised for TYPO3 3.9 October 2005 by Kasper Skaarhoj
242: class t3lib_TCEmain 367: function start($data,$cmd,$altUserObject='') 406: function setMirror($mirror) 431: function setDefaultsFromUserTS($userTS) 454: function process_uploads($postFiles) 492: function process_uploads_traverseArray(&$outputArr,$inputArr,$keyToSet)
SECTION: PROCESSING DATA 528: function process_datamap() 886: function placeholderShadowing($table,$id) 929: function fillInFieldArray($table,$id,$fieldArray,$incomingFieldArray,$realPid,$status,$tscPID)
SECTION: Evaluation of input values 1152: function checkValue($table,$field,$value,$id,$status,$realPid,$tscPID) 1212: function checkValue_SW($res,$value,$tcaFieldConf,$table,$id,$curValue,$status,$realPid,$recFID,$field,$uploadedFiles,$tscPID) 1261: function checkValue_input($res,$value,$tcaFieldConf,$PP,$field='') 1299: function checkValue_check($res,$value,$tcaFieldConf,$PP) 1322: function checkValue_radio($res,$value,$tcaFieldConf,$PP) 1348: function checkValue_group_select($res,$value,$tcaFieldConf,$PP,$uploadedFiles,$field) 1458: function checkValue_group_select_file($valueArray,$tcaFieldConf,$curValue,$uploadedFileArray,$status,$table,$id,$recFID) 1632: function checkValue_flex($res,$value,$tcaFieldConf,$PP,$uploadedFiles,$field) 1709: function checkValue_flexArray2Xml($array, $addPrologue=FALSE) 1721: function _DELETE_FLEX_FORMdata(&$valueArrayToRemoveFrom,$deleteCMDS) 1743: function _MOVE_FLEX_FORMdata(&$valueArrayToMoveIn, $moveCMDS, $direction) 1783: function checkValue_inline($res,$value,$tcaFieldConf,$PP,$field) 1825: function checkValue_checkMax($tcaFieldConf, $valueArray)
SECTION: Helper functions for evaluation functions. 1877: function getUnique($table,$field,$value,$id,$newPid=0) 1915: function checkValue_input_Eval($value,$evalArray,$is_in) 2012: function checkValue_group_select_processDBdata($valueArray,$tcaFieldConf,$id,$status,$type,$currentTable) 2058: function checkValue_group_select_explodeSelectGroupValue($value) 2082: function checkValue_flex_procInData($dataPart,$dataPart_current,$uploadedFiles,$dataStructArray,$pParams,$callBackFunc='') 2121: function checkValue_flex_procInData_travDS(&$dataValues,$dataValues_current,$uploadedFiles,$DSelements,$pParams,$callBackFunc,$structurePath)
SECTION: PROCESSING COMMANDS 2267: function process_cmdmap()
SECTION: Cmd: Copying 2407: function copyRecord($table,$uid,$destPid,$first=0,$overrideValues=array(),$excludeFields='') 2529: function copyPages($uid,$destPid) 2583: function copySpecificPage($uid,$destPid,$copyTablesArray,$first=0) 2617: function copyRecord_raw($table,$uid,$pid,$overrideArray=array()) 2681: function rawCopyPageContent($old_pid,$new_pid,$copyTablesArray) 2705: function insertNewCopyVersion($table,$fieldArray,$realPid) 2757: function copyRecord_procBasedOnFieldType($table,$uid,$field,$value,$row,$conf,$realDestPid) 2836: function copyRecord_flexFormCallBack($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2) 2864: function copyRecord_procFilesRefs($conf, $uid, $value)
SECTION: Cmd: Moving, Localizing 2933: function moveRecord($table,$uid,$destPid) 3128: function moveRecord_procFields($table,$uid,$destPid) 3148: function moveRecord_procBasedOnFieldType($table,$uid,$destPid,$field,$value,$conf) 3182: function localize($table,$uid,$language)
SECTION: Cmd: Deleting 3296: function deleteAction($table, $id) 3343: function deleteEl($table, $uid, $noRecordCheck=FALSE, $forceHardDelete=FALSE) 3360: function deleteVersionsForRecord($table, $uid, $forceHardDelete) 3382: function undeleteRecord($table,$uid) 3399: function deleteRecord($table,$uid, $noRecordCheck=FALSE, $forceHardDelete=FALSE,$undeleteRecord=FALSE) 3512: function deleteRecord_flexFormCallBack($dsArr, $dataValue, $PA, $structurePath, &$pObj) 3539: function deletePages($uid,$force=FALSE,$forceHardDelete=FALSE) 3567: function deleteSpecificPage($uid,$forceHardDelete=FALSE) 3592: function canDeletePage($uid) 3619: function cannotDeleteRecord($table,$id) 3638: function deleteRecord_procFields($table, $uid, $undeleteRecord = false) 3661: function deleteRecord_procBasedOnFieldType($table, $uid, $field, $value, $conf, $undeleteRecord = false)
SECTION: Cmd: Versioning 3722: function versionizeRecord($table,$id,$label,$delete=FALSE,$versionizeTree=-1) 3798: function versionizePages($uid,$label,$versionizeTree) 3861: function version_swap($table,$id,$swapWith,$swapIntoWS=0) 4032: function version_clearWSID($table,$id) 4066: function version_setStage($table,$id,$stageId,$comment='')
SECTION: Cmd: Helper functions 4111: function remapListedDBRecords() 4192: function remapListedDBRecords_flexFormCallBack($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2) 4219: function remapListedDBRecords_procDBRefs($conf, $value, $MM_localUid, $table) 4265: function remapListedDBRecords_procInline($conf, $value, $uid, $table)
SECTION: Access control / Checking functions 4308: function checkModifyAccessList($table) 4320: function isRecordInWebMount($table,$id) 4334: function isInWebMount($pid) 4348: function checkRecordUpdateAccess($table,$id) 4372: function checkRecordInsertAccess($insertTable,$pid,$action=1) 4406: function isTableAllowedForThisPage($page_uid, $checkTable) 4439: function doesRecordExist($table,$id,$perms) 4504: function doesRecordExist_pageLookUp($id, $perms) 4530: function doesBranchExist($inList,$pid,$perms,$recurse) 4564: function tableReadOnly($table) 4576: function tableAdminOnly($table) 4590: function destNotInsideSelf($dest,$id) 4622: function getExcludeListArray() 4645: function doesPageHaveUnallowedTables($page_uid,$doktype)
SECTION: Information lookup 4694: function pageInfo($id,$field) 4714: function recordInfo($table,$id,$fieldList) 4735: function getRecordProperties($table,$id,$noWSOL=FALSE) 4751: function getRecordPropertiesFromRow($table,$row)
SECTION: Storing data to Database Layer 4794: function updateDB($table,$id,$fieldArray) 4846: function insertDB($table,$id,$fieldArray,$newVersion=FALSE,$suggestedUid=0,$dontSetNewIdIndex=FALSE) 4919: function checkStoredRecord($table,$id,$fieldArray,$action) 4956: function setHistory($table,$id,$logId) 4989: function clearHistory($maxAgeSeconds=604800,$table) 5003: function updateRefIndex($table,$id)
SECTION: Misc functions 5035: function getSortNumber($table,$uid,$pid) 5108: function resorting($table,$pid,$sortRow, $return_SortNumber_After_This_Uid) 5139: function setTSconfigPermissions($fieldArray,$TSConfig_p) 5156: function newFieldArray($table) 5188: function addDefaultPermittedLanguageIfNotSet($table,&$incomingFieldArray) 5212: function overrideFieldArray($table,$data) 5228: function compareFieldArrayWithCurrentAndUnset($table,$id,$fieldArray) 5274: function assemblePermissions($string) 5291: function rmComma($input) 5301: function convNumEntityToByteValue($input) 5323: function destPathFromUploadFolder($folder) 5333: function deleteClause($table) 5349: function getTCEMAIN_TSconfig($tscPID) 5364: function getTableEntries($table,$TSconfig) 5377: function getPID($table,$uid) 5390: function dbAnalysisStoreExec() 5406: function removeRegisteredFiles() 5418: function removeCacheFiles() 5432: function int_pageTreeInfo($CPtable,$pid,$counter, $rootID) 5453: function compileAdminTables() 5470: function fixUniqueInPid($table,$uid) 5506: function fixCopyAfterDuplFields($table,$uid,$prevUid,$update, $newData=array()) 5531: function extFileFields($table) 5552: function getUniqueFields($table) 5577: function isReferenceField($conf) 5588: function getInlineFieldType($conf) 5611: function getCopyHeader($table,$pid,$field,$value,$count,$prevTitle='') 5640: function prependLabel($table) 5657: function resolvePid($table,$pid) 5687: function clearPrefixFromValue($table,$value) 5702: function extFileFunctions($table,$field,$filelist,$func) 5732: function noRecordsFromUnallowedTables($inList) 5758: function notifyStageChange($stat,$stageId,$table,$id,$comment) 5853: function notifyStageChange_getEmails($listOfUsers,$noTablePrefix=FALSE)
SECTION: Clearing cache 5899: function clear_cache($table,$uid) 6009: function clear_cacheCmd($cacheCmd)
SECTION: Logging 6113: function log($table,$recuid,$action,$recpid,$error,$details,$details_nr=-1,$data=array(),$event_pid=-1,$NEWid='') 6130: function newlog($message, $error=0) 6140: function printLogErrorMessages($redirect)
SECTION: Internal (do not use outside Core!) 6202: function internal_clearPageCache()
TOTAL FUNCTIONS: 126 (This index is automatically created/updated by the extension "extdeveval") This is the TYPO3 Core Engine class for manipulation of the database This class is used by eg. the tce_db.php script which provides an the interface for POST forms to this class.
Dependencies:
tce_db.php for further comments and SYNTAX! Also see document 'TYPO3 Core API' for details.
t3lib
Contains class with time tracking functions
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
88: class t3lib_timeTrack
SECTION: Logging parsing times in the scripts 144: function start() 164: function push($tslabel, $value='') 189: function pull($content='') 207: function setTSlogMessage($content,$num=0) 221: function setTSselectQuery($query,$msg) 234: function incStackPointer() 245: function decStackPointer() 255: function mtime() 265: function convertMicrotime($microtime)
SECTION: Printing the parsing time information (for Admin Panel) 298: function printTSlog() 447: function fixContent(&$arr, $content, $depthData='', $first=0, $vKey='') 511: function fixCLen($c,$v) 527: function fw($str) 541: function createHierarchyArray(&$arr,$pointer,$uniqueId) 561: function debug_typo3PrintError($header,$text,$js,$baseUrl='')
TOTAL FUNCTIONS: 15 (This index is automatically created/updated by the extension "extdeveval") Frontend Timetracking functions
Is used to register how much time is used with operations in TypoScript Used by index_ts
t3lib
Contains class for getting and transforming data for display in backend forms (TCEforms)
Revised for TYPO3 3.6 September/2003 by Kasper Skaarhoj
99: class t3lib_transferData
SECTION: Getting record content, ready for display in TCEforms 138: function fetchRecord($table,$idList,$operation) 225: function renderRecord($table, $id, $pid, $row) 269: function renderRecordRaw($table, $id, $pid, $row, $TSconfig='', $tscPID=0) 327: function renderRecord_SW($data,$fieldConfig,$TSconfig,$table,$row,$field) 359: function renderRecord_groupProc($data,$fieldConfig,$TSconfig,$table,$row,$field) 410: function renderRecord_selectProc($data,$fieldConfig,$TSconfig,$table,$row,$field) 473: function renderRecord_flexProc($data,$fieldConfig,$TSconfig,$table,$row,$field) 504: function renderRecord_typesProc($totalRecordContent,$types_fieldConfig,$tscPID,$table,$pid) 545: function renderRecord_inlineProc($data,$fieldConfig,$TSconfig,$table,$row,$field)
SECTION: FlexForm processing functions 632: function renderRecord_flexProc_procInData($dataPart,$dataStructArray,$pParams) 661: function renderRecord_flexProc_procInData_travDS(&$dataValues,$DSelements,$pParams)
SECTION: Selector box processing functions 738: function selectAddSpecial($dataAcc, $elements, $specialKey) 863: function selectAddForeign($dataAcc, $elements, $fieldConfig, $field, $TSconfig, $row, $table) 917: function getDataIdList($elements, $fieldConfig, $row, $table) 946: function procesItemArray($selItems,$config,$fieldTSConfig,$table,$row,$field) 961: function addItems($items,$iArray) 983: function procItems($items,$itemsProcFuncTSconfig,$config,$table,$row,$field)
SECTION: Helper functions 1018: function lockRecord($table, $id, $pid=0) 1035: function regItem($table, $id, $field, $content) 1045: function sL($in)
TOTAL FUNCTIONS: 20 (This index is automatically created/updated by the extension "extdeveval") Class for getting and transforming data for display in backend forms (TCEforms)
t3lib
Contains translation tools
67: class t3lib_transl8tools 74: function getSystemLanguages($page_id=0,$backPath='') 132: function translationInfo($table,$uid,$sys_language_uid=0) 187: function getTranslationTable($table) 197: function isTranslationInOwnTable($table) 209: function foreignTranslationTable($table)
TOTAL FUNCTIONS: 5 (This index is automatically created/updated by the extension "extdeveval") Contains translation tools
t3lib
Contains base class for creating a browsable array/page/folder tree in HTML
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
115: class t3lib_treeView 270: function init($clause='', $orderByFields='') 301: function setTreeName($treeName='') 315: function addField($field,$noCheck=0) 329: function reset()
SECTION: output 349: function getBrowsableTree() 412: function printTree($treeArr='')
SECTION: rendering parts 467: function PMicon($row,$a,$c,$nextCount,$exp) 489: function PM_ATagWrap($icon,$cmd,$bMark='') 511: function wrapTitle($title,$row,$bank=0) 524: function wrapIcon($icon,$row) 535: function addTagAttributes($icon,$attr) 547: function wrapStop($str,$row)
SECTION: tree handling 575: function expandNext($id) 585: function initializePositionSaving() 612: function savePosition()
SECTION: Functions that might be overwritten by extended classes 641: function getRootIcon($rec) 654: function getIcon($row) 673: function getTitleStr($row,$titleLen=30) 685: function getTitleAttrib($row) 695: function getId($row) 705: function getJumpToParam($row)
SECTION: tree data buidling 739: function getTree($uid, $depth=999, $depthData='',$blankLineCode='',$subCSSclass='')
SECTION: Data handling 839: function getCount($uid) 865: function getRootRecord($uid) 878: function getRecord($uid) 898: function getDataInit($parentId,$subCSSclass='') 929: function getDataCount(&$res) 947: function getDataNext(&$res,$subCSSclass='') 986: function getDataFree(&$res) 1006: function setDataFromArray(&$dataArr,$traverse=FALSE,$pid=0) 1035: function setDataFromTreeArray(&$treeArr, &$treeLookupArr)
TOTAL FUNCTIONS: 31 (This index is automatically created/updated by the extension "extdeveval") Base class for creating a browsable array/page/folder tree in HTML
t3lib
Class for TYPO3 backend user authentication in the TSFE frontend
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML compliant
103: class t3lib_tsfeBeUserAuth extends t3lib_beUserAuth 129: function extInitFeAdmin() 154: function extPrintFeAdminDialog()
SECTION: Creating sections of the Admin Panel 250: function extGetCategory_preview($out='') 283: function extGetCategory_cache($out='') 321: function extGetCategory_publish($out='') 356: function extGetCategory_edit($out='') 400: function extGetCategory_tsdebug($out='') 433: function extGetCategory_info($out='')
SECTION: Admin Panel Layout Helper functions 506: function extGetHead($pre) 526: function extItemLink($pre,$str) 542: function extGetItem($pre,$element) 559: function extFw($str) 568: function ext_makeToolBar()
SECTION: TSFE BE user Access Functions 637: function checkBackendAccessSettingsFromInitPhp() 682: function extPageReadAccess($pageRec) 693: function extAdmModuleEnabled($key) 709: function extSaveFeAdminConfig() 741: function extGetFeAdminValue($pre,$val='') 783: function extIsAdmMenuOpen($pre)
SECTION: TSFE BE user Access Functions 818: function extGetTreeList($id,$depth,$begin=0,$perms_clause) 849: function extGetNumberOfCachedPages($page_id)
SECTION: Localization handling 888: function extGetLL($key)
SECTION: Frontend Editing 932: function extIsEditAction() 954: function extIsFormShown() 970: function extEditAction()
TOTAL FUNCTIONS: 25 (This index is automatically created/updated by the extension "extdeveval") TYPO3 backend user authentication in the TSFE frontend. This includes mainly functions related to the Admin Panel
t3lib
Contains the TypoScript parser class
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
80: class t3lib_TSparser 133: function parse($string,$matchObj='') 169: function nextDivider() 185: function parseSub(&$setup) 389: function rollParseSub($string,&$setup) 413: function getVal($string,$setup) 439: function setVal($string,&$setup,$value,$wipeOut=0) 485: function error($err,$num=2) 497: function checkIncludeLines($string) 541: function checkIncludeLines_array($array)
SECTION: Syntax highlighting 584: function doSyntaxHighlight($string,$lineNum='',$highlightBlockMode=0) 605: function regHighLight($code,$pointer,$strlen=-1) 623: function syntaxHighlight_print($lineNumDat,$highlightBlockMode)
TOTAL FUNCTIONS: 12 (This index is automatically created/updated by the extension "extdeveval") The TypoScript parser
t3lib
TSParser extension class to t3lib_TStemplate
Contains functions for the TS module in TYPO3 backend
105: class t3lib_tsparser_ext extends t3lib_TStemplate 191: function flattenSetup($setupArray, $prefix, $resourceFlag) 218: function substituteConstants($all) 231: function substituteConstantsCallBack($matches) 261: function substituteCMarkers($all) 284: function generateConfig_constants() 330: function ext_getSetup($theSetup,$theKey) 358: function ext_getObjTree($arr, $depth_in, $depthData, $parentType='',$parentValue='', $alphaSort='0') 463: function lineNumberToScript($lnArr) 494: function makeHtmlspecialchars($theValue) 507: function ext_getSearchKeys($arr, $depth_in, $searchString, $keyArray) 562: function ext_getRootlineNumber($pid) 580: function ext_getTemplateHierarchyArr($arr,$depthData, $keyArray,$first=0) 639: function ext_process_hierarchyInfo($depthDataArr,&$pointer) 670: function ext_outputTS($config, $lineNumbers=0, $comments=0, $crop=0, $syntaxHL=0, $syntaxHLBlockmode=0) 697: function ext_fixed_lgd($string,$chars) 713: function ext_lnBreakPointWrap($ln,$str) 726: function ext_formatTS($input, $ln, $comments=1, $crop=0) 765: function ext_getFirstTemplate($id,$template_uid=0) 785: function ext_getAllTemplates($id) 806: function ext_compareFlatSetups($default) 872: function ext_categorizeEditableConstants($editConstArray) 895: function ext_getCategoryLabelArray() 912: function ext_getTypeData($type) 953: function ext_getTSCE_config($category) 992: function ext_getKeyImage($key) 1002: function ext_getTSCE_config_image($imgConf) 1026: function ext_resourceDims() 1056: function ext_readDirResources($path) 1071: function readDirectory($path,$type='file') 1096: function ext_fNandV($params) 1114: function ext_printFields($theConstants,$category)
SECTION: Processing input values 1408: function ext_regObjectPositions($constants) 1423: function ext_regObjects($pre) 1468: function ext_putValueInConf($key, $var) 1491: function ext_removeValueInConf($key) 1507: function ext_depthKeys($arr,$settings) 1542: function ext_procesInput($http_post_vars,$http_post_files,$theConstants,$tplRow) 1666: function upload_copy_file($typeDat,&$tplRow,$theRealFileName,$tmp_name) 1715: function ext_prevPageWithTemplate($id,$perms_clause) 1731: function ext_setStar($val) 1743: function ext_detectAndFixExtensionPrefix($value)
TOTAL FUNCTIONS: 41 (This index is automatically created/updated by the extension "extdeveval") TSParser extension class to t3lib_TStemplate
t3lib
Provides a simplified layer for making Constant Editor style configuration forms
79: class t3lib_tsStyleConfig extends t3lib_tsparser_ext 98: function ext_initTSstyleConfig($configTemplate,$pathRel,$pathAbs,$backPath) 118: function ext_setValueArray($theConstants,$valueArray) 145: function ext_getCategoriesForModMenu() 155: function ext_makeHelpInformationForCategory($cat) 168: function ext_getForm($cat,$theConstants,$script="",$addFields="") 175: function uFormUrl(aname) 197: function ext_displayExample() 213: function ext_mergeIncomingWithExisting($arr) 221: function ext_getKeyImage($key) 231: function ext_getTSCE_config_image($imgConf) 244: function ext_fNandV($params) 262: function ext_loadResources($absPath) 278: function ext_putValueInConf($key, $var) 288: function ext_removeValueInConf($key)
TOTAL FUNCTIONS: 14 (This index is automatically created/updated by the extension "extdeveval") Provides a simplified layer for making Constant Editor style configuration forms
t3lib
Class with template object that is responsible for generating the template
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
109: class t3lib_TStemplate 211: function init() 249: function getCurrentPageData() 266: function matching($cc) 290: function start($theRootLine)
SECTION: Fetching TypoScript code text for the Template Hierarchy 406: function runThroughTemplates($theRootLine,$start_template_uid=0) 459: function processTemplate($row, $idList,$pid,$templateID='',$templateParent='') 580: function includeStaticTypoScriptSources($idList,$templateID,$pid,$row) 642: function addExtensionStatics($idList,$templateID,$pid,$row) 675: function prependStaticExtra($subrow) 688: function versionOL(&$row)
SECTION: Parsing TypoScript code text from Template Records into PHP array 725: function generateConfig() 891: function procesIncludes() 915: function mergeConstantsFromPageTSconfig($constArray) 944: function flattenSetup($setupArray, $prefix, $resourceFlag) 968: function substituteConstants($all) 991: function substituteConstantsCallBack($matches)
SECTION: Various API functions, used from elsewhere in the frontend classes 1022: function splitConfArray($conf,$splitCount) 1099: function getFileName($fileFromSetup) 1156: function extractFromResources($res,$file) 1184: function checkFile($name,$menuArr) 1201: function printTitle($title,$no_title=0,$titleFirst=0) 1224: function fileContent($fName) 1244: function wrap($content,$wrap) 1258: function removeQueryString($url) 1275: function sortedKeyList($setupArr, $acceptOnlyProperties=FALSE)
SECTION: Functions for creating links 1322: function linkData($page,$oTarget,$no_cache,$script,$overrideArray='',$addParams='',$typeOverride='') 1449: function getFromMPmap($pageId=0) 1485: function initMPmap_create($id,$MP_array=array(),$level=0)
TOTAL FUNCTIONS: 28 (This index is automatically created/updated by the extension "extdeveval") Template object that is responsible for generating the TypoScript template based on template records.
t3lib
Contains a base class for authentication of users in TYPO3, both frontend and backend.
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
111: class t3lib_userAuth 195: function start() 329: function checkAuthentication()
SECTION: User Sessions 569: function createUserSession ($tempuser) 606: function fetchUserSession() 657: function logoff()
SECTION: SQL Functions 713: function user_where_clause() 727: function ipLockClause() 745: function ipLockClause_remoteIPNumber($parts) 766: function hashLockClause() 777: function hashLockClause_getHashInt()
SECTION: Session and Configuration Handling 809: function writeUC($variable='') 824: function unpack_uc($theUC='') 840: function pushModuleData($module,$data,$noSave=0) 853: function getModuleData($module,$type='') 866: function getSessionData($key) 879: function setAndSaveSessionData($key,$data)
SECTION: Misc 912: function getLoginFormData() 939: function processLoginData($loginData, $security_level='') 981: function getAuthInfoArray() 1011: function compareUident($user, $loginData, $security_level='') 1050: function gc() 1064: function redirect() 1086: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid) 1095: function checkLogFailures() 1108: function setBeUserByUid($uid) 1120: function setBeUserByName($name) 1131: function getRawUserByUid($uid) 1149: function getRawUserByName($name)
SECTION: Create/update user - EXPERIMENTAL 1188: function fetchUserRecord($dbUser, $username, $extraWhere='' )
TOTAL FUNCTIONS: 29 (This index is automatically created/updated by the extension "extdeveval") Authentication of users in TYPO3
This class is used to authenticate a login user. The class is used by both the frontend and backend. In both cases this class is a parent class to beuserauth and feuserauth
See Inside TYPO3 for more information about the API of the class and internal variables.
t3lib
Contains an extension class specifically for authentication/initialization of backend users in TYPO3
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
135: class t3lib_userAuthGroup extends t3lib_userAuth
SECTION: Permission checking functions: 199: function isAdmin() 211: function isMemberOfGroup($groupId) 233: function doesUserHaveAccess($row,$perms) 250: function isInWebMount($id,$readPerms='',$exitOnError=0) 277: function modAccess($conf,$exitOnError) 328: function getPagePermsClause($perms) 367: function calcPerms($row) 405: function isRTE() 439: function check($type,$value) 456: function checkAuthMode($table,$field,$value,$authMode) 522: function checkLanguageAccess($langValue) 544: function recordEditAccessInternals($table,$idOrRow,$newRecord=FALSE) 619: function isPSet($lCP,$table,$type='') 636: function mayMakeShortcut() 650: function workspaceCannotEditRecord($table,$recData) 689: function workspaceCannotEditOfflineVersion($table,$recData) 712: function workspaceAllowLiveRecordsInPID($pid, $table) 733: function workspaceCreateNewRecord($pid, $table) 752: function workspaceAllowAutoCreation($table,$id,$recpid) 772: function workspaceCheckStageForCurrent($stage) 795: function workspacePublishAccess($wsid) 823: function workspaceSwapAccess() 835: function workspaceVersioningTypeAccess($type) 866: function workspaceVersioningTypeGetClosest($type)
SECTION: Miscellaneous functions 909: function getTSConfig($objectString,$config='') 935: function getTSConfigVal($objectString) 947: function getTSConfigProp($objectString) 959: function inList($in_list,$item) 970: function returnWebmounts() 980: function returnFilemounts() 997: function jsConfirmation($bitmask)
SECTION: Authentication methods 1035: function fetchGroupData() 1168: function fetchGroups($grList,$idList='') 1266: function setCachedList($cList) 1286: function addFileMount($title, $altTitle, $path, $webspace, $type) 1333: function addTScomment($str)
SECTION: Workspaces 1369: function workspaceInit() 1412: function checkWorkspace($wsRec,$fields='uid,title,adminusers,members,reviewers,publish_access,stagechg_notification') 1487: function checkWorkspaceCurrent() 1500: function setWorkspace($workspaceId) 1528: function setWorkspacePreview($previewState) 1538: function getDefaultWorkspace()
SECTION: Logging 1589: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='',$userId=0) 1621: function simplelog($message, $extKey='', $error=0) 1642: function checkLogFailures($email, $secondsBack=3600, $max=3)
TOTAL FUNCTIONS: 45 (This index is automatically created/updated by the extension "extdeveval") Extension to class.t3lib_userauth.php; Authentication of users in TYPO3 Backend
Actually this class is extended again by t3lib_beuserauth which is the actual backend user class that will be instantiated. In fact the two classes t3lib_beuserauth and this class could just as well be one, single class since t3lib_userauthgroup is not - to my knowledge - used separately elsewhere. But for historical reasons they are two separate classes.
t3lib
Contains class for creating XML output from records
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
86: class t3lib_xml 102: function t3lib_xml($topLevelName) 113: function setRecFields($table,$list) 122: function getResult() 132: function WAPHeader() 144: function renderHeader() 155: function renderFooter() 167: function newLevel($name,$beginEndFlag=0,$params=array()) 192: function output($content) 208: function indent($b) 224: function renderRecords($table,$res) 237: function addRecord($table,$row) 255: function getRowInXML($table,$row) 271: function utf8($content) 281: function substNewline($string) 292: function fieldWrap($field,$value) 301: function WAPback() 315: function addLine($str)
TOTAL FUNCTIONS: 17 (This index is automatically created/updated by the extension "extdeveval") XML class, Used to create XML output from input rows. Doesn't contain a lot of advanced features - pretty straight forward, practical stuff You are encouraged to use this class in your own applications.
t3lib
interface for classes which hook into browse_links
t3lib
interface for classes which hook into localRecordList and do additional getTable processing
t3lib
Interface for classes which hook into t3lib_TCEforms_inline.
t3lib
Class for generating a thumbnail from the input parameters given to the script
Input GET var, &file: relative or absolute reference to an imagefile. WILL be validated against PATH_site / lockRootPath Input GET var, &size: integer-values defining size of thumbnail, format '[int]' or '[int]x[int]'
Relative paths MUST BE the first two characters ONLY: eg: '../dir/file.gif', otherwise it is expect to be absolute
t3lib
AJAX dispatcher
Class for generating the click menu
core
Script Class for the Context Sensitive Menu in TYPO3 (rendered in top frame, normally writing content dynamically to list frames).
core
Main script class for the page tree navigation frame
core
Script Class: Drawing the editing form for editing records in TYPO3. Notice: It does NOT use tce_db.php to submit data to, rather it handles submissions itself
core
Script Class for the "No-doc" display; This shows most recently edited records.
core
Main script class for rendering of the folder tree
core
Script Class for the introduction screen, alias "About > Modules" which shows the description of each available module for the user.
core
Script Class for rendering of the main frameset for the TYPO3 backend.
core
Displays the vertical menu in the left most frame of TYPO3s backend
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML-trans compliant
80: class SC_alt_menu 91: function init() 108: function main() 190: function printContent()
TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Script Class for rendering the vertical menu in the left side of the backend frameset
core
Creates the selector-box menu. The selector-box menu is an alternative to the vertical default menu. If configured to appear it will be displayed in the top-frame.
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML compliant
73: class SC_alt_menu_sel 81: function main() 108: function printContent()
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Script Class for rendering the selector box menu
core
Creates the frameset for 'Frameset modules' like Web>* and File>*
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML compliant content (with exception of a few attributes for the <frameset> tags)
63: class SC_alt_mod_frameset 88: function main() 150: function printContent()
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Script Class for rendering the frameset which keeps the navigation and list frames together for socalled "Frameset modules"
core
Class for rendering the form fields. Extending the TCEforms class
core
Child class for alternative rendering of form fields (when the secondary fields are shown in a little window rather than the top bar). (Used if GET var "backRef" is not set, presuming a window is opened instead.)
core
Script Class for rendering the palette form for TCEforms in some other frame (in top frame, horizontally) It can also be called in a pop-up window in which case a vertically oriented set of form fields are rendered instead.
core
Script Class for the shortcut frame, bottom frame of the backend frameset
core
Top logo frame Displays the logo in the top frame (upper left corner)
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML compliant content
66: class SC_alt_toplogo 74: function main() 105: function printContent()
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Script Class for rendering of the logo frame content in upper left corner of the TYPO3 backend frameset
core
Alternative top menu Displays a horizontal menu with the same items as the default left vertical menu in the backend frameset. Only the icons are displayed and linked. Will appear as the default document in the top frame if configured to appear. This is the default menu used during "condensed mode"
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML compliant content
74: class SC_alt_topmenu_dummy 82: function main() 162: function dummyContent() 178: function printContent()
TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Script Class for rendering the topframe dummy view. In the case where TYPO3 backend is configured to show the menu in the top frame this class will render the horizontal line of module icons in the top frame.
core
Class for rendering the TYPO3 backend version 4.2+
core
Script class for the Element Browser window.
core
This is the frameset to the file/record browser window
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj XHTML-frames compatible.
66: class SC_browser 77: function main() 122: function printContent()
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Script Class, putting the frameset together.
core
Displays the page/file tree for browsing database records or files. Used from TCEFORMS an other elements In other words: This is the ELEMENT BROWSER!
Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj XHTML compliant
155: class TBE_browser_recordList extends localRecordList 163: function TBE_browser_recordList () 175: function listURL($altId='',$table=-1,$exclList='') 194: function ext_addP() 211: function linkWrapItems($table,$uid,$code,$row) 244: function linkWrapTable($table,$code)
261: class localPageTree extends t3lib_browseTree 268: function localPageTree() 284: function wrapTitle($title,$v,$ext_pArrPages='') 299: function printTree($treeArr='') 350: function ext_isLinkable($doktype,$uid) 364: function PM_ATagWrap($icon,$cmd,$bMark='') 381: function wrapIcon($icon,$row)
400: class rtePageTree extends localPageTree
417: class TBE_PageTree extends localPageTree 426: function ext_isLinkable($doktype,$uid) 438: function wrapTitle($title,$v,$ext_pArrPages)
464: class localFolderTree extends t3lib_folderTree 473: function localFolderTree() 485: function wrapTitle($title,$v) 500: function ext_isLinkable($v) 517: function PM_ATagWrap($icon,$cmd,$bMark='') 532: function printTree($treeArr='')
599: class rteFolderTree extends localFolderTree
615: class TBE_FolderTree extends localFolderTree 624: function ext_isLinkable($v) 637: function wrapTitle($title,$v)
658: class browse_links 764: function init() 1034: function processSessionData($data)
SECTION: Main functions 1077: function main_rte($wiz=0) 1379: function main_db() 1424: function main_file()
SECTION: Record listing 1534: function expandPage() 1615: function TBE_expandPage($tables)
SECTION: File listing 1708: function expandFolder($expandFolder=0,$extensionList='') 1778: function TBE_expandFolder($expandFolder=0,$extensionList='',$noThumbs=0) 1801: function fileList($files, $folderName='', $noThumbs=0) 1918: function TBE_dragNDrop($expandFolder=0,$extensionList='')
SECTION: Miscellaneous functions 2046: function isWebFolder($folder) 2057: function checkFolder($folder) 2070: function barheader($str) 2087: function getMsgBox($in_msg,$icon='icon_note') 2111: function printCurrentUrl($str) 2131: function parseCurUrl($href,$siteUrl) 2193: function uploadForm($path) 2247: function createFolder($path)
TOTAL FUNCTIONS: 39 (This index is automatically created/updated by the extension "extdeveval") Local version of the record list.
core
Class which generates the page tree
core
Page tree for the RTE - totally the same, no changes needed. (Just for the sake of beauty - or confusion... :-)
core
For TBE record browser
core
Base extension class which generates the folder tree. Used directly by the RTE.
core
Folder tree for the RTE - totally the same, no changes needed. (Just for the sake of beauty - or confusion... :-)
core
For TBE File Browser
core
class for the Element Browser window.
core
Folder navigation tree for the File main module
[CLASS/FUNCTION INDEX of SCRIPT]
71: class fileListTree extends t3lib_browseTree 81: function webPageTree() 92: function wrapIcon($icon,&$row) 130: function wrapStop($str,$row) 146: function wrapTitle($title,$row,$bank=0) 165: function printTree($treeArr = '') 271: function PMicon($row,$a,$c,$nextCount,$exp) 292: function PMiconATagWrap($icon, $cmd, $isExpand = true) 309: function getBrowsableTree() 377: function getTree($uid, $depth=999, $depthData='',$blankLineCode='',$subCSSclass='')
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") Extension class for the t3lib_filetree class, needed for drag and drop and ajax functionality
core
Page navigation tree for the Web module
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML compliant
[CLASS/FUNCTION INDEX of SCRIPT]
71: class webPageTree extends t3lib_browseTree 81: function webPageTree() 92: function wrapIcon($icon,&$row) 130: function wrapStop($str,$row) 146: function wrapTitle($title,$row,$bank=0) 165: function printTree($treeArr = '') 271: function PMicon($row,$a,$c,$nextCount,$exp) 292: function PMiconATagWrap($icon, $cmd, $isExpand = true) 309: function getBrowsableTree() 377: function getTree($uid, $depth=999, $depthData='',$blankLineCode='',$subCSSclass='')
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") Extension class for the t3lib_browsetree class, specially made for browsing pages in the Web module
core
class to render the backend search toolbar item menu
core
class to render the menu for the cache clearing actions
core
class to render the TYPO3 backend menu for the modules
core
class to render the shortcut menu
core
class to hold all the information about an AJAX call and send the right headers for the request type
core
class to render the TYPO3 logo in the backend
core
class to render the workspace selector
core
Script Class for the Web > List module; rendering the listing of records on a page
core
Extension for the tree class that generates the tree of pages in the page-wizard mode
core
Script class for 'db_new'
core
Dummy document - displays nothing but background color.
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML compliant content
68: class SC_dummy 76: function main() 92: function printContent()
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Script Class, creating the content for the dummy script - which is just blank output.
core
Script Class for rendering the file editing screen
core
Script Class for creating the list of files in the File > Filelist module
core
Script Class for the create-new script; Displays a form for creating up to 10 folders or one new text file
core
Script Class for the rename-file form.
core
Script Class for display up to 10 upload fields
core
Script Class for rendering the login form
core
Apache-trailing-slash workaround
Meant to solve the trailing slash problem with Apache:
Make a mod_rewrite rule like this: RewriteRule ^typo3$ typo3/index_re.php ... and this document will redirect to the right script.
core
TYPO3 Backend initialization
This script is called by every backend script. The script authenticates the backend user. In addition this script also initializes the database and other stuff by including the script localconf.php
IMPORTANT: This script exits if no user is logged in! If you want the script to return even if no user is logged in, you must define the constant TYPO3_PROCEED_IF_NO_USER=1 before you include this script.
This script does the following:
For a detailed description of this script, the scope of constants and variables in it, please refer to the document "Inside TYPO3"
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
core
Starter-script for install screen
core
interface for classes which extend the backend by adding items to the top toolbar
t3lib
interface for classes which hook into localRecordList and modify clip-icons
t3lib
Redirects to real module if shortcut pressed
Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj XHTML-trans compliant
68: class SC_listframe_loader 75: function main()
TOTAL FUNCTIONS: 1 (This index is automatically created/updated by the extension "extdeveval") Script Class for redirecting shortcut actions to the correct script
core
Login frameset
This script generates a login-frameset used when the user must relogin. Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj XHTML-frames compatible.
core
Script Class, putting the frameset together.
core
Logo menu
core
Logout script for the backend This script saves the interface positions and calls the closeTypo3Windows in the frameset
62: class SC_logout 69: function logout()
TOTAL FUNCTIONS: 1 (This index is automatically created/updated by the extension "extdeveval") Script Class for logging a user out. Does not display any content, just calls the logout-function for the current user and then makes a redirect.
core
Script Class for the Help > About module
core
Module: Extension manager
core
TER2 connection handling class for the TYPO3 Extension Manager.
It contains methods for downloading and uploading extensions and related code
EM
XML handling class for the TYPO3 Extension Manager.
It contains methods for handling the XML files involved with the EM, such as the list of extension mirrors and the list of available extensions.
EM
Library with Workspace related functionality
68: class wslib 81: function getCmdArrayForPublishWS($wsid, $doSwap,$pageId=0) 127: function selectVersionsInWorkspace($wsid,$filter=0,$stage=-99,$pageId=-1)
SECTION: CLI functions 183: function CLI_main() 193: function autoPublishWorkspaces()
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Library with Workspace related functionality
core
Library with Workspace GUI related functionality. It is used by main workspace module but also can be used from extensions. Originally 99.9%% of the code was written by Kasper and only transfered here by Dmitry.
core
Module: Workspace manager
core
Module: Workspace forms for editing/creating workspaces.
core
Workspace dual preview NOTICE: In this module you HAVE to check if a backend user is actually logged in if you perform operations that require a login! See function ->isBeLogin()
core
Script Class for the Web > Functions module This class creates the framework to which other extensions can connect their sub-modules
core
Script Class for the Web > Info module This class creates the framework to which other extensions can connect their sub-modules
core
This class extends the permissions module in the TYPO3 Backend to provide convenient methods of editing of page permissions (including page ownership (user and group)) via new TYPO3AJAX facility
core GPL
Module: Permission setting
Script Class for the Web > Access module This module lets you view and change permissions for pages.
Variables: $this->MOD_SETTINGS['depth']: intval 1-3: decides the depth of the list $this->MOD_SETTINGS['mode']: 'perms' / '': decides if we view a user-overview or the permissions.
core
Local extension of the page tree class
core
Extension of position map for pages
core
Extension of position map for content elements
core
Script Class for rendering the move-element wizard display
core
Extension of transfer data class
core
Script Class for showing information about an item.
core
Script Class for showing the history module of TYPO3s backend
core
TCE gateway (TYPO3 Core Engine) for database handling This script is a gateway for POST forms to class.t3lib_TCEmain that manipulates all information in the database!! For syntax and API information, see the document 'TYPO3 Core APIs'
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
78: class SC_tce_db 106: function init() 162: function initClipboard() 182: function main() 218: function finish()
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Script Class, creating object of t3lib_TCEmain and sending the posted data to the object. Used by many smaller forms/links in TYPO3, including the QuickEdit module. Is not used by alt_doc.php though (main form rendering script) - that uses the same class (TCEmain) but makes its own initialization (to save the redirect request). For all other cases than alt_doc.php it is recommended to use this script for submitting your editing forms - but the best solution in any case would probably be to link your application to alt_doc.php, that will give you easy form-rendering as well.
core
Gateway for TCE (TYPO3 Core Engine) file-handling through POST forms. This script serves as the fileadministration part of the TYPO3 Core Engine. Basically it includes two libraries which are used to manipulate files on the server.
For syntax and API information, see the document 'TYPO3 Core APIs'
Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
77: class SC_tce_file 97: function init() 117: function initClipboard() 138: function main() 164: function finish()
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Script Class, handling the calling of methods in the file admin classes.
core
TYPO3 Backend Template Class
This class contains functions for starting and ending the HTML of backend modules It also contains methods for outputting sections of content. Further there are functions for making icons, links, setting form-field widths etc. Color scheme and stylesheet definitions are also available here. Finally this file includes the language class for TYPO3's backend.
After this file $LANG and $TBE_TEMPLATE are global variables / instances of their respective classes. This file is typically included right after the init.php file, if language and layout is needed.
Please refer to Inside TYPO3 for a discussion of how to use this API.
core
Extension of the parse_html class.
core
Script Class for rendering the Context Sensitive Help documents, either the single display in the small pop-up window or the full-table view in the larger window.
core
Script Class for adding new items to a group/select field. Performs proper redirection as needed.
core
Script Class for colorpicker wizard
core
Script Class for redirecting a backend user to the editing form when an "Edit wizard" link was clicked in TCEforms somewhere
core
API comments:
The form wizard can help you to create forms - it allows you to create almost any kind of HTML form elements and in any order and amount.
The format for the resulting configuration code can be either a line-based configuration. That can look like this:
Your name: | *name=input | (input your name here!) Your Email: | *email=input Your address: | address=textarea,40,10 Your Haircolor: | hair=radio | upload | attachment=file | quoted_printable=hidden | 0 | formtype_mail=submit | Send form | html_enabled=hidden | subject=hidden | This is the subject
Alternatively it can be XML. The same configuration from above looks like this in XML:
<T3FormWizard> <n2> <type>input</type> <label>Your name:</label> <required>1</required> <fieldname>name</fieldname> <size></size> <max></max> <default>(input your name here!)</default> </n2> <n4> <type>input</type> <label>Your Email:</label> <required>1</required> <fieldname>email</fieldname> <size></size> <max></max> <default></default> </n4> <n6> <type>textarea</type> <label>Your address:</label> <fieldname>address</fieldname> <cols>40</cols> <rows>10</rows> <default></default> </n6> <n8> <type>radio</type> <label>Your Haircolor:</label> <fieldname>hair</fieldname> <options></options> </n8> <n10> <type>file</type> <label>upload</label> <fieldname>attachment</fieldname> <size></size> </n10> <n12> <type>hidden</type> <label></label> <fieldname>quoted_printable</fieldname> <default>0</default> </n12> <n2000> <fieldname>formtype_mail</fieldname> <type>submit</type> <default>Send form</default> </n2000> <n2002> <fieldname>html_enabled</fieldname> <type>hidden</type> </n2002> <n2004> <fieldname>subject</fieldname> <type>hidden</type> <default>This is the subject</default> </n2004> <n20> <content></content> </n20> </T3FormWizard>
The XML/phpArray structure is the internal format of the wizard. Script Class for rendering the Form Wizard
core
Script Class for redirecting the user to the Web > List module if a wizard-link has been clicked in TCEforms
core
Script Class for rendering the full screen RTE display
core
Script Class for rendering the Table Wizard
core
TypoScript parser extension class.
core
Script Class for rendering the TSconfig/TypoScript property browser.
core
1.6.1
