|
TYPO3 API
SVNRelease
|
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
An abstract caching backend
This file is a backport from FLOW3
A caching backend which stores cache entries by using APC.
This backend uses the following types of keys:
Each key is prepended with a prefix. By default prefix consists from two parts separated by underscore character and ends in yet another underscore character:
This file is a backport from FLOW3
A caching backend which stores cache entries in database tables
A caching backend which stores cache entries in files
This file is a backport from FLOW3
A caching backend which stores cache entries by using Memcached.
This backend uses the following types of Memcache keys:
Each key is prepended with a prefix. By default prefix consists from two parts separated by underscore character and ends in yet another underscore character:
Note: When using the Memcached backend to store values of more than ~1 MB, the data will be split into chunks to make them fit into the memcached limits.
This file is a backport from FLOW3 by Ingo Renner.
A caching backend which forgets everything immediately
This file is a backport from FLOW3
A PDO database cache backend
t3lib_cache prototype
A caching backend which stores cache entries by using Redis with phpredis PHP module. Redis is a noSQL database with very good scaling characteristics in proportion to the amount of entries and data size.
Warning: Redis and phpredis are young projects with very high development speed. This implementation should be considered as experimental for now, internals might break or change while the dependent projects mature.
Successfully tested with:
Implementation based on ext:rediscache by Christopher Hlubek - networkteam GmbH
This backend uses the following types of redis keys:
Each cache using this backend should use an own redis database to avoid namespace problems. By default redis has 16 databases which are identified with numbers 0 .. 15. setDatabase() can be used to select one. The unit tests use and flush database numbers 0 and 1, production use should start from 2.
t3lib_cache prototype
A caching backend which stores cache entries during one script run.
This file is a backport from FLOW3
interface for a Cache Backend
t3lib
A generic Cache exception
This file is a backport from FLOW3
This cache factory takes care of instantiating a cache frontend and injecting a certain cache backend. After creation of the new cache, the cache object is registered at the cache manager.
This file is a backport from FLOW3
The Cache Manager
This file is a backport from FLOW3
A "Class Already Loaded" exception
This file is a backport from FLOW3
A "Duplicate Identifier" exception
This file is a backport from FLOW3
An "Invalid Backend" exception
This file is a backport from FLOW3
An "Invalid Cache" exception
This file is a backport from FLOW3
An "Invalid Data" exception
This file is a backport from FLOW3
A "No Such Cache" exception
This file is a backport from FLOW3
An abstract cache
This file is a backport from FLOW3
A cache frontend tailored to PHP code.
This file is a backport from FLOW3
t3lib_cache prototype
A cache frontend for strings. Nothing else.
This file is a backport from FLOW3
A cache for any kinds of PHP variables
This file is a backport from FLOW3
interface for a Cache Frontend
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 Skårhøj 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 Skårhøj 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 Skårhøj
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 Skårhøj 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_BEfunc::getRecord('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 Skårhøj 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)
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='',$additionalGetVars='',$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 Skårhøj
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 Skårhøj
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
A cache handling helper class
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 Skårhøj 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
Compressor This merges and compresses CSS and JavaScript files of the TYPO3 Backend.
t3lib $Id$
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 Skårhøj 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
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_div::milliseconds()'
t3lib
An exception
t3lib_error
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 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 Skårhøj
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 Skårhøj
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 Skårhøj
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:
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
A class representing flash messages.
t3lib
A class which collects and renders flash messages.
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 Skårhøj
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 Skårhøj
69: class t3lib_formmail 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
Controller class for frontend editing.
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 Skårhøj 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 Skårhøj
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 René Fritz, 2001 Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
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
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, // $GLOBALS['EXEC_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 Skårhøj 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) 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
TYPO3 pageRender class (new in TYPO3 4.3.0) This class render the HTML of a webpage, usable for BE and FE
t3lib
Generate a page-tree, non-browsable.
Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
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 Skårhøj
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=TAB) 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 Skårhøj 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
A helper class for handling PDO databases Backport of FLOW3 class PdoHelper, last synced version: 3528
t3lib
Contains class for creating a position map.
Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj 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 Skårhøj
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 Skårhøj 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
A class to store and retrieve entries in a registry database table.
The intention is to have a place where we can store things (mainly settings) that should live for more than one request, longer than a session, and that shouldn't expire like it would with a cache. You can actually think of it being like the Windows Registry in some ways.
Credits: Heavily inspired by Drupal's variable_*() functions.
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 Skårhøj
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'); $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') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/prototype/index.php'])) { include_once($GLOBALS['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
TYPO3 sprite manager, used in BE and in FE if a BE user is logged in.
This class builds CSS definitions of registered icons, writes TCA definitions and registers sprite icons in a cache file.
A configurable handler class does the business task.
t3lib
PHP SQL engine EXPERIMENTAL!
[CLASS/FUNCTION INDEX of SCRIPT]
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 Skårhøj
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
With TYPO3 4.4 GDlib 1.x support was dropped, also an option from config_default.php: $TYPO3_CONF_VARS['GFX']['gdlib_2'] = 0, // String/Boolean. Set this if you are using the new GDlib 2.0.1+. If you don't set this flag and still use GDlib2, you might encounter strange behaviours like black images etc. This feature might take effect only if ImageMagick is installed and working as well! You can also use the value "no_imagecopyresized_fix" - in that case it will NOT try to fix a known issue where "imagecopyresized" does not work correctly.
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 Skårhøj 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 Skårhøj
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 Skårhøj 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
A fake time tracker that does nothing but providing the methods of the real time tracker. This is done to save some performance over the real time tracker.
t3lib
Contains class for getting and transforming data for display in backend forms (TCEforms)
Revised for TYPO3 3.6 September/2003 by Kasper Skårhøj
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 Skårhøj
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 Skårhøj 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 Skårhøj
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, $cycle_counter=1, $returnFiles=false) 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 Skårhøj
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 Skårhøj
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 Skårhøj
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 Skårhøj
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
Abstract Context Menu
t3lib
Abstract Context Menu Data Provider
t3lib
Context Menu Action
t3lib
Context Menu Action Collection
t3lib
Abstract Context Menu for ExtDirect
This is a concrete implementation that should stay here to be shared between the different ExtDirect implementation. Just create a subclass for adding specific purposes.
t3lib
Context Menu Data Provider for the Page Tree
t3lib
Context Menu of the Page Tree
t3lib
Abstract Context Menu Renderer
t3lib
TYPO3 prepared statement for t3lib_db class.
USE: In all TYPO3 scripts when you need to create a prepared query: $statement = $GLOBALS['TYPO3_DB']->prepare_SELECTquery('*', 'pages', 'uid = :uid'); $statement->execute(array(':uid' => 2)); while (($row = $statement->fetch()) !== FALSE) { // ... } $statement->free();
t3lib
An abstract exception handler
This file is a backport from FLOW3
t3lib_error
A basic but solid exception handler which catches everything which falls through the other exception handlers and provides useful debugging information.
This file is a backport from FLOW3
t3lib_error
Global error handler for TYPO3
This file is a backport from FLOW3
t3lib_error
An exception which represents a PHP error.
This file is a backport from FLOW3
t3lib_error
A quite exception handler which catches but ignores any exception.
This file is a backport from FLOW3
t3lib_error
Error handler interface for TYPO3
This file is a backport from FLOW3
t3lib_error
Contract for an exception handler
This file is a backport from FLOW3
t3lib_error
Ext Direct API Generator
Ext Direct Debug
Ext Direct Router
ExtDirect Class for handling backend live search.
t3lib
Class t3lib_formprotection_Abstract.
This class provides protection against cross-site request forgery (XSRF/CSRF) for forms.
For documentation on how to use this class, please see the documentation of the corresponding subclasses, e.g. t3lib_formprotection_BackendFormProtection.
$Id$
t3lib
Class t3lib_formprotection_BackendFormProtection.
This class provides protection against cross-site request forgery (XSRF/CSRF) for forms in the BE.
How to use:
For each form in the BE (or link that changes some data), create a token and insert is as a hidden form element. The name of the form element does not matter; you only need it to get the form token for verifying it.
$formToken = t3lib_formprotection_Factory::get( t3lib_formprotection_Factory::TYPE_BACK_END )->generateToken( 'BE user setup', 'edit' ); $this->content .= '<input type="hidden" name="formToken" value="' . $formToken . '">';
The three parameters $formName, $action and $formInstanceName can be arbitrary strings, but they should make the form token as specific as possible. For different forms (e.g. BE user setup and editing a tt_content record) or different records (with different UIDs) from the same table, those values should be different.
For editing a tt_content record, the call could look like this:
$formToken = t3lib_formprotection_Factory::get( t3lib_formprotection_Factory::TYPE_BACK_END )->getFormProtection()->generateToken( 'tt_content', 'edit', $uid );
At the end of the form, you need to persist the tokens. This makes sure that generated tokens get saved, and also that removed tokens stay removed:
t3lib_formprotection_Factory::get( t3lib_formprotection_Factory::TYPE_BACK_END )->persistTokens();
In BE lists, it might be necessary to generate hundreds of tokens. So the tokens do not get automatically persisted after creation for performance reasons.
When processing the data that has been submitted by the form, you can check that the form token is valid like this:
if ($dataHasBeenSubmitted && t3lib_formprotection_Factory::get( t3lib_formprotection_Factory::TYPE_BACK_END )->validateToken( (string) t3lib_div::_POST('formToken'), 'BE user setup', 'edit ) ) { // processes the data } else { // no need to do anything here as the BE form protection will create a // flash message for an invalid token }
Note that validateToken invalidates the token with the token ID. So calling validate with the same parameters two times in a row will always return FALSE for the second call.
It is important that the tokens get validated before the tokens are persisted. This makes sure that the tokens that get invalidated by validateToken cannot be used again.
$Id$
t3lib
Class t3lib_formprotection_DisabledFormProtection.
This class is a dummy implementation of the form protection, which is used when no authentication is used.
$Id$
t3lib
Class t3lib_formprotection_Factory.
This class creates and manages instances of the various form protection classes.
This class provides only static methods. It can not be instantiated.
Usage for the back-end form protection:
$formProtection = t3lib_formprotection_Factory::get( 't3lib_formProtection_BackEnd' );
Usage for the install tool form protection:
$formProtection = t3lib_formprotection_Factory::get( 'tx_install_formprotection' ); $formProtection->injectInstallTool($this);
$Id$
t3lib
Class t3lib_formprotection_InstallToolFormProtection.
This class provides protection against cross-site request forgery (XSRF/CSRF) in the install tool.
How to use this in the install tool:
For each form in the install tool (or link that changes some data), create a token and insert is as a hidden form element. The name of the form element does not matter; you only need it to get the form token for verifying it.
$formToken = $this->formProtection->generateToken( 'installToolPassword', 'change' ); // then puts the generated form token in a hidden field in the template
The three parameters $formName, $action and $formInstanceName can be arbitrary strings, but they should make the form token as specific as possible. For different forms (e.g. the password change and editing a the configuration), those values should be different.
At the end of the form, you need to persist the tokens. This makes sure that generated tokens get saved, and also that removed tokens stay removed:
$this->formProtection()->persistTokens();
When processing the data that has been submitted by the form, you can check that the form token is valid like this:
if ($dataHasBeenSubmitted && $this->formProtection()->validateToken(
(string) $_POST['formToken'],
'installToolPassword',
'change'
) {
// processes the data
} else {
// no need to do anything here as the install tool form protection will
// create an error message for an invalid token
}
Note that validateToken invalidates the token with the token ID. So calling validate with the same parameters two times in a row will always return FALSE for the second call.
It is important that the tokens get validated before the tokens are persisted. This makes sure that the tokens that get invalidated by validateToken cannot be used again.
$Id$
t3lib
Invalid token exception
t3lib_formprotection
interface for classes which hook into browse_links
t3lib
Interface for classes which hook into extFileFunctions and do additional processData processing.
t3lib
interface for classes which hook into localRecordList and do additional getTable processing
t3lib
Mailer Adapter interface
t3lib
Interface for classes which hook into pageSelect and do additional getPage processing
t3lib
interface for classes which hook into t3lib_pageSelect
t3lib
"empty" interface for singletons (marker interface pattern)
t3lib
Interface all handlers in t3lib_spritemanager have to implement.
t3lib
Interface for classes which hook into t3lib_TCEforms and do additional dbFileIcons processing
t3lib
Interface for classes which hook into t3lib_TCEforms_inline.
t3lib
Interface for hook in t3lib_TCEmain::checkModifyAccessList
t3lib
Interface for classes which hook into TCEmain and do additional processing after the upload of a file.
t3lib
Interface that defines the comparison of nodes
t3lib
Describes necessary methods if the nodes are draggable and dropable within the tree.
t3lib
Describes necessary methods if the node label should be editable within the tree.
t3lib
Adapter for Swift_Mailer to be used by TYPO3 extensions.
This will use the setting in TYPO3_CONF_VARS to choose the correct transport for it to work out-of-the-box.
$Id$
t3lib
Adapter for Swift_Mailer to be used by TYPO3 extensions
$Id$
t3lib
Hook subscriber for using Swift Mailer with the t3lib_utility_mail function
$Id$
t3lib
Matching TypoScript conditions
Used with the TypoScript parser. Matches browserinfo, IPnumbers for use with templates
t3lib
Matching TypoScript conditions for backend disposal.
Used with the TypoScript parser. Matches browserinfo, IPnumbers for use with templates
t3lib
Matching TypoScript conditions for frontend disposal.
Used with the TypoScript parser. Matches browserinfo, IPnumbers for use with templates
t3lib
A class used for any kind of messages.
t3lib/message
A class representing error messages shown on a page. Classic Example: "No pages are found on rootlevel"
t3lib/message
Class for handling backend live search.
t3lib
Class for parsing query parameters in backend live search.
t3lib
An abstract class implementing t3lib_spritemanager_SpriteIconGenerator. Provides base functionality for all handlers.
t3lib
A class with an concrete implementation of t3lib_spritemanager_SpriteIconGenerator. It is the standard / fallback handler of the sprite manager. This implementation won't generate sprites at all. It will just render css-definitions for all registered icons so that they may be used through t3lib_iconWorks::getSpriteIcon* Without the css classes generated here, icons of for example tca records would be empty.
t3lib
t3lib
sprite generator
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
Abstract Tree Data Provider
t3lib
Abstract State Provider
This class is incomplete, because the methods still need some variables or other state object
t3lib
Abstract Tree
t3lib
Tree Node
t3lib
Tree Node Collection
t3lib
Representation Tree Node
t3lib
Sorted Tree Node Collection
Note: This collection works only with integers as offset keys and not with much datasets. You have been warned!
t3lib
Abstract ExtJS tree based on ExtDirect
t3lib
Node for the usage with ExtDirect and ExtJS
t3lib
Page Tree and Context Menu Commands
t3lib
Abstract Tree Data Provider
t3lib
Class for pagetree indicator
t3lib
Node designated for the page tree
t3lib
Tree Node Collection
t3lib
Commands for the Page tree
t3lib
Data Provider of the Page Tree
t3lib
Interface for classes which provide a pagetree indicator.
t3lib
Abstract Renderer
t3lib
Renderer for unordered lists
t3lib
Renderer for unordered lists
t3lib
An abstract TCA tree data provider
t3lib_tree
Represents a node in a TCA database setup
t3lib_tree
TCA tree data provider
t3lib_tree
Builds a t3lib_tree_Tca_DatabaseTreeDataProvider object based on some TCA configuration
t3lib_tree
Renders a tca tree array for ExtJS
t3lib_tree
Class for tca tree
t3lib_tree
Class to handle debug
t3lib
HTTP Utility class
t3lib
Class to handle mail specific functionality
t3lib
Class to handle php environment specific options / functions
$Id$
t3lib
Testcase for class RemoveXSS
contrib @ see http://ha.ckers.org/xss.html @ examples from http://ha.ckers.org/xssAttacks.xml
A caching backend which forgets everything immediately Used in t3lib_cache_FactoryTestCase
This file is a backport from FLOW3
tests
Testcase for the abstract cache backend
This file is a backport from FLOW3
tests
Testcase for the APC cache backend
This file is a backport from FLOW3
tests
Testcase for the DB cache backend
tests
Testcase for the File cache backend
This file is a backport from FLOW3
tests
Testcase for the cache to memcached backend
This file is a backport from FLOW3
tests
Testcase for the PDO cache backend
tests
Testcase for the cache to redis backend
This class has functional tests as well as implementation tests:
Warning: The unit tests use and flush redis database numbers 0 and 1!
tests
Testcase for the TransientMemory cache backend
This file is a backport from FLOW3
tests
Testcase for the abstract cache frontend
This file is a backport from FLOW3
tests
Testcase for the PHP source code cache frontend
This file is a backport from FLOW3
tests
Testcase for the string cache frontend
This file is a backport from FLOW3
tests
Testcase for the variable cache frontend
This file is a backport from FLOW3
tests
Testcase for the Cache Factory
This file is a backport from FLOW3
tests
Testcase for the Cache Manager
This file is a backport from FLOW3
tests
Test case for basic core related constants in config_default.php
Testcase for the prepared statement database class
tests
Class t3lib_formProtection_Testing.
This is a testing subclass of the abstract t3lib_formprotection_Abstract class.
$Id$
t3lib
Testcase for the t3lib_formprotection_Abstract class.
$Id$
t3lib
Testcase for the t3lib_formprotection_BackendFormProtection class.
$Id$
t3lib
Testcase for the t3lib_formprotection_Factory class.
$Id$
t3lib
Testcase for the t3lib_formprotection_InstallToolFormProtection class.
$Id$
t3lib
Testcase for the t3lib_mail_SwiftMailerAdapter class.
t3lib
Testcase for class t3lib_matchCondition_frontend.
t3lib
Testcase for the t3lib_arrayBrowser class in the TYPO3 Core.
t3lib
Testcase for the t3lib_BEfunc class in the TYPO3 core.
t3lib
Testcase for the t3lib_beUserAuth class in the TYPO3 Core extension.
t3lib
Testcase for the t3lib_cs class in the TYPO3 Core.
t3lib
Testcase for the t3lib_db class in the TYPO3 Core.
t3lib
Testcase for class t3lib_div
t3lib
Testcase for class t3lib_extMgm
t3lib
Testcase for class t3lib_htmlmail
t3lib
Testcase for class t3lib_iconWorks.
t3lib
Testcase for t3lib_lock
t3lib
Testcase for the t3lib_PageRenderer class in the TYPO3 core.
t3lib
Testcase for class t3lib_page
t3lib
Testcase for class t3lib_Registry
t3lib
Testcase for class t3lib_SpriteManager.
t3lib
Testcase for the t3lib_TCEmain class in the TYPO3 core.
t3lib
Testcase for class t3lib_tree_NodeCollection.
t3lib
Testcase for class t3lib_tree_Node.
t3lib
Testcase for class t3lib_tree_SortedNodeCollection.
t3lib
Testcase for the t3lib_utility_Client class.
t3lib
Testcase for the t3lib_utility_Mail class.
t3lib
Testcase for the "tslib_cObj" class in the TYPO3 Core.
tslib
Testcase for the "tslib_fe" class in the TYPO3 Core.
tslib
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 the vertical menu in the left side of the backend frameset
core
Script Class for rendering the selector box menu
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
Script Class for rendering of the logo frame content in upper left corner of the TYPO3 backend frameset
core
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 Skårhøj 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
Class for generation of the module menu. Will make the vertical, horizontal, selectorbox based menus AND the "about modules" display. Basically it traverses the module structure and generates output based on that.
Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj XHTML compliant content
73: class alt_menu_functions 94: function topMenu($theModules,$dontLink=0,$backPath='',$descr=0) 473: function getNavFramePrefix($moduleInfo, $subModuleInfo=array()) 504: function mIconFile($Ifilename,$backPath) 519: function mIconFilename($Ifilename,$backPath) 531: function topButtons() 544: function adminButtons() 563: function adminFunctions($backPath) 596: function wrapLinkWithAB($link)
TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Class with menu functions
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 Skårhøj 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
Include file extending t3lib_recordList Shared between Web>List (db_list.php) and Web>Page (sysext/cms/layout/db_layout.php)
Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj XHTML compliant
86: class recordList extends t3lib_recordList 148: function start($id,$table,$pointer,$search="",$levels="",$showLimit=0) 211: function generateList() 275: function getSearchBox($formFields=1) 319: function showSysNotesForPage()
SECTION: Various helper functions 396: function setDispFields() 421: function thumbCode($row,$table,$field) 434: function makeQueryArray($table, $id, $addWhere="",$fieldList='*') 481: function setTotalItems($queryParts) 497: function makeSearchString($table) 536: function linkWrapTable($table,$code) 553: function linkWrapItems($table,$uid,$code,$row) 617: function linkUrlMail($code,$testString) 644: function listURL($altId='',$table=-1,$exclList='') 663: function requestUri() 674: function makeFieldList($table,$dontCheckUser=0) 721: function getTreeObject($id,$depth,$perms_clause) 739: function localizationRedirect($justLocalized)
TOTAL FUNCTIONS: 17 (This index is automatically created/updated by the extension "extdeveval") Child class for rendering of Web > List (not the final class. see class.db_list_extra)
core
Include file extending recordList which extended t3lib_recordList Used specifically for the Web>List module (db_list.php)
Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj XHTML compliant
91: class localRecordList extends recordList 123: function writeTop($row) 304: function getTable($table,$id,$rowlist) 559: function renderListRow($table,$row,$cc,$titleCol,$thumbsCol,$indent=0) 648: function renderListHeader($table,$currentIdList)
SECTION: Rendering of various elements 796: function makeControl($table,$row) 986: function makeClip($table,$row) 1057: function makeRef($table,$uid) 1086: function makeLocalizationPanel($table,$row) 1148: function fieldSelectBox($table,$formFields=1)
SECTION: Helper functions 1231: function linkClipboardHeaderIcon($string,$table,$cmd,$warning='') 1242: function clipNumPane() 1256: function addSortLink($code,$field,$table) 1281: function recPath($pid) 1294: function showNewRecLink($table) 1304: function makeReturnUrl()
SECTION: CSV related functions 1329: function initCSV() 1352: function addToCSV($row,$table) 1376: function setCsvRow($csvRow) 1387: function outputCSV($prefix)
TOTAL FUNCTIONS: 19 (This index is automatically created/updated by the extension "extdeveval") Class for rendering of Web>List module
core
Include file extending t3lib_recordList
Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj
75: class fileList extends t3lib_recordList 112: function start($path,$pointer,$sort,$sortRev,$clipBoard=0) 133: function generateList() 146: function writeTop($path) 204: function linkClipboardHeaderIcon($string,$table,$cmd,$warning='') 218: function getTable($files,$dirs,$rowlist) 306: function formatDirList($items) 372: function linkWrapDir($code,$path) 391: function linkWrapFile($code,$path) 406: function listURL() 416: function dirData($theFile) 441: function formatFileList($items) 518: function isImage($ext) 530: function linkWrapSort($code,$path,$col) 548: function readDirectory($path,$type,$extList='') 602: function makeClip($theData) 647: function makeRef($theData)
TOTAL FUNCTIONS: 16 (This index is automatically created/updated by the extension "extdeveval") Class for rendering of File>Filelist
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
Class for the record history display script (show_rechis.php)
XHTML Compliant
core
Page navigation tree for the Web module
Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj 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 menu for the cache clearing actions
core
Adds backend live search. to the toolbar
t3lib
class to render the TYPO3 backend menu for the modules
core
class to render the shortcut menu
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. Before TYPO3 4.3, it was located in typo3/tce_file.php and redirected back to a $redirectURL. Since 4.3 this class is also used for accessing via AJAX
For syntax and API information, see the document 'TYPO3 Core APIs'
Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj Revised for TYPO3 4.3 Mar/2009 by Benjamin Mack
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
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 Skårhøj 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 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 Skårhøj
core
Starter-script for install screen
core
interface for classes which hook into ClearCacheMenu and manipulate CacheMenuItems array
backend
interface for classes which extend the backend by adding items to the top toolbar
t3lib
interface for classes which hook into SC_db_new_content_el and manipulater wizardItems array
cms
interface for classes which hook into file list module and manipulateds edit icon array
cms
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 Skårhøj 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 Skårhøj 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
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
Module: About This document shows some standard-information for TYPO3 CMS: About-text, version number and so on.
Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj XHTML compliant
Script Class for the Help > About module
core
Extension classes for log display in Web > Info and Tools > Log modules
65: class logFunctions_ext extends t3lib_BEDisplayLog 72: function initArray()
97: class tx_belog_webinfo extends t3lib_extobjbase 105: function modMenu() 136: function localLang() 147: function main()
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Extending for Tools > Log. Just setting labels correctly
tx_belog
Extending for Web>Info
tx_belog
Tools log script class
tx_belog
Class, adding SU link to context menu
Base Extension class for printing a page tree (non-browsable though)
Extension class for printing a page tree: All pages of a mount point.
Extension class for printing a page tree: Printing all pages, with permissions.
Base Extension class for printing a folder tree (non-browsable though)
Extension class for printing a folder tree: All folders
Extension class of beuserauth class.
Main script class
Include file extending db_list.inc for use with the web_layout module
Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj XHTML compliant
115: class tx_cms_layout extends recordList
SECTION: Renderings 180: function getTable($table,$id) 240: function getTable_pages($id) 378: function getTable_tt_content($id) 754: function getTable_fe_users($id) 780: function getTable_sys_note($id) 873: function getTable_tt_board($id) 955: function getTable_tt_address($id) 985: function getTable_tt_links($id) 1011: function getTable_tt_guest($id) 1026: function getTable_tt_news($id) 1047: function getTable_tt_calender($id) 1097: function getTable_tt_products($id)
SECTION: Generic listing of items 1143: function makeOrdinaryList($table, $id, $fList, $icon=0, $addWhere='') 1224: function dataFields($fieldArr,$table,$row,$out=array()) 1275: function headerFields($fieldArr,$table,$out=array())
SECTION: Additional functions; Pages 1317: function pages_getTree($theRows,$pid,$qWhere,$treeIcons,$depth) 1350: function pages_drawItem($row,$fieldArr)
SECTION: Additional functions; Content Elements 1461: function tt_content_drawColHeader($colName,$editParams,$newParams) 1513: function tt_content_drawHeader($row,$space=0,$disableMoveAndNewButtons=FALSE,$langMode=FALSE) 1643: function tt_content_drawItem($row, $isRTE=FALSE) 1806: function getNonTranslatedTTcontentUids($defLanguageCount,$id,$lP) 1836: function newLanguageButton($defLanguageCount,$lP) 1857: function infoGif($infoArr) 1873: function newContentElementOnClick($id,$colPos,$sys_language) 1891: function linkEditContent($str,$row) 1909: function linkRTEbutton($row) 1930: function languageSelector($id) 1967: function getResult($result)
SECTION: Additional functions; Message board items (tt_board) 2036: function tt_board_getTree($theRows,$parent,$pid,$qWhere,$treeIcons) 2071: function tt_board_drawItem($table,$row,$re)
SECTION: Various helper functions 2118: function numberOfRecords($table,$pid) 2137: function renderText($input) 2151: function getIcon($table,$row) 2174: function getProcessedValue($table,$fieldList,$row,&$info) 2194: function isDisabled($table,$row) 2212: function wordWrapper($content,$max=50,$char=' -') 2229: function noEditIcon($label='noEditItems') 2238: function cleanTableNames() 2274: function isRTEforField($table,$row,$field) 2304: function getSpecConfForField($table,$row,$field)
SECTION: External renderings 2341: function getPageInfoBox($rec,$edit=0) 2510: function getTableMenu($id) 2575: function strip_tags($content, $fillEmptyContent=false)
TOTAL FUNCTIONS: 43 (This index is automatically created/updated by the extension "extdeveval") Child class for the Web > Page module
core
Local extension of position map class
core
Script Class for Web > Layout module
core
Local position map class
core
Script Class for the New Content element wizard
core
Interface for classes which hook into tx_cms_layout and do additional tt_content_drawItem processing.
cms
Script Class for grid wizard
core
View class for the admin panel in frontend editing.
tslib
Contains classes for Content Rendering based on TypoScript Template configuration
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
class tslib_cObj : All main TypoScript features, rendering of content objects (cObjects). This class is the backbone of TypoScript Template rendering. class tslib_controlTable : Makes a table CTABLE (TS cObject) class tslib_tableOffset : Makes a table-offset (TS) class tslib_frameset : Generates framesets (TS)
256: class tslib_cObj 353: function start($data,$table='') 387: function setParent($data,$currentRecord)
SECTION: CONTENT_OBJ: 412: function getCurrentVal() 423: function setCurrentVal($value) 436: function cObjGet($setup,$addKey='') 460: function cObjGetSingle($name,$conf,$TSkey='__')
SECTION: Functions rendering content objects (cObjects) 629: function HTML($conf) 640: function TEXT($conf) 651: function CLEARGIF($conf) 670: function COBJ_ARRAY($conf,$ext='') 706: function USER($conf,$ext='') 733: function FILE($conf) 749: function IMAGE($conf) 768: function IMG_RESOURCE($conf) 780: function IMGTEXT($conf) 1203: function CONTENT($conf) 1290: function RECORDS($conf) 1370: function HMENU($conf) 1402: function CTABLE ($conf) 1440: function OTABLE ($conf) 1455: function COLUMNS ($conf) 1534: function HRULER ($conf) 1559: function CASEFUNC ($conf) 1584: function LOAD_REGISTER($conf,$name) 1624: function FORM($conf,$formData='') 2145: function SEARCHRESULT($conf) 2311: function PHP_SCRIPT($conf,$ext='') 2354: function TEMPLATE($conf) 2505: function MULTIMEDIA($conf)
SECTION: Various helper functions for content objects: 2592: function getSlidePids($pidList, $pidConf) 2623: function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal) 2641: function cImage($file,$conf) 2669: function getBorderAttr($borderAttr) 2685: function imageLinkWrap($string,$imageFile,$conf) 2765: function fileResource($fName, $addParams='alt="" title=""') 2788: function lastChanged($tstamp) 2805: function linkWrap($content,$wrap) 2824: function getAltParam($conf, $longDesc=TRUE) 2859: function cleanFormName($name) 2875: function getATagParams($conf, $addGlobal=1)
SECTION: HTML template processing functions 2922: function getSubpart($content, $marker) 2938: function substituteSubpart($content,$marker,$subpartContent,$recursive=1) 2951: function substituteMarker($content,$marker,$markContent) 2971: function substituteMarkerArrayCached($content,$markContentArray=array(),$subpartContentArray=array(),$wrappedSubpartContentArray=array()) 3069: function substituteMarkerArray($content,$markContentArray,$wrap='',$uppercase=0) 3081: function substituteMarkerInObject(&$tree, $markContentArray) 3104: function fillInMarkerArray($markContentArray, $row, $fieldList='', $nl2br=TRUE, $prefix='FIELD_', $HSC=FALSE)
SECTION: "stdWrap" + sub functions 3167: function stdWrap($content,$conf) 3364: function numRows($conf) 3388: function listNum($content,$listNum,$char) 3408: function checkIf($conf) 3471: function filelist($data) 3553: function clean_directory($theDir) 3571: function HTMLparser_TSbridge($theValue, $conf) 3585: function dataWrap($content,$wrap) 3598: function insertData($str) 3628: function prefixComment($str,$conf,$content) 3652: function substring($content,$options) 3670: function crop($content,$options) 3702: function removeBadHTML($text, $conf) 3746: function textStyle($theValue, $conf) 3813: function tableStyle($theValue, $conf) 3854: function addParams($content,$conf) 3895: function filelink($theValue, $conf) 3966: function locDataJU($jumpUrl,$conf) 3997: function calc($val) 4026: function calcIntExplode($delim, $string) 4046: function splitObj($value, $conf) 4108: function parseFunc($theValue, $conf, $ref='') 4218: function _parseFunc ($theValue, $conf) 4424: function encaps_lineSplit($theValue, $conf) 4507: function http_makelinks($data,$conf) 4574: function mailto_makelinks($data,$conf) 4617: function getImgResource($file,$fileArray)
SECTION: Data retrieval etc. 4810: function getFieldVal($field) 4830: function getData($string,$fieldArray) 4975: function rootLineValue($key,$field,$slideBack=0,$altRootLine='') 4997: function getGlobal($var, $source=NULL) 5033: function getKey($key,$arr) 5056: function TCAlookup($inputValue,$conf)
SECTION: Link functions (typolink) 5116: function typoLink($linktxt, $conf) 5481: function typoLink_URL($conf) 5499: function getTypoLink($label,$params,$urlParameters=array(),$target='') 5526: function getTypoLink_URL($params,$urlParameters=array(),$target='') 5538: function typolinkWrap($conf) 5551: function currentPageUrl($urlParameters=array(),$id=0) 5564: function getClosestMPvalueForPage($pageId, $raw=FALSE) 5619: function getMailTo($mailAddress,$linktxt,$initP='?') 5658: function getQueryArguments($conf,$overruleQueryArgs=array(),$forceArgs=FALSE)
SECTION: Miscellaneous functions, stand alone 5754: function wrap($content,$wrap,$char='|') 5770: function noTrimWrap($content,$wrap) 5784: function wrapSpace($content, $wrap) 5810: function callUserFunction($funcName,$conf,$content) 5851: function processParams($params) 5869: function keywords($content) 5886: function caseshift($theValue, $case) 5911: function HTMLcaseshift($theValue, $case) 5940: function bytes($sizeInBytes,$labels) 5951: function calcAge($seconds,$labels) 5983: function sendNotifyEmail($msg, $recipients, $cc, $email_from, $email_fromName='', $replyTo='') 6010: function URLqMark($url,$params) 6026: function checkEmail($email) 6038: function clearTSProperties($TSArr,$propList) 6057: function mergeTSRef($confArr,$prop) 6080: function joinTSarrays($conf,$old_conf) 6103: function gifBuilderTextBox($gifbuilderConf, $conf, $text) 6159: function linebreaks($string,$chars,$maxLines=0) 6190: function getUpdateJS($dataArray, $formName, $arrPrefix, $fieldList)
SECTION: Database functions, making of queries 6260: function DBgetDelete($table, $uid, $doExec=FALSE) 6292: function DBgetUpdate($table, $uid, $dataArr, $fieldList, $doExec=FALSE) 6334: function DBgetInsert($table, $pid, $dataArr, $fieldList, $doExec=FALSE) 6371: function DBmayFEUserEdit($table,$row, $feUserRow, $allowedGroups='',$feEditSelf=0) 6411: function DBmayFEUserEditSelect($table,$feUserRow,$allowedGroups='',$feEditSelf=0) 6451: function enableFields($table,$show_hidden=0) 6475: function getTreeList($id,$depth,$begin=0,$dontCheckEnableFields=FALSE,$addSelectFields='',$moreWhereClauses='', $prevId_array=array(), $recursionLevel=0) 6583: function whereSelectFromList($field,$value) 6601: function exec_mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='') 6628: function exec_mm_query_uidList($select,$local_table_uidlist,$mm_table,$foreign_table='',$whereClause='',$groupBy='',$orderBy='',$limit='') 6649: function searchWhere($sw,$searchFieldList,$searchTable='') 6685: function exec_getQuery($table, $conf) 6703: function getQuery($table, $conf, $returnQueryArray=FALSE) 6783: function getWhere($table,$conf, $returnQueryArray=FALSE) 6878: function checkPidArray($listArr) 6902: function checkPid($uid)
SECTION: Frontend editing functions 6959: function editPanel($content, $conf, $currentRecord='', $dataArr=array()) 7146: function editIcons($content,$params, $conf=array(), $currentRecord='', $dataArr=array(),$addUrlParamStr='') 7228: function editPanelLinkWrap($string,$formName,$cmd,$currentRecord='',$confirm='',$nPid='') 7270: function editPanelLinkWrap_doWrap($string,$url,$currentRecord) 7298: function editPanelPreviewBorder($table,$row,$content,$thick,$conf=array()) 7320: function isDisabled($table,$row)
7351: class tslib_frameset 7361: function make($setup) 7398: function frameParams($setup, $typeNum) 7426: function framesetParams($setup)
7459: class tslib_tableOffset 7471: function start($content,$offset)
7549: class tslib_controlTable 7584: function start($offset,$cMargins)
TOTAL FUNCTIONS: 135 (This index is automatically created/updated by the extension "extdeveval") This class contains all main TypoScript features. This includes the rendering of TypoScript content objects (cObjects). Is the backbone of TypoScript Template rendering.
There are lots of functions you can use from your include-scripts. The class "tslib_cObj" is normally instantiated and referred to as "cObj". When you call your own PHP-code typically through a USER or USER_INT cObject then it is this class that instantiates the object and calls the main method. Before it does so it will set (if you are using classes) a reference to itself in the internal variable "cObj" of the object. Thus you can access all functions and data from this class by $this->cObj->... from within you classes written to be USER or USER_INT content objects.
tslib
Rendering of framesets
tslib
Rendering of tables for offset
tslib
Rendering of tables for content positioning
tslib
Tools for scripts using the eID feature of index.php Included from index_ts.php Since scripts using the eID feature does not have a full FE environment initialized by default this class seeks to provide functions that can initialize parts of the FE environment as needed, eg. Frontend User session, Database connection etc.
71: public static function initFeUser() 98: public static function connectDB() 117: public static function initLanguage($language = 'default') 131: public static function initTCA() 150: public static function initExtensionTCA($extensionKey) 167: private static function getTSFE()
TOTAL FUNCTIONS: 6 (This index is automatically created/updated by the extension "extdeveval") Tools for scripts using the eID feature of index.php
tslib
eID controller for ExtDirect
Class for the built TypoScript based Front End
This class has a lot of functions and internal variable which are use from index_ts.php. The class is instantiated as $GLOBALS['TSFE'] in index_ts.php. The use of this class should be inspired by the order of function calls as found in index_ts.php.
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
213: class tslib_fe 382: function tslib_fe($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='',$MP='',$RDCT='') 415: function connectToMySQL() 425: function connectToDB() 470: function sendRedirect()
SECTION: Initializing, resolving page id 508: function initFEuser() 558: function initUserGroups() 593: function isUserOrGroupSet() 618: function checkAlternativeIdMethods() 670: function clear_preview() 683: function determineId() 817: function fetch_the_id() 911: function getPageAndRootline() 994: function getPageShortcut($SC,$mode,$thisUid,$itera=20,$pageLog=array()) 1044: function checkRootlineForIncludeSection() 1081: function checkEnableFields($row,$bypassGroupCheck=FALSE) 1097: function checkPageGroupAccess($row, $groupList=NULL) 1116: function checkPagerecordForIncludeSection($row) 1125: function checkIfLoginAllowedInBranch() 1150: function getPageAccessFailureReasons() 1182: function setIDfromArgV() 1198: function getPageAndRootlineWithDomain($domainStartPage) 1225: function setSysPageWhereClause() 1237: function findDomainRecord($recursive=0) 1257: function pageNotFoundAndExit($reason='', $header='') 1272: function pageNotFoundHandler($code, $header='', $reason='') 1316: function checkAndSetAlias() 1335: function idPartsAnalyze($str) 1360: function mergingWithGetVars($GET_VARS) 1390: function ADMCMD_preview() 1433: function ADMCMD_preview_postInit($previewConfig)
SECTION: Template and caching related functions. 1465: function makeCacheHash() 1489: function reqCHash() 1511: function cHashParams($addQueryParams) 1520: function initTemplate() 1532: function getFromCache() 1578: function getFromCache_queryRow() 1608: function headerNoCache() 1637: function getHash() 1657: function getConfigArray()
SECTION: Further initialization and data processing 1818: function getCompressedTCarray() 1872: function includeTCA($TCAloaded=1) 1899: function settingLanguage() 1992: function settingLocale() 2017: function checkDataSubmission() 2050: function fe_tce() 2064: function locDataCheck($locationData) 2080: function sendFormmail() 2131: function extractRecipientCopy($bodytext) 2145: function setExternalJumpUrl() 2156: function checkJumpUrlReferer() 2171: function jumpUrl() 2215: function setUrlIdToken()
SECTION: Page generation; cache handling 2258: function isGeneratePage() 2268: function tempPageCacheContent() 2325: function realPageCacheContent() 2355: function setPageCacheContent($content,$data,$tstamp) 2382: function clearPageCacheContent() 2392: function clearPageCacheContent_pidList($pidList) 2426: function setSysLastChanged()
SECTION: Page generation; rendering and inclusion 2462: function generatePage_preProcessing() 2484: function generatePage_whichScript() 2496: function generatePage_postProcessing() 2588: function INTincScript() 2648: function INTincScript_loadJSCode() 2689: function isINTincScript() 2698: function doXHTML_cleaning() 2707: function doLocalAnchorFix()
SECTION: Finished off; outputting, storing session data, statistics... 2738: function isOutputting() 2761: function processOutput() 2834: function sendCacheHeaders() 2902: function isStaticCacheble() 2915: function contentStrReplace() 2941: function isEXTincScript() 2950: function storeSessionData() 2960: function setParseTime() 2972: function statistics() 3066: function previewInfo() 3101: function hook_eofe() 3117: function beLoginLinkIPList() 3138: function addTempContentHttpHeaders()
SECTION: Various internal API functions 3184: function makeSimulFileName($inTitle,$page,$type,$addParams='',$no_cache='') 3231: function simulateStaticDocuments_pEnc_onlyP_proc($linkVars) 3260: function getSimulFileName() 3271: function setSimulReplacementChar() 3291: function fileNameASCIIPrefix($inTitle,$titleChars,$mergeChar='.') 3314: function encryptEmail($string,$back=0) 3340: function codeString($string, $decode=FALSE) 3366: function roundTripCryptString($string) 3386: function checkFileInclude($incFile) 3401: function newCObj() 3414: function setAbsRefPrefix() 3428: function baseUrlWrap($url) 3447: function printError($label,$header='Error!') 3458: function updateMD5paramsRecord($hash) 3469: function tidyHTML($content) 3495: function prefixLocalAnchorsWithScript() 3505: function workspacePreviewInit() 3521: function doWorkspacePreview() 3531: function whichWorkspace($returnTitle = FALSE)
SECTION: Various external API functions - for use in plugins etc. 3589: function getStorageSiterootPids() 3604: function getPagesTSconfig() 3637: function setJS($key,$content='') 3677: function setCSS($key,$content) 3692: function make_seed() 3705: function uniqueHash($str='') 3714: function set_no_cache() 3724: function set_cache_timeout_default($seconds) 3740: function plainMailEncoded($email,$subject,$message,$headers='')
SECTION: Localization and character set conversion 3784: function sL($input) 3813: function readLLfile($fileRef) 3824: function getLLL($index,$LOCAL_LANG) 3838: function initLLvars() 3872: function csConv($str,$from='') 3890: function convOutputCharset($content,$label='') 3903: function convPOSTCharset()
TOTAL FUNCTIONS: 116 (This index is automatically created/updated by the extension "extdeveval") Main frontend class, instantiated in the index_ts.php script as the global object TSFE
tslib
This class contains compression functions for the TYPO3 Frontend. It can be used only in EXT:cms/tslib/index_ts.php
tx_cms
Form-data processing included from index_ts.php
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
83: class tslib_feTCE 100: function start($data,$FEData) 187: function checkDoublePostExist($table,$doublePostField,$key) 200: function calcDoublePostKey($array) 212: function includeScripts() 232: function execNEWinsert($table, $dataArr) 258: function clear_cacheCmd($cacheCmd) 274: function getConf($table)
TOTAL FUNCTIONS: 7 (This index is automatically created/updated by the extension "extdeveval") Form-data processing class. Used by the FE_DATA object found in TSref. Quite old fashioned and used only by a few extensions, like good old 'tt_guest' and 'tt_board'
tslib
Front End session user. Login and session data Included from index_ts.php
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
79: class tslib_feUserAuth extends t3lib_userAuth 143: function fetchGroupData() 233: function getUserTSconf()
SECTION: Session data management functions 278: function fetchSessionData() 300: function storeSessionData() 326: function getKey($type,$key) 351: function setKey($type,$key,$data) 377: function record_registration($recs,$maxSizeOfSessionData=0)
TOTAL FUNCTIONS: 7 (This index is automatically created/updated by the extension "extdeveval") Extension class for Front End User Authentication.
tslib
Generating gif/png-files from TypoScript Used by the menu-objects and imgResource in TypoScript.
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
102: class tslib_gifBuilder extends t3lib_stdGraphic 129: function start($conf,$data) 315: function gifBuild() 343: function make()
SECTION: Various helper functions 486: function checkTextObj($conf) 566: function calcOffset($string) 615: function getResource($file,$fileArray) 632: function checkFile($file) 643: function fileName($pre) 659: function extension()
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") GIFBUILDER extension class. This class allows for advanced rendering of images with various layers of images, text and graphical primitives. The concept is known from TypoScript as "GIFBUILDER" where you can define a "numerical array" (TypoScript term as well) of "GIFBUILDER OBJECTS" (like "TEXT", "IMAGE", etc.) and they will be rendered onto an image one by one. The name "GIFBUILDER" comes from the time where GIF was the only file format supported. PNG is just as well to create today (configured with TYPO3_CONF_VARS[GFX]) Not all instances of this class is truely building gif/png files by layers; You may also see the class instantiated for the purpose of using the scaling functions in the parent class, t3lib_stdGraphic.
Here is an example of how to use this class (from tslib_content.php, function getImgResource):
$gifCreator = t3lib_div::makeInstance('tslib_gifbuilder'); $gifCreator->init(); $theImage=''; if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) { $gifCreator->start($fileArray,$this->data); $theImage = $gifCreator->gifBuild(); } return $gifCreator->getImageDimensions($theImage);
tslib
Generating navigation / menus from TypoScript
This file contains five classes, four of which are extensions to the main class, tslib_menu. The main class, tslib_menu, is also extended by other external PHP scripts such as the GMENU_LAYERS and GMENU_FOLDOUT scripts which creates pop-up menus. Notice that extension classes (like "tslib_tmenu") must have their suffix (here "tmenu") listed in $this->tmpl->menuclasses - otherwise they cannot be instantiated.
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
146: class tslib_menu 211: function start(&$tmpl,&$sys_page,$id,$conf,$menuNumber,$objSuffix='') 357: function makeMenu() 909: function includeMakeMenu($conf,$altSortField) 925: function filterMenuPages(&$data,$banUidArray,$spacer) 981: function procesItemStates($splitCount) 1191: function link($key,$altTarget='',$typeOverride='') 1263: function changeLinksForAccessRestrictedPages(&$LD, $page, $mainTarget, $typeOverride) 1284: function subMenu($uid, $objSuffix='') 1330: function isNext($uid, $MPvar='') 1351: function isActive($uid, $MPvar='') 1372: function isCurrent($uid, $MPvar='') 1387: function isSubMenu($uid) 1412: function isItemState($kind,$key) 1452: function accessKey($title) 1480: function userProcess($mConfKey,$passVar) 1495: function setATagParts() 1508: function getPageTitle($title,$nav_title) 1520: function getMPvar($key) 1535: function getDoktypeExcludeWhere() 1545: function getBannedUids() 1568: function menuTypoLink($page, $oTarget, $no_cache, $script, $overrideArray = '', $addParams = '', $typeOverride = '')
1618: class tslib_tmenu extends tslib_menu 1627: function generate() 1643: function writeMenu() 1796: function getBeforeAfter($pref) 1826: function addJScolorShiftFunction() 1848: function extProc_init() 1859: function extProc_RO($key) 1870: function extProc_beforeLinking($key) 1882: function extProc_afterLinking($key) 1900: function extProc_beforeAllWrap($item,$key) 1911: function extProc_finish()
1951: class tslib_gmenu extends tslib_menu 1960: function generate() 1998: function makeGifs($conf, $resKey) 2196: function findLargestDims($conf,$items,$Hobjs,$Wobjs,$minDim,$maxDim) 2268: function writeMenu() 2392: function extProc_init() 2403: function extProc_RO($key) 2414: function extProc_beforeLinking($key) 2427: function extProc_afterLinking($key) 2444: function extProc_beforeAllWrap($item,$key) 2455: function extProc_finish()
2493: class tslib_imgmenu extends tslib_menu 2502: function generate() 2520: function makeImageMap($conf) 2706: function writeMenu()
2749: class tslib_jsmenu extends tslib_menu 2756: function generate() 2764: function writeMenu() 2825: function generate_level($levels,$count,$pid,$menuItemArray='',$MP_array=array())
TOTAL FUNCTIONS: 47 (This index is automatically created/updated by the extension "extdeveval") Base class. The HMENU content object uses this (or more precisely one of the extension classes). Amoung others the class generates an array of menuitems. Thereafter functions from the subclasses are called. The class is ALWAYS used through extension classes (like tslib_gmenu or tslib_tmenu which are classics) and
Example of usage (from tslib_cObj):
$menu = t3lib_div::makeInstance('tslib_'.$cls); $menu->parent_cObj = $this; $menu->start($GLOBALS['TSFE']->tmpl,$GLOBALS['TSFE']->sys_page,'',$conf,1); $menu->makeMenu(); $content.=$menu->writeMenu();
tslib
Extension class creating text based menus
tslib
Extension class creating graphic based menus (PNG or GIF files)
tslib
ImageMap based menus
tslib
JavaScript/Selectorbox based menus
tslib
Libraries for pagegen.php The script "pagegen.php" is included by "index_ts.php" when a page is not cached but needs to be rendered.
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
88: class TSpagegen 95: function pagegenInit() 271: function getIncFiles() 304: function JSeventFunctions() 338: function renderContent() 365: function renderContentWithHeader($pageContent)
SECTION: Helper functions 827: function inline2TempFile($str,$ext)
881: class FE_loadDBGroup extends t3lib_loadDBGroup
TOTAL FUNCTIONS: 6 (This index is automatically created/updated by the extension "extdeveval") Class for starting TypoScript page generation
The class is not instantiated as an objects but called directly with the "::" operator. eg: TSpagegen::pagegenInit()
tslib
Class for fetching record relations for the frontend.
tslib
This script contains the parent class, 'pibase', providing an API with the most basic methods for frontend plugins
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
132: class tslib_pibase
SECTION: Init functions 214: function tslib_pibase() 240: function pi_setPiVarDefaults()
SECTION: Link functions 277: function pi_getPageLink($id,$target='',$urlParameters=array()) 293: function pi_linkToPage($str,$id,$target='',$urlParameters=array()) 308: function pi_linkTP($str,$urlParameters=array(),$cache=0,$altPageId=0) 331: function pi_linkTP_keepPIvars($str,$overrulePIvars=array(),$cache=0,$clearAnyway=0,$altPageId=0) 355: function pi_linkTP_keepPIvars_url($overrulePIvars=array(),$cache=0,$clearAnyway=0,$altPageId=0) 373: function pi_list_linkSingle($str,$uid,$cache=FALSE,$mergeArr=array(),$urlOnly=FALSE,$altPageId=0) 401: function pi_openAtagHrefInJSwindow($str,$winName='',$winParams='width=670,height=500,status=0,menubar=0,scrollbars=1,resizable=1')
SECTION: Functions for listing, browsing, searching etc. 456: function pi_list_browseresults($showResultCount=1,$tableParams='',$wrapArr=array(), $pointerName = 'pointer', $hscText = TRUE) 618: function pi_list_searchBox($tableParams='') 649: function pi_list_modeSelector($items=array(),$tableParams='') 687: function pi_list_makelist($res,$tableParams='') 722: function pi_list_row($c) 734: function pi_list_header()
SECTION: Stylesheet, CSS 765: function pi_getClassName($class) 777: function pi_classParam($class) 791: function pi_setClassStyle($class,$data,$selector='') 802: function pi_wrapInBaseClass($str)
SECTION: Frontend editing: Edit panel, edit icons 858: function pi_getEditPanel($row='',$tablename='',$label='',$conf=Array()) 900: function pi_getEditIcon($content,$fields,$title='',$row='',$tablename='',$oConf=array())
SECTION: Localization, locallang functions 947: function pi_getLL($key,$alt='',$hsc=FALSE) 970: function pi_loadLL()
SECTION: Database, queries 1048: function pi_list_query($table,$count=0,$addWhere='',$mm_cat='',$groupBy='',$orderBy='',$query='',$returnQueryArray=FALSE) 1140: function pi_exec_query($table,$count=0,$addWhere='',$mm_cat='',$groupBy='',$orderBy='',$query='') 1155: function pi_getRecord($table,$uid,$checkPage=0) 1166: function pi_getPidList($pid_list,$recursive=0) 1191: function pi_prependFieldsWithTable($table,$fieldList) 1211: function pi_getCategoryTableContents($table,$pid,$whereClause='',$groupBy='',$orderBy='',$limit='')
SECTION: Various 1255: function pi_isOnlyFields($fList,$lowerThan=-1) 1275: function pi_autoCache($inArray) 1306: function pi_RTEcssText($str)
SECTION: FlexForms related functions 1328: function pi_initPIflexForm($field='pi_flexform') 1346: function pi_getFFvalue($T3FlexForm_array,$fieldName,$sheet='sDEF',$lang='lDEF',$value='vDEF') 1363: function pi_getFFvalueFromSheetArray($sheetArray,$fieldNameArr,$value)
TOTAL FUNCTIONS: 35 (This index is automatically created/updated by the extension "extdeveval") Base class for frontend plugins Most modern frontend plugins are extension classes of this one. This class contains functions which assists these plugins in creating lists, searching, displaying menus, page-browsing (next/previous/1/2/3) and handling links. Functions are all prefixed "pi_" which is reserved for this class. Those functions can of course be overridden in the extension classes (that is the point...)
tslib
Searching in database tables, typ. "pages" and "tt_content" Used to generate search queries for TypoScript. The class is included from "class.tslib_pagegen.php" based on whether there has been detected content in the GPvar "sword"
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
88: class tslib_search 127: function register_tables_and_columns($requestedCols,$allowedCols) 168: function explodeCols($in) 193: function register_and_explode_search_string($sword) 226: function split($origSword, $specchars='+-', $delchars='+.,-') 269: function quotemeta($str) 285: function build_search_query($endClause) 371: function build_search_query_for_searchwords() 413: function get_operator($operator) 436: function count_query() 449: function execute_query() 462: function get_searchwords() 477: function get_searchwordsArray()
TOTAL FUNCTIONS: 12 (This index is automatically created/updated by the extension "extdeveval") Search class used for the content object SEARCHRESULT
tslib
Adds extra fields into 'media' flexform
cms
Class that hooks into TCEmain and listens for updates to pages to update the treelist cache
tslib
This is the MAIN DOCUMENT of the TypoScript driven standard front-end (from the "cms" extension) Basically put this is the "index.php" script which all requests for TYPO3 delivered pages goes to in the frontend (the website) The script configures constants, includes libraries and does a little logic here and there in order to instantiate the right classes to create the webpage. All the real data processing goes on in the "tslib/" classes which this script will include and use as needed.
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
tslib
interface for classes which hook into tslib_content and do additional cObjGetSingle processing
t3lib
interface for classes which hook into tslib_content and do additional getData processing
t3lib
Interface for classes which hook into tslib_content and do additional getImgResource processing
cms
Interface for classes which hook into tslib_content and do additional initialization processing.
tslib
interface for classes which hook into tslib_content and do additional stdWrap processing
t3lib
interface for classes which hook into tslib_mediawizard adding additional media wizard providers
tslib
interface for classes which hook into tslib_menu
FE admin lib
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
132: class user_feAdmin 179: function init($content,$conf)
SECTION: Data processing 423: function parseValues() 518: function processFiles($cmdParts,$theField) 624: function overrideValues() 640: function defaultValues() 659: function evalValues() 781: function userProcess($mConfKey,$passVar) 799: function userProcess_alt($confVal,$confArr,$passVar)
SECTION: Database manipulation functions 841: function save() 899: function deleteRecord() 929: function deleteFilesFromRecord($uid)
SECTION: Command "display" functions 986: function displayDeleteScreen() 1014: function displayCreateScreen() 1037: function displayEditScreen() 1088: function displayEditForm($origArr) 1116: function procesSetFixed()
SECTION: Template processing functions 1205: function removeRequired($templateCode,$failure) 1223: function getPlainTemplate($key,$r='') 1240: function modifyDataArrForFormUpdate($inputArr) 1309: function setCObjects($templateCode,$currentArr=array(),$markerArray='',$specialPrefix='')
SECTION: Emailing 1371: function sendInfoMail() 1419: function compileMail($key, $DBrows, $recipient, $setFixedConfig=array()) 1465: function sendMail($recipient, $admin, $content='', $adminContent='') 1510: function isHTMLContent($c) 1531: function sendHTMLMail($content,$recipient,$dummy,$fromEmail,$fromName,$replyTo='')
SECTION: Various helper functions 1615: function aCAuth($r) 1629: function authCode($r,$extra='') 1655: function setfixed($markerArray, $setfixed, $r) 1693: function setfixedHash($recCopy,$fields='') 1714: function isPreview() 1723: function createFileFuncObj() 1734: function clearCacheIfSet() 1749: function getFailure($theField, $theCmd, $label)
TOTAL FUNCTIONS: 33 (This index is automatically created/updated by the extension "extdeveval") This library provides a HTML-template file based framework for Front End creating/editing/deleting records authenticated by email or fe_user login. It is used in the extensions "direct_mail_subscription" and "feuser_admin" (and the deprecated(!) static template "plugin.feadmin.dmailsubscription" and "plugin.feadmin.fe_users" which are the old versions of these two extensions) Further the extensions "t3consultancies" and "t3references" also uses this library but contrary to the "direct_mail_subscription" and "feuser_admin" extensions which relies on external HTML templates which must be adapted these two extensions delivers the HTML template code from inside. Generally the fe_adminLib appears to be hard to use. Personally I feel turned off by all the template-file work involved and since it is very feature rich (and for that sake pretty stable!) there are lots of things that can go wrong - you feel. Therefore I like the concept used by "t3consultancies"/"t3references" since those extensions uses the library by supplying the HTML-template code automatically. Suggestions for improvement and streamlining is welcome so this powerful class could be used more and effectively.
tslib
Contains the GMENU_FOLDOUT extension class, tslib_gmenu_foldout
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
80: class tslib_gmenu_foldout extends tslib_gmenu 96: function extProc_init() 117: function extProc_beforeLinking($key) 134: function extProc_afterLinking($key) 160: function extProc_finish()
TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Class extension tslib_gmenu for the creation of DHTML foldout menus
tslib
Contains the GMENU_LAYERS extension class, tslib_gmenu_layers
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
84: class tslib_gmenu_layers extends tslib_gmenu 116: function extProc_init() 134: function extProc_RO($key) 150: function extProc_beforeLinking($key) 205: function extProc_afterLinking($key) 240: function extProc_beforeAllWrap($item,$key) 253: function isSetIntval($in) 262: function extProc_finish () 444: function extCalcBorderWithin($kind,$integer)
TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Class extending tslib_gmenu for the creation of DHTML menus NOTICE: The contents of this class is made so that it can be copied EXACTLY AS IS to the tmenu_layers class! See notes in class (for BEGIN/END) and also "diff.xmenu_layers.txt"
tslib
Generating plain text content of content elements for Direct Mails
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
123: class user_plaintext 137: function main_plaintext($content,$conf) 209: function getMenuSitemap() 220: function getShortcut() 231: function getHTML($str=array()) 241: function getHeader() 251: function getImages() 262: function parseBody($str) 284: function renderUploads($str,$upload_path='uploads/media/') 302: function renderHeader($str,$type=0) 353: function pad($lines,$preLineChar,$len) 369: function breakContent($str) 385: function breakBulletlist($str) 416: function breakTable($str) 472: function addDiv($messure,$content,$divChar,$joinChar,$cols) 488: function traverseTable($tableLines) 515: function renderImages($str,$links,$caption,$upload_path='uploads/pics/') 554: function getLink($ll) 571: function breakLines($str,$implChar="\n",$charWidth=0) 583: function getString($str) 595: function userProcess($mConfKey,$passVar) 613: function atag_to_http($content,$conf) 632: function typolist($content,$conf) 647: function typohead($content,$conf) 666: function typocode($content,$conf)
TOTAL FUNCTIONS: 24 (This index is automatically created/updated by the extension "extdeveval") Alternative rendering of content elements for Plain Text emails. That means text-only output. No HTML at all. Used by the Direct Mail extension. Normally the plain text output should appear with type=99. To use this library you can include the static template "plugin.alt.plaintext"
## Insert DMailer Boundaries for all elements. config.insertDmailerBoundaries = 1 includeLibs.plaintextLib = media/scripts/plaintextLib.inc
## Set up page/type number: alt_plaintext > alt_plaintext = PAGE alt_plaintext.typeNum=99 alt_plaintext.config.disableAllHeaderCode = 1 alt_plaintext.10 = TEMPLATE alt_plaintext.10 { template = FILE template.file = {$plugin.alt.plaintext.file.template} marks.CONTENT < styles.content.get marks.CONTENT.renderObj = < lib.alt_plaintext.renderObj marks.DATE = TEXT marks.DATE.data = date:U marks.DATE.strftime = e. B Y }
(And then also "lib.alt_plaintext.renderObj" is configured extensively - basically with the TypoScript options passed to this class. See the static template "plugin.alt.plaintext")
tslib
Contains the TMENU_LAYERS extension class, tslib_tmenu_layers
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant
84: class tslib_tmenu_layers extends tslib_tmenu 116: function extProc_init() 134: function extProc_RO($key) 150: function extProc_beforeLinking($key) 205: function extProc_afterLinking($key) 240: function extProc_beforeAllWrap($item,$key) 253: function isSetIntval($in) 262: function extProc_finish () 444: function extCalcBorderWithin($kind,$integer)
TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Class extending tslib_tmenu for the creation of text based DHTML menus NOTICE: The contents of this class is copied EXACTLY AS IS from gmenu_layers class! See notes in class (for BEGIN/END) and also 'diff.xmenu_layers.txt'
tslib
Contains class for creating WAP pages for TYPO3
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
129: class user_wapversion 141: function main_wapversion($content,$conf) 200: function contentAbstract() 217: function contentAll($chunkLgd=850) 277: function cHeader($str) 291: function cBodytext($str,$start=0,$max=0) 303: function nl2br($str) 314: function getContentResult($table) 329: function bold($str) 339: function paragraph($str) 349: function line($str) 360: function navLink($str,$pointer) 370: function menuCurrentLevel($indent) 405: function link($str,$id,$deck='') 421: function cleanMenuArray($menu)
TOTAL FUNCTIONS: 14 (This index is automatically created/updated by the extension "extdeveval") Class that creates the current page and content element records as an WML structure using the library "t3lib_xml" It is demonstrated in use in the testsite package on page "59" The static template "plugin.alt.wap" is used to trigger this WML creation as well. That template contains this set of TypoScript lines which triggers the WML creation and disables all regular HTML headers
## Set up page/type: alt_wap > alt_wap = PAGE alt_wap { typeNum=97 config.disableAllHeaderCode = 1 config.additionalHeaders = Content-type: text/vnd.wap.wml
## Includes the newsLib: includeLibs.alt_wap = media/scripts/wapversionLib.inc
## Inserting the USER cObject for WAP/XML rendering 10 = USER 10 { userFunc = user_wapversion->main_wapversion debug=0 preTitle = T3WAP navLabels.prev = Prev navLabels.next = Next navLabels.up = Up } }
NOTICE:
In the static template "plugin.alt.wap" there is a part in the end looking like this:
## If the browser is a WAP-device, [device=wap] alt_wap.typeNum=0 [global]
This means that IF the device coming to the URL is a WAP device they will get wap content even if they don't specify "&type=97" since the typeNum is changed to zero here! In fact they CANNOT get any wap-content at "&type=97" anymore! This has been a source of error and confusion for many people
tslib
Example class showing how one could make XML export of page content elements in TYPO3
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
96: class user_xmlversion 107: function main_xmlversion($content,$conf) 137: function getContentResult($table)
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Class that creates the current page and content element records as an XML structure using the library "t3lib_xml" It is demonstrated in use in the testsite package on page "59" The static template "plugin.alt.xml" is used to trigger this XML creation as well. That template contains this set of TypoScript lines which triggers the XML creation and disables all regular HTML headers
## Set up page/type number: alt_xml > alt_xml = PAGE alt_xml { typeNum=96 config.disableAllHeaderCode = 1 config.additionalHeaders = Content-type: text/xml
## Includes the newsLib: includeLibs.alt_xml = media/scripts/xmlversionLib.inc
## Inserting the USER cObject for XML rendering 10 = USER 10 { userFunc = user_xmlversion->main_xmlversion } }
tslib
Generating the TypoScript based page. Must be included from index_ts.php
Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
tslib
Publishing pages to static
Is included from index_ts.php
tslib
Script Class, generating the page output. Instantiated in the bottom of this script.
tslib
Contains a class with functions for page related statistics added to the backend Info module
Revised for TYPO3 3.6 5/2003 by Kasper Skårhøj
66: class tx_cms_webinfo_page extends t3lib_extobjbase 73: function modMenu() 100: function main()
198: class tx_cms_webinfo_hits extends tx_cms_webinfo_page
TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Class for displaying page information (records, page record properties)
tx_cms
Extension class for hits display, basically using tx_cms_webinfo_page (internally this is detected). This construction is due to the old "pre-extensions" structure
IMPORTANT: This class is used by the extension "sys_stat" and will be added to the Info module only when "sys_stat" is installed. The display of statistics goes on in "tx_cms_webinfo_page" though
tx_cms
Contains a class with functions for page related overview of translations.
66: class tx_cms_webinfo_lang extends t3lib_extobjbase 73: function modMenu() 102: function main() 171: function renderL10nTable(&$tree) 342: function getSystemLanguages() 364: function getLangStatus($pageId, $langId) 393: function getLocalizedElementInfo($pageId,$sysLang) 471: function getContentElementCount($pageId,$sysLang)
TOTAL FUNCTIONS: 7 (This index is automatically created/updated by the extension "extdeveval") Class for displaying translation status of pages in the tree.
tx_cms
Plugin 'Content rendering' for the 'css_styled_content' extension.
68: class tx_cssstyledcontent_pi1 extends tslib_pibase
SECTION: Rendering of Content Elements: 96: function render_bullets($content,$conf) 141: function render_table($content,$conf) 283: function render_uploads($content,$conf) 395: function render_textpic($content, $conf)
SECTION: Helper functions 832: function getTableAttributes($conf,$type) 861: function &hookRequest($functionName)
TOTAL FUNCTIONS: 6 (This index is automatically created/updated by the extension "extdeveval") Plugin class - instantiated from TypoScript. Rendering some content elements from tt_content table.
tx_cssstyledcontent
Autoloader included from Install Tool that lets DBAL load itself if it makes sense.
$Id$
dbal
Hooks for TYPO3 Extension Manager.
dbal
Hooks for TYPO3 Install Tool.
$Id$
dbal
Include file extending localRecordList for DBAL compatibility
DBAL
Contains a database abstraction layer class for TYPO3
161: class ux_t3lib_DB extends t3lib_DB 229: public function __construct() 260: protected function initInternalVariables() 283: public function clearCachedFieldInfo() 294: public function cacheFieldInfo() 342: protected function analyzeFields($parsedExtSQL) 375: protected function mapCachedFieldInfo($fieldInfo)
SECTION: Query Building (Overriding parent methods) 438: public function exec_INSERTquery($table, $fields_values, $no_quote_fields = '') 575: public function exec_INSERTmultipleRows($table, array $fields, array $rows, $no_quote_fields = FALSE) 600: public function exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields = '') 692: public function exec_DELETEquery($table, $where) 759: public function exec_SELECTquery($select_fields, $from_table, $where_clause, $groupBy = '', $orderBy = '', $limit = '') 856: public function exec_TRUNCATEquery($table) 914: protected function exec_query(array $queryParts)
SECTION: Query building 978: public function INSERTquery($table, $fields_values, $no_quote_fields = '') 1052: public function INSERTmultipleRows($table, array $fields, array $rows, $no_quote_fields = FALSE) 1085: public function UPDATEquery($table, $where, $fields_values, $no_quote_fields = '') 1170: public function DELETEquery($table, $where) 1196: public function SELECTquery($select_fields, $from_table, $where_clause, $groupBy = '', $orderBy = '', $limit = '') 1229: protected function SELECTqueryFromArray(array $params) 1267: protected function compileSelectParameters(array $params) 1283: public function TRUNCATEquery($table)
SECTION: Prepared Query Support 1314: public function prepare_SELECTquery($select_fields, $from_table, $where_clause, $groupBy = '', $orderBy = '', $limit = '', array $input_parameters = array()) 1416: protected function getQueryComponents($select_fields, $from_table, $where_clause, $groupBy, $orderBy, $limit) 1465: protected function precompileSELECTquery(array $components) 1523: public function exec_PREPAREDquery($query, array $precompiledParts)
SECTION: Functions for quoting table/field names 1619: protected function quoteSELECTsubquery(array $components) 1634: public function quoteSelectFields($select_fields) 1644: public function quoteFieldNames($select_fields) 1664: protected function _quoteFieldNames(array $select_fields) 1701: public function quoteFromTables($from_table) 1717: protected function _quoteFromTables(array $from_table) 1746: public function quoteWhereClause($where_clause) 1767: protected function _quoteWhereClause(array $where_clause) 1843: protected function quoteGroupBy($groupBy) 1860: protected function _quoteGroupBy(array $groupBy) 1877: protected function quoteOrderBy($orderBy) 1894: protected function _quoteOrderBy(array $orderBy)
SECTION: Various helper functions 1919: public function fullQuoteStr($str, $table) 1932: public function quoteStr($str, $table) 1965: public function quoteName($name, $handlerKey = NULL, $useBackticks = FALSE) 1984: public function MetaType($type, $table, $max_length = -1) 2015: public function MySQLMetaType($t) 2062: public function MySQLActualType($meta)
SECTION: SQL wrapper functions (Overriding parent methods) 2105: public function sql_error() 2125: public function sql_errno() 2146: public function sql_num_rows(&$res) 2170: public function sql_fetch_assoc(&$res) 2233: public function sql_fetch_row(&$res) 2279: public function sql_free_result(&$res) 2308: public function sql_insert_id() 2328: public function sql_affected_rows() 2350: public function sql_data_seek(&$res, $seek) 2375: public function sql_field_metatype($table, $field) 2405: public function sql_field_type(&$res,$pointer)
SECTION: Legacy functions, bound to _DEFAULT handler. (Overriding parent methods) 2459: public function sql($db,$query) 2477: public function sql_query($query) 2516: public function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password) 2534: public function sql_select_db($TYPO3_db)
SECTION: SQL admin functions 2566: public function admin_get_dbs() 2607: public function admin_get_tables() 2673: public function admin_get_fields($tableName) 2742: public function admin_get_keys($tableName) 2847: public function admin_get_charsets() 2857: public function admin_query($query)
SECTION: Handler management 2941: public function handler_getFromTableList($tableList) 2989: public function handler_init($handlerKey) 3107: public function isConnected() 3127: public function runningNative() 3138: public function runningADOdbDriver($driver)
SECTION: Table/Field mapping 3165: protected function map_needMapping($tableList, $fieldMappingOnly = FALSE, array &$parsedTableList = array()) 3215: protected function map_assocArray($input, $tables, $rev = FALSE) 3263: protected function map_remapSELECTQueryParts($select_fields, $from_table, $where_clause, $groupBy, $orderBy) 3357: protected function getMappingKey($tableName) 3371: protected function getFreeMappingKey($tableName) 3387: protected function map_sqlParts(&$sqlPartArray, $defaultTable) 3549: protected function map_subquery(&$parsedQuery) 3589: protected function map_genericQueryParsed(&$parsedQuery) 3654: protected function map_fieldNamesInArray($table,&$fieldArray)
SECTION: Debugging 3695: public function debugHandler($function,$execTime,$inData) 3790: public function debug_WHERE($table, $where, $script = '') 3813: public function debug_log($query,$ms,$data,$join,$errorFlag, $script='') 3846: public function debug_explain($query)
TOTAL FUNCTIONS: 82 (This index is automatically created/updated by the extension "extdeveval") TYPO3 database abstraction layer
tx_dbal
PHP SQL engine
t3lib
Contains an example DBAL handler class
74: class tx_dbal_handler_xmldb extends tx_dbal_sqlengine 91: function init($config, &$pObj) 128: function readDataSource($table) 157: function saveDataSource($table) 184: function xmlDB_writeStructure() 193: function xmlDB_readStructure()
SECTION: SQL admin functions 217: function admin_get_tables() 242: function admin_get_fields($tableName) 276: function admin_get_keys($tableName) 314: function admin_query($query)
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") Example DBAL handler class Stores data in an Open Office Calc Spreadsheet
tx_dbal
Contains an example DBAL handler class
86: class tx_dbal_handler_rawmysql extends tx_dbal_sqlengine 99: function init($config,&$pObj) 123: function exec_INSERTquery($table,$fields_values) 135: function exec_UPDATEquery($table,$where,$fields_values) 146: function exec_DELETEquery($table,$where) 161: function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit) 173: function sql_error() 182: function sql_insert_id() 191: function sql_affected_rows() 201: function sql_query($query) 213: function quoteStr($str)
SECTION: SQL admin functions 237: function admin_get_tables() 254: function admin_get_fields($tableName) 272: function admin_get_keys($tableName) 290: function admin_query($query)
308: class tx_dbal_handler_rawmysql_sqlObj extends tx_dbal_sqlengine_resultobj 317: function sql_num_rows() 326: function sql_fetch_assoc() 335: function sql_fetch_row() 345: function sql_data_seek($pointer)
TOTAL FUNCTIONS: 18 (This index is automatically created/updated by the extension "extdeveval") Example DBAL userdefined handler class It simply makes pass-through of MySQL
tx_dbal
Result object for this MySQL userdefined handler
tx_dbal
Contains an example DBAL handler class
74: class tx_dbal_handler_xmldb extends tx_dbal_sqlengine 91: function init($config, &$pObj) 128: function readDataSource($table) 157: function saveDataSource($table) 184: function xmlDB_writeStructure() 193: function xmlDB_readStructure()
SECTION: SQL admin functions 217: function admin_get_tables() 242: function admin_get_fields($tableName) 276: function admin_get_keys($tableName) 314: function admin_query($query)
TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") Example DBAL handler class Stores data in XML, not a database.
tx_dbal
Cache engine helper for generated queries.
$Id$
dbal
PHP SQL engine
106: class tx_dbal_sqlengine extends ux_t3lib_sqlparser 128: public function init($config, $pObj) 136: public function resetStatusVars() 152: private function processAccordingToConfig(&$value, $fInfo)
SECTION: SQL queries 207: public function exec_INSERTquery($table, $fields_values) 275: public function exec_UPDATEquery($table, $where, $fields_values) 334: public function exec_DELETEquery($table, $where) 385: public function exec_SELECTquery($select_fields, $from_table, $where_clause, $groupBy, $orderBy, $limit) 428: public function sql_query($query) 439: public function sql_error() 448: public function sql_insert_id() 457: public function sql_affected_rows() 467: public function quoteStr($str)
SECTION: SQL admin functions 493: public function admin_get_tables() 504: public function admin_get_fields($tableName) 515: public function admin_get_keys($tableName) 526: public function admin_query($query)
SECTION: Data Source I/O 551: public function readDataSource($table) 563: public function saveDataSource($table)
SECTION: SQL engine functions (PHP simulation of SQL) - still experimental 593: public function selectFromData($table, $where) 631: public function select_evalSingle($table,$config,&$itemKeys) 750: public function getResultSet($keys, $table, $fieldList)
SECTION: Debugging 793: public function debug_printResultSet($array)
832: class tx_dbal_sqlengine_resultobj 846: public function sql_num_rows() 855: public function sql_fetch_assoc() 866: public function sql_fetch_row() 884: public function sql_data_seek($pointer) 897: public 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
dbal
Class that renders fields for the Extension Manager configuration.
dbal
Script class; Backend module for DBAL extension
dbal
The mother of all test cases.
Subclass this base class if you want to take advantage of the framework capabilities.
This method is backported from FLOW3's BaseTestCase class. dbal Testcase for class ux_t3lib_db. $Id$ Xavier Perseguers <typo3@perseguers.ch> dbal Testcase for class ux_t3lib_db. Testing MS SQL database handling. $Id$ Xavier Perseguers <typo3@perseguers.ch> dbal Testcase for class ux_t3lib_db. Testing Oracle database handling. $Id$ Xavier Perseguers <typo3@perseguers.ch> dbal Testcase for class ux_t3lib_db. Testing PostgreSQL database handling. $Id$ Xavier Perseguers <typo3@perseguers.ch> dbal Fake ADOdb connection factory. Xavier Perseguers <typo3@perseguers.ch> dbal MS SQL configuration Xavier Perseguers <typo3@perseguers.ch> dbal Oracle configuration Xavier Perseguers <typo3@perseguers.ch> dbal PostgreSQL configuration $Id$ Xavier Perseguers <typo3@perseguers.ch> dbal Testcase for class ux_t3lib_sqlparser $Id$ Xavier Perseguers <typo3@perseguers.ch> dbal TER2 connection handling class for the TYPO3 Extension Manager. It contains methods for downloading and uploading extensions and related code Karsten Dambekalns <karsten@typo3.org> Kasper Skårhøj <kasperYYYY@typo3.com> EM class.tx_em_database.php Module: Extension manager - DB access Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> DB access class for extension manager. Contains static methods for DB operations. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-27 EM Module: Extension manager - connection exception Exception for internet connection handling. This exception is supposed to be thrown when there are problems with the internet connections initialized by the web server. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-18 EM Module: Extension manager - Extension import exception Exception for extension import handling. TODO: this is currently unused Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-18 EM Module: Extension manager - Extension.xml exception Exception for extension.xml handling. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-10 EM Module: Extension manager - Extension.xml exception Exception for extension.xml handling. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-18 EM Module: Extension manager - XML exception Exception for XML handling. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-18 EM class.tx_em_import_extensionlistimporter.php Module: Extension manager - Extension list importer Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Importer object for extension list Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-10 EM class.tx_em_import_mirrorlistimporter.php Module: Extension manager - Mirror list importer Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Importer object for mirror list. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-10 EM Module: Extension manager Kasper Skårhøj <kasperYYYY@typo3.com> Karsten Dambekalns <karsten@typo3.org> core class.tx_em_parser_extensionxmlabstractparser.php Module: Extension manager - Extension.xml abstract parser Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Abstract parser for TYPO3's extension.xml file. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-09 EM Module: Extension manager - Extension.xml pull-parser Parser for TYPO3's extension.xml file. Depends on PHP ext/xmlreader which should be available with PHP >= 5.1.0. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-09 EM Module: Extension manager - Extension.xml push-parser Parser for TYPO3's extension.xml file. Depends on PHP ext/xml which should be available with PHP 4+. This is the parser used in TYPO3 Core <= 4.3 (without the "collect all data in one array" behaviour). Notice: ext/xml has proven to be buggy with entities. Use at least PHP 5.2.9+ and libxml2 2.7.3+! Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-10 EM class.tx_em_parser_mirrorxmlabstractparser.php Module: Extension manager - mirror.xml abstract parser Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Abstract parser for TYPO3's mirror.xml file. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-09 EM class.tx_em_parser_mirrorxmlpullparser.php Module: Extension manager - mirrors.xml pull-parser Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Parser for TYPO3's mirrors.xml file. Depends on PHP ext/xmlreader which should be available with PHP >= 5.1.0. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-19 EM class.tx_em_parser_mirrorxmlpushparser.php Module: Extension manager - mirrors.xml push-parser $Id$ Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Parser for TYPO3's mirrors.xml file. Depends on PHP ext/xml which should be available with PHP 4+. This is the parser used in TYPO3 Core <= 4.3 (without the "collect all data in one array" behaviour). Notice: ext/xml has proven to be buggy with entities. Use at least PHP 5.2.9+ and libxml2 2.7.3+! Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-11-17 EM class.tx_em_parser_xmlabstractparser.php Module: Extension manager - Extension.xml abstract parser Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Abstract parser for EM related TYPO3 xml files. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-09 EM class.tx_em_parser_xmlparserfactory.php Module: Extension manager - XML parser factory Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Factory for XML parsers. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-10 EM class.tx_em_repository.php Module: Extension manager - Repository Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Repository object for extension manager. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-11 EM class.em_repository_mirrors Module: Extension manager - Repository mirrors Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Repository mirrors object for extension manager. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-11 EM class.tx_em_repository_utility.php Module: Extension manager - Central repository utility functions Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> Central utility class for repository handling. Marcus Krause <marcus#exp2010.info> Steffen Kamper <info@sk-typo3.de> 2010-02-18 EM Update extension list task Christian Kuhn <lolli@schwarzbu.ch> 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. Karsten Dambekalns <karsten@typo3.org> EM Interface for hook in SC_mod_tools_em_index::checkDBupdates. Xavier Perseguers <typo3@perseguers.ch> em Testcase for class t3lib_object_ClassInfoFactory. Daniel Pötzinger Bastian Waidelich <bastian@typo3.org> t3lib Testcase for class t3lib_object_Container. Daniel Pötzinger Bastian Waidelich <bastian@typo3.org> t3lib Class, adding extra context menu options Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 67: class tx_extrapagecmoptions 79: function main(&$backRef,$menuItems,$table,$uid) 158: function includeLL() TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Class, adding extra context menu options Kasper Skårhøj <kasperYYYY@typo3.com> tx_extrapagecmoptions View class for the edit panels in frontend editing. Jeff Segars <jeff@webempoweredchurch.org> David Slayback <dave@webempoweredchurch.org> feedit Plugin 'Website User Login' for the 'felogin' extension. Steffen Kamper <info@sk-typo3.de> tx_felogin Testcase for URL validation in class tx_felogin_pi1 Helmut Hummel <helmut@typo3.org> tests/typo3/sysext/felogin Script Class for creating the list of files in the File > Filelist module Kasper Skårhøj <kasperYYYY@typo3.com> core Script Class for the Web > Functions module This class creates the framework to which other extensions can connect their sub-modules Kasper Skårhøj <kasperYYYY@typo3.com> core Contains a class for the Wizard function in the Web>Info module Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 66: class tx_funcwizards_webfunc extends t3lib_extobjbase 78: function init(&$pObj,$conf) 92: function modMenu() 111: function main() TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") The Wizard function in the Web>Info module Creates a framework for adding wizard sub-sub-modules under the Wizard function in Web>Info Kasper Skårhøj <kasperYYYY@typo3.com> tx_funcwizardswebfunc Extension of the page tree class. Used to get the tree of pages to export. Kasper Skårhøj <kasperYYYY@typo3.com> tx_impexp Main script class for the Import / Export facility Kasper Skårhøj <kasperYYYY@typo3.com> tx_impexp T3D file Import/Export library (TYPO3 Record Document) Kasper Skårhøj <kasperYYYY@typo3.com> tx_impexp Adding Import/Export clickmenu item Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 67: class tx_impexp_clickmenu 79: function main(&$backRef,$menuItems,$table,$uid) 121: function includeLL() TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Adding Import/Export clickmenu item Kasper Skårhøj <kasperYYYY@typo3.com> tx_impexp Export Preset listing for the task center Kasper Skårhøj <kasperYYYY@typo3.com> tx_impexp This class provides a textarea to save personal notes Kasper Skårhøj <kasper@typo3.com> Georg Ringer <typo3@ringerge.org> impexp Crawler hook for indexed search. Works with the "crawler" extension Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 87: class tx_indexedsearch_crawler 106: function crawler_init(&$pObj) 219: function crawler_execute($params,&$pObj) 285: function crawler_execute_type1($cfgRec,&$session_data,$params,&$pObj) 345: function crawler_execute_type2($cfgRec,&$session_data,$params,&$pObj) 414: function crawler_execute_type3($cfgRec,&$session_data,$params,&$pObj) 458: function crawler_execute_type4($cfgRec,&$session_data,$params,&$pObj) 513: function cleanUpOldRunningConfigurations() SECTION: Helper functions 579: function checkUrl($url,$urlLog,$baseUrl) 602: function indexExtUrl($url, $pageId, $rl, $cfgUid, $setId) 645: function indexSingleRecord($r,$cfgRec,$rl=NULL) 694: function loadIndexerClass() 706: function getUidRootLineForClosestTemplate($id) 739: function generateNextIndexingTime($cfgRec) 778: function checkDeniedSuburls($url, $url_deny) 798: function addQueueEntryForHook($cfgRec, $title) SECTION: Hook functions for TCEmain (indexing of records) 830: function processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, &$pObj) 879: class tx_indexedsearch_files 888: function crawler_execute($params,&$pObj) 913: function loadIndexerClass() TOTAL FUNCTIONS: 18 (This index is automatically created/updated by the extension "extdeveval") Crawler hook for indexed search. Works with the "crawler" extension Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch Crawler hook for indexed search. Works with the "crawler" extension This hook is specifically used to index external files found on pages through the crawler extension. Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch tx_indexedsearch_indexer::extractLinks() External standard parsers for indexed_search Kasper Skårhøj <kasperYYYY@typo3.com> Olivier Simah <noname_paris@yahoo.fr> [CLASS/FUNCTION INDEX of SCRIPT] 75: class tx_indexed_search_extparse 94: function initParser($extension) 214: function softInit($extension) 247: function searchTypeMediaTitle($extension) 323: function isMultiplePageExtension($extension) SECTION: Reading documents (for parsing) 354: function readFileContent($ext,$absFile,$cPKey) 521: function fileContentParts($ext,$absFile) 560: function splitPdfInfo($pdfInfoArray) 579: function removeEndJunk($string) SECTION: Backend analyzer 606: function getIcon($extension) TOTAL FUNCTIONS: 9 (This index is automatically created/updated by the extension "extdeveval") External standard parsers for indexed_search MUST RETURN utf-8 content! Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch This class is a search indexer for TYPO3 Kasper Skårhøj <kasperYYYY@typo3.com> Originally Christian Jul Jensen <christian@jul.net> helped as well. [CLASS/FUNCTION INDEX of SCRIPT] 141: class tx_indexedsearch_indexer 207: function hook_indexContent(&$pObj) SECTION: Backend API 308: function backend_initIndexer($id, $type, $sys_language_uid, $MP, $uidRL, $cHash_array=array(), $createCHash=FALSE) 347: function backend_setFreeIndexUid($freeIndexUid, $freeIndexSetId=0) 365: function backend_indexAsTYPO3Page($title, $keywords, $description, $content, $charset, $mtime, $crdate=0, $recordUid=0) SECTION: Initialization 416: function init() 468: function initializeExternalParsers() SECTION: Indexing; TYPO3 pages (HTML content) 509: function indexTypo3PageContent() 596: function splitHTMLContent($content) 642: function getHTMLcharset($content) 657: function convertHTMLToUtf8($content,$charset='') 685: function embracingTags($string,$tagName,&$tagContent,&$stringAfter,&$paramList) 712: function typoSearchTags(&$body) 741: function extractLinks($content) 812: function extractHyperLinks($string) SECTION: Indexing; external URL 871: function indexExternalUrl($externalUrl) 902: function getUrlHeaders($url) SECTION: Indexing; external files (PDF, DOC, etc) 948: function indexRegularDocument($file, $force=FALSE, $contentTmpFile='', $altExtension='') 1054: function readFileContent($ext,$absFile,$cPKey) 1071: function fileContentParts($ext,$absFile) 1089: function splitRegularContent($content) SECTION: Analysing content, Extracting words 1122: function charsetEntity2utf8(&$contentArr, $charset) 1145: function processWordsInArrays($contentArr) 1170: function procesWordsInArrays($contentArr) 1180: function bodyDescription($contentArr) 1202: function indexAnalyze($content) 1223: function analyzeHeaderinfo(&$retArr,$content,$key,$offset) 1242: function analyzeBody(&$retArr,$content) 1262: function metaphone($word,$retRaw=FALSE) SECTION: SQL; TYPO3 Pages 1304: function submitPage() 1378: function submit_grlist($hash,$phash_x) 1398: function submit_section($hash,$hash_t3) 1416: function removeOldIndexedPages($phash) SECTION: SQL; External media 1459: function submitFilePage($hash,$file,$subinfo,$ext,$mtime,$ctime,$size,$content_md5h,$contentParts) 1525: function submitFile_grlist($hash) 1539: function submitFile_section($hash) 1553: function removeOldIndexedFiles($phash) SECTION: SQL Helper functions 1589: function checkMtimeTstamp($mtime,$phash) 1625: function checkContentHash() 1642: function checkExternalDocContentHash($hashGr,$content_md5h) 1656: function is_grlist_set($phash_x) 1669: function update_grlist($phash,$phash_x) 1684: function updateTstamp($phash,$mtime=0) 1699: function updateSetId($phash) 1714: function updateParsetime($phash,$parsetime) 1727: function updateRootline() 1742: function getRootLineFields(&$fieldArr) 1761: function removeLoginpagesWithContentHash() 1778: function includeCrawlerClass() SECTION: SQL; Submitting words 1805: function checkWordList($wl) 1842: function submitWords($wl,$phash) 1866: function freqMap($freq) SECTION: Hashing 1899: function setT3Hashes() 1925: function setExtHashes($file,$subinfo=array()) 1949: function md5inthash($str) 1959: function makeCHash($paramArray) SECTION: Internal logging functions 1991: function log_push($msg,$key) 2000: function log_pull() 2011: function log_setTSlogMessage($msg, $errorNum=0) SECTION: tslib_fe hooks: 2036: function fe_headerNoCache(&$params, $ref) TOTAL FUNCTIONS: 59 (This index is automatically created/updated by the extension "extdeveval") Indexing class for TYPO3 frontend Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch Lexer for indexed_search Kasper Skårhøj <kasperYYYY@typo3.com> Parts provided by Martin Kutschker <Martin.T.Kutschker@blackbox.net> [CLASS/FUNCTION INDEX of SCRIPT] 73: class tx_indexedsearch_lexer 105: function tx_indexedsearch_lexer() 116: function split2Words($wordString) SECTION: Helper functions 178: function addWords(&$words, &$wordString, $start, $len) 239: function get_word(&$str, $pos=0) 264: function utf8_is_letter(&$str, &$len, $pos=0) 329: function charType($cp) 383: function utf8_ord(&$str, &$len, $pos=0, $hex=false) TOTAL FUNCTIONS: 7 (This index is automatically created/updated by the extension "extdeveval") Lexer class for indexed_search A lexer splits the text into words Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch Index search crawler hook example Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 57: class tx_indexedsearch_crawlerhook 64: function initMessage() 80: function indexOperation($cfgRec,&$session_data,$params,&$pObj) TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Index search crawler hook example tx_indexedsearch Kasper Skårhøj <kasperYYYY@typo3.com> Index search frontend example hook Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 59: class tx_indexedsearch_pihook 72: function initialize_postProc() 95: function prepareResultRowTemplateData_postProc($tmplContent, $row, $headerOnly) TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Index search frontend - EXAMPLE hook for alternative searching / display etc. Hooks are configured in ext_localconf.php as key => hook-reference pairs in $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['pi1_hooks']. See example in ext_localconf.php for "indexed_search" Each hook must have an entry, the key must match the hook-key in class.tx_indexed_search.php and generally the key equals the function name in the hook object (a convension used) tx_indexedsearch Kasper Skårhøj <kasperYYYY@typo3.com> Hooks for tslib_fe (TSFE). Oliver Hader <oliver@typo3.org> tx_indexedsearch Backend module providing boring statistics of the index-tables. Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch Module extension (addition to function menu) 'Indexed search' for the 'indexed_search' extension. Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 106: class tx_indexedsearch_modfunc1 extends t3lib_extobjbase 120: function modMenu() 144: function main() SECTION: Drawing table of indexed pages 248: function drawTableOfIndexedPages() 299: function indexed_info($data, $firstColContent) 386: function printPhashRow($row,$grouping=0,$extraGrListRows) 527: function printPhashRowHeader() 582: function returnNumberOfColumns() SECTION: Details display, phash row 618: function showDetailsForPhash($phash) 737: function listWords($ftrows,$header, $stopWordBoxes=FALSE, $page='') 787: function listMetaphoneStat($ftrows,$header) 824: function linkWordDetails($string,$wid) 836: function linkMetaPhoneDetails($string,$metaphone) 846: function flagsMsg($flags) SECTION: Details display, words / metaphone 877: function showDetailsForWord($wid) 936: function showDetailsForMetaphone($metaphone) SECTION: Helper functions 1007: function printRemoveIndexed($phash,$alt) 1020: function printReindex($resultRow,$alt) 1035: function linkDetails($string,$phash) 1044: function linkList() 1055: function showPageDetails($string,$id) 1065: function printExtraGrListRows($extraGrListRows) 1082: function printRootlineInfo($row) 1116: function makeItemTypeIcon($it,$alt='') 1141: function utf8_to_currentCharset($string) SECTION: Reindexing 1173: function reindexPhash($phash, $pageId) 1227: function getUidRootLineForClosestTemplate($id) SECTION: SQL functions 1270: function removeIndexedPhashRow($phashList,$clearPageCache=1) 1314: function getGrListEntriesForPhash($phash,$gr_list) 1334: function processStopWords($stopWords) 1354: function processPageKeywords($pageKeywords, $pageUid) TOTAL FUNCTIONS: 30 (This index is automatically created/updated by the extension "extdeveval") Indexing class for TYPO3 frontend Kasper Skårhøj <kasperYYYY@typo3.com> tx_indexedsearch Module extension (addition to function menu) 'Indexed search statistics' for the 'indexed_search' extension. Dimitri Ebert <dimitri.ebert@dkd.de> [CLASS/FUNCTION INDEX of SCRIPT] 60: class tx_indexedsearch_modfunc2 extends t3lib_extobjbase 67: function main() 88: function showStats() 121: function listSeveralStats($title,$addwhere,$conf) 199: function extGetTreeList($id,$depth,$begin = 0,$perms_clause) 210: function &hookRequest($functionName) TOTAL FUNCTIONS: 5 (This index is automatically created/updated by the extension "extdeveval") Module extension (addition to function menu) 'Indexed search statistics' for the 'indexed_search' extension. Dimitri Ebert <dimitri.ebert@dkd.de> tx_indexedsearch Index search frontend Creates a searchform for indexed search. Indexing must be enabled for this to make sense. Kasper Skårhøj <kasperYYYY@typo3.com> -author Christian Jul Jensen <christian@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 123: class tx_indexedsearch extends tslib_pibase 168: function main($content, $conf) 200: function initialize() 413: function getSearchWords($defOp) 447: function procSearchWordsByLexer($SWArr) SECTION: Main functions 491: function doSearch($sWArr) 549: function getResultRows($sWArr,$freeIndexUid=-1) 623: function getResultRows_SQLpointer($sWArr,$freeIndexUid=-1) 647: function getDisplayResults($sWArr, $resData, $freeIndexUid=-1) 699: function compileResult($resultRows, $freeIndexUid=-1) SECTION: Searching functions (SQL) 800: function getPhashList($sWArr) 901: function execPHashListQuery($wordSel,$plusQ='') 921: function sectionTableWhere() 968: function mediaTypeWhere() 993: function languageWhere() 1005: function freeIndexUidWhere($freeIndexUid) 1046: function execFinalQuery($list,$freeIndexUid=-1) 1189: function checkResume($row) 1236: function isDescending($inverse=FALSE) 1250: function writeSearchStat($sWArr,$count,$pt) SECTION: HTML output functions 1302: function makeSearchForm($optValues) 1436: function renderSelectBoxValues($value,$optValues) 1455: function printRules() 1474: function printResultSectionLinks() 1508: function makeSectionHeader($id, $sectionTitleLinked, $countResultRows) 1529: function printResultRow($row, $headerOnly=0) 1598: function pi_list_browseresults($showResultCount=1,$addString='',$addPart='',$freeIndexUid=-1) SECTION: Support functions for HTML output (with a minimum of fixed markup) 1686: function prepareResultRowTemplateData($row, $headerOnly) 1740: function tellUsWhatIsSeachedFor($sWArr) 1774: function wrapSW($str) 1786: function renderSelectBox($name,$value,$optValues) 1810: function makePointerSelector_link($str,$p,$freeIndexUid) 1825: function makeItemTypeIcon($it,$alt='',$specRowConf) 1867: function makeRating($row) 1911: function makeDescription($row,$noMarkup=0,$lgd=180) 1942: function markupSWpartsOfString($str) 2022: function makeTitle($row) 2046: function makeInfo($row,$tmplArray) 2075: function getSpecialConfigForRow($row) 2099: function makeLanguageIndication($row) 2142: function makeAccessIndication($id) 2157: function linkPage($id,$str,$row=array(),$markUpSwParams=array()) 2201: function getRootLine($id,$pathMP='') 2216: function getFirstSysDomainRecordForPage($id) 2229: function getPathFromPageId($id,$pathMP='') 2281: function getMenu($id) 2300: function multiplePagesType($item_type) 2310: function utf8_to_currentCharset($str) 2320: function &hookRequest($functionName) TOTAL FUNCTIONS: 48 (This index is automatically created/updated by the extension "extdeveval") Index search frontend Creates a searchform for indexed search. Indexing must be enabled for this to make sense. tx_indexedsearch Kasper Skårhøj <kasperYYYY@typo3.com> This class contains unit tests for the indexer Dmitry Dulepov <dmitry.dulepov@gmail.com> Christian Kuhn <lolli@schwarzbu.ch> tx_indexedsearch Script Class for the Web > Info module This class creates the framework to which other extensions can connect their sub-modules Kasper Skårhøj <kasperYYYY@typo3.com> core Contains class for Page TSconfig wizard Revised for TYPO3 3.7 June/2004 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 74: class tx_infopagetsconfig_webinfo extends t3lib_extobjbase 82: function modMenu() 114: function main() TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Page TSconfig viewer Kasper Skårhøj <kasperYYYY@typo3.com> tx_infopagetsconfig Contains the class for the Install Tool Kasper Skårhøj <kasperYYYY@typo3.com> Ingmar Schlecht <ingmar@typo3.org> [CLASS/FUNCTION INDEX of SCRIPT] 162: class tx_install extends t3lib_install 234: function tx_install() 318: function checkPassword() 362: function loginForm() 396: function init() 574: function stepOutput() 836: function checkTheConfig() 867: function typo3conf_edit() 976: function phpinformation() SECTION: typo3temp/ manager 1079: function typo3TempManager() 1199: function getSelectorOptions($deleteType,$tt='') SECTION: cleanup manager 1231: function cleanupManager() SECTION: CONFIGURATION FORM 1299: function generateConfigForm($type='') 1367: function getDefaultConfigArrayComments($string,$mainArray=array(),$commentArray=array()) SECTION: CHECK CONFIGURATION FUNCTIONS 1419: function checkConfiguration() 1572: function check_mail($cmd='') 1611: function checkExtensions() 1673: function checkDirs() 1762: function checkImageMagick($paths) 1837: function _checkImageMagickGifCapability($path) 1880: function _checkImageMagick_getVersion($file, $path) 1915: function checkDatabase() 1977: function setupGeneral($cmd='') 2166: function writeToLocalconf_control($lines="", $showOutput=1) 2190: function outputExitBasedOnStep($content) 2206: function setLabelValueArray($arr,$type) 2246: function getFormElement($labels,$values,$fieldName,$default,$msg='') 2266: function getDatabaseList() 2290: function setupGeneralCalculate() 2387: function isTTF() SECTION: ABOUT the isXXX functions. 2436: function isGD() 2447: function isGIF() 2459: function isJPG() 2470: function isPNG() 2482: function ImageTypes() 2493: function getGDSoftwareInfo() 2505: function generallyAboutConfiguration() SECTION: IMAGE processing 2565: function checkTheImageProcessing() 3046: function isExtensionEnabled($ext, $headCode, $short) 3062: function displayTwinImage ($imageFile, $IMcommands=array(), $note='') 3130: function getTwinImageMessage($message, $label_1="", $label_2='') 3146: function formatImCmds($arr) 3167: function imagemenu() SECTION: DATABASE analysing 3209: function checkTheDatabase() 3849: function updateWizard() 3873: function updateWizard_parts($action) 3987: function getUpgradeObjInstance($className, $identifier) 4000: function isBackendAdminUser() 4023: function isBasicComplete($tLabel) 4063: function generateUpdateDatabaseForm($type, $arr_update, $arr_remove, $action_type) 4094: function getUpdateDbFormWrap($action_type, $content, $label='Write to database') 4107: function displayFields($arr, $pre=0, $label='') 4132: function displayFieldComp($arr, $arr_db) 4174: function displaySuggestions($arr, $excludeList='') 4204: function compareDatabaseAndTCA($FDsrc, $TCA, $onlyFields=0) 4262: function compareTCAandDatabase($TCA, $FDcomp) 4296: function suggestFieldDefinition($fieldInfo) 4373: function getItemArrayType($arr) 4401: function getItemBlobSize($len) 4412: function suggestTCAFieldDefinition($fieldName,$fieldInfo) 4555: function includeTCA() SECTION: GENERAL FUNCTIONS 4597: function linkIt($url,$link='') 4611: function message($head, $short_string='', $long_string='', $type=0, $force=0) 4632: function printSection($head, $short_string, $long_string, $type) 4673: function fw($str,$size=1) 4696: function fwheader($str) 4707: function wrapInCells($label,$content) 4716: function printAll() 4735: function outputWrapper($content) 4801: function menu() 4823: function stepHeader() 4865: function note123() 4879: function endNotes() 4912: function securityRisk() 4930: function alterPasswordForm() 4946: function messageBasicFinished() 4968: function setScriptName($type) 4981: function formWidth($size=48,$textarea=0,$styleOverride='') 5002: function formWidthText($size=48,$styleOverride='',$wrap='') 5018: function getBackupFilename($filename) TOTAL FUNCTIONS: 82 (This index is automatically created/updated by the extension "extdeveval") Install Tool module Kasper Skårhøj <kasperYYYY@typo3.com> Ingmar Schlecht <ingmar@typo3.org> tx_install Secure session handling for the install tool. Ernesto Baschny <ernst@cron-it.de> tx_install Provides an installation status report Ingo Renner <ingo@typo3.org> tx_install Contains the TYPO3 Backend Language class Revised for TYPO3 3.6.0 Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 88: class language 138: function init($lang,$altPath='') 183: function addModuleLabels($arr,$prefix) 209: function hscAndCharConv($lStr,$hsc) 224: function makeEntities($str) 241: function JScharCode($str) 260: function getLL($index,$hsc=0) 278: function getLLL($index,$LOCAL_LANG,$hsc=0) 299: function sL($input,$hsc=0) 344: function loadSingleTableDescription($table) 396: function includeLLFile($fileRef,$setGlobal=1,$mergeLocalOntoDefault=0) 441: function readLLfile($fileRef) 451: function localizedFileRef($fileRef) TOTAL FUNCTIONS: 12 (This index is automatically created/updated by the extension "extdeveval") Contains the TYPO3 Backend Language class For detailed information about how localization is handled, please refer to the 'Inside TYPO3' document which descibes this. This class is normally instantiated as the global variable $LANG in typo3/template.php It's only available in the backend and under certain circumstances in the frontend Kasper Skårhøj <kasperYYYY@typo3.com> core typo3/template.php, template This class provides Processing plugin implementation. Michael Miousse <michael.miousse@infoglobe.ca> Jochen Rieger <j.rieger@connecta.ag> linkvalidator This class provides Check Base plugin implementation. Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides Check External Links plugin implementation. Dimitri König <dk@cabag.ch> Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides Check File Links plugin implementation. Dimitri König <dk@cabag.ch> Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides interface implementation. Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides Check Internal Links plugin implementation. Dimitri König <dk@cabag.ch> Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides Check Link Handler plugin implementation. Dimitri König <dk@cabag.ch> Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides Scheduler plugin implementation. Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator This class provides Scheduler Additional Field plugin implementation. Dimitri König <dk@cabag.ch> Michael Miousse <michael.miousse@infoglobe.ca> linkvalidator Module 'Linkvalidator' for the 'linkvalidator' extension. Michael Miousse <michael.miousse@infoglobe.ca> Jochen Rieger <j.rieger@connecta.ag> linkvalidator Core functions for admin Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] Core functions for administration Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Web > Functions module plugin for cleaning up. Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Core functions for cleaning and analysing Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 71: class tx_lowlevel_cleaner_core extends t3lib_cli 88: function tx_lowlevel_cleaner_core() SECTION: CLI functionality 134: function cli_main($argv) 193: function cli_referenceIndexCheck() 228: function cli_noExecutionCheck($matchString) 251: function cli_printInfo($header,$res) SECTION: Page tree traversal 331: function genTree($rootID,$depth=1000,$echoLevel=0,$callBack='') 369: function genTree_traverse($rootID,$depth,$echoLevel=0,$callBack='',$versionSwapmode='',$rootIsVersion=0,$accumulatedPath='') SECTION: Helper functions 554: function infoStr($rec) TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Core functions for cleaning and analysing Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: cleanflexform User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 57: class tx_lowlevel_cleanflexform extends tx_lowlevel_cleaner_core 64: function tx_lowlevel_cleanflexform() 89: function main() 122: function main_parseTreeCallBack($tableName,$uid,$echoLevel,$versionSwapmode,$rootIsVersion) 154: function main_autoFix($resultArray) TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") cleanflexform Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Deleted records User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_deleted extends tx_lowlevel_cleaner_core 63: function tx_lowlevel_deleted() 88: function main() 116: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for Deleted records Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Double Files User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 58: class tx_lowlevel_double_files extends tx_lowlevel_cleaner_core 67: function tx_lowlevel_double_files() 99: function main() 182: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for double files Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Lost files User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_lost_files extends tx_lowlevel_cleaner_core 65: function tx_lowlevel_lost_files() 103: function main() 181: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for Lost files Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Missing files User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_missing_files extends tx_lowlevel_cleaner_core 65: function tx_lowlevel_missing_files() 98: function main() 154: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for missing files. Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Missing relations User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_missing_relations extends tx_lowlevel_cleaner_core 65: function tx_lowlevel_missing_relations() 101: function main() 173: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for missing relations. Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Orphan records User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_orphan_records extends tx_lowlevel_cleaner_core 63: function tx_lowlevel_orphan_records() 96: function main() 151: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for Orphan Records Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: RTE magicc images User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_rte_images extends tx_lowlevel_cleaner_core 65: function tx_lowlevel_rte_images() 99: function main() 181: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for RTE images integrity Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: syslog User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 57: class tx_lowlevel_cleanflexform extends tx_lowlevel_cleaner_core 64: function tx_lowlevel_cleanflexform() 89: function main() 122: function main_parseTreeCallBack($tableName,$uid,$echoLevel,$versionSwapmode,$rootIsVersion) 154: function main_autoFix($resultArray) TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") syslog Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Cleaner module: Versions of records User function called from tx_lowlevel_cleaner_core configured in ext_localconf.php Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_lowlevel_versions extends tx_lowlevel_cleaner_core 63: function tx_lowlevel_versions() 88: function main() 122: function main_autoFix($resultArray) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Looking for versions of records Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Script class for the Config module Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Script class for the DB int module Kasper Skårhøj <kasperYYYY@typo3.com> tx_lowlevel Adding a list of all open documents of a user to the backend.php Benjamin Mack <benni@typo3.org> Ingo Renner <ingo@typo3.org> opendocs This class is a TYPO3-specific OpenID store. Dmitry Dulepov <dmitry.dulepov@gmail.com> tx_openid [CLASS/FUNCTION INDEX of SCRIPT] 57: class tx_openid_sv1 extends t3lib_svbase 92: public function init() 119: public function initAuth($subType, array $loginData, array $authenticationInformation, t3lib_userAuth &$parentObject) 139: public function getUser() 176: public function authUser(array $userRecord) 221: protected function includePHPOpenIDLibrary() 250: protected function getUserRecord($openIDIdentifier) 273: protected function getOpenIDConsumer() 300: protected function sendOpenIDRequest() 368: protected function getReturnURL() 414: protected function writeLog($message) TOTAL FUNCTIONS: 10 (This index is automatically created/updated by the extension "extdeveval") Service "OpenID Authentication" for the "openid" extension. Dmitry Dulepov <dmitry@typo3.org> tx_openid 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 Andreas Kundoch <typo3@mehrwert.de> core GPL TYPO3_4-2 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. Kasper Skårhøj <kasperYYYY@typo3.com> Andreas Kundoch <typo3@mehrwert.de> core Script Class for the Web > List module; rendering the listing of records on a page Kasper Skårhøj <kasperYYYY@typo3.com> core Controller class for the 'recycler' extension. Handles the AJAX Requests Julian Kleinhans <typo3@kj187.de> Erik Frister <erik_frister@otq-solutions.com> tx_recycler Helper class for the 'recycler' extension. Julian Kleinhans <typo3@kj187.de> tx_recycler Model class for the 'recycler' extension. Julian Kleinhans <typo3@kj187.de> tx_recycler Model class for the 'recycler' extension. Julian Kleinhans <typo3@kj187.de> tx_recycler Deleted Records View Erik Frister <erik_frister@otq-solutions.com> Julian Kleinhans <typo3@kj187.de> tx_recycler Module 'Recycler' for the 'recycler' extension. Julian Kleinhans <typo3@kj187.de> tx_recycler Interface for classes which provide a report. Ingo Renner <ingo@typo3.org> tx_reports Interface for classes which provide a status report entry. Ingo Renner <ingo@typo3.org> tx_reports Module 'Reports' for the 'reports' extension. Ingo Renner <ingo@typo3.org> tx_reports The status report Ingo Renner <ingo@typo3.org> reports Performs some checks about the install tool protection status Ingo Renner <ingo@typo3.org> reports Performs several checks about the system's health Ingo Renner <ingo@typo3.org> reports A class representing a certain status Ingo Renner <ingo@typo3.org> reports Performs several checks about the system's health Ingo Renner <ingo@typo3.org> reports Performs basic checks about the TYPO3 install Ingo Renner <ingo@typo3.org> reports Post processes the warning messages found in about modules. Ingo Renner <ingo@typo3.org> reports A task that should be run regularly to determine the system's status. Ingo Renner <ingo@typo3.org> reports Additional field to set the notification email address(es) for system health issue notifications. Ingo Renner <ingo@typo3.org> reports [CLASS/FUNCTION INDEX of SCRIPT] This class contains a hook to the backend warnings collection. It checks RSA configuration and create a warning if the configuration is wrong. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a hook to implement RSA authentication for the TYPO3 Frontend. Warning: felogin must be USER_INT for this to work! Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class provides a hook to the login form to add extra javascript code and supply a proper form tag. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains an abstract SSL backend for the TYPO3 RSA authentication service. There are two steps:prepare data for encodingdecode incoming data To prepare data for encoding, the createNewKeyPair() method should be called. This method returns an instance of tx_rsaauth_keypair class, which contains the private and public keys. Public key is sent to the client to encode data. Private key should be stored somewhere (preferrably in user's session). To decode data, the decrypt() method should be called with the private key created at the previous step and the data to decode. If the data is decoded successfully, the result is a string. Otherwise it is null. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a factory for the RSA backends. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a OpenSSL backend for the TYPO3 RSA authentication service. It uses shell version of OpenSSL to perform tasks. See class tx_rsaauth_abstract_backend for the information on using backends. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contain an RSA keypair class. Its purpose is to keep to keys and trasnfer these keys between other PHP classes. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a PHP OpenSSL backend for the TYPO3 RSA authentication service. See class tx_rsaauth_abstract_backend for the information on using backends. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] Service "RSA authentication" for the "rsaauth" extension. This service will authenticate a user using hos password encoded with one time public key. It uses the standard TYPO3 service to do all dirty work. Firsts, it will decode the password and then pass it to the parent service ('sv'). This ensures that it always works, even if other TYPO3 internals change. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains the abstract storage for the RSA private keys Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a session-based storage for private keys. This storage is not secure enough because its implementation stores keys completely in the PHP sessions. PHP sessions usually store data in the file system and it is easy to extract. This storage is useful only as an example. It is better to use "split" storage for keys. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a "split" storage for the data. It keeps part of the data in the database, part in the database. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth [CLASS/FUNCTION INDEX of SCRIPT] This class contains a factory for the RSA backends. Dmitry Dulepov <dmitry@typo3.org> tx_rsaauth Extending class to render the menu for the cache clearing actions, and adding Clear RTE cache option Ingo Renner <ingo@typo3.org> Steffen kamper <info@sk-typo3.de> Class to clear temp files of htmlArea RTE Steffen kamper <info@sk-typo3.de> 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! Adapted for htmlArea RTE by Stanislas Rolland Kasper Skårhøj <kasperYYYY@typo3.com> Stanislas Rolland <typo3(arobas)sjbr.ca> Class which generates the page tree Kasper Skårhøj <kasperYYYY@typo3.com> core Displays image selector for the RTE Kasper Skårhøj <kasper@typo3.com> Stanislas Rolland <typo3(arobas)sjbr.ca> * Local Folder Tree Kasper Skårhøj <kasper@typo3.com> tx_rte Script Class Kasper Skårhøj <kasper@typo3.com> tx_rte Contains class "tx_saltedpasswords_div" that provides various helper functions. General library class. Marcus Krause <marcus#exp2009.info> Steffen Ritter <info@rs-websystems.de> 2009-06-14 tx_saltedpasswords class providing configuration checks for saltedpasswords. Steffen Ritter <info@rs-websystems.de> 2009-09-04 tx_saltedpasswords Class implementing salted evaluation methods. Marcus Krause <marcus#exp2009.info> Steffen Ritter <info@rs-websystems.de> 2009-06-14 tx_saltedpasswords Class implementing salted evaluation methods for BE users. Marcus Krause <marcus#exp2009.info> Steffen Ritter <info@rs-websystems.de> 2009-06-14 tx_saltedpasswords Class implementing salted evaluation methods for FE users. Marcus Krause <marcus#exp2009.info> Steffen Ritter <info@rs-websystems.de> 2009-06-14 tx_saltedpasswords Contains abstract class "tx_saltedpasswords_abstract_salts" to be used in classes that provide salted hashing. Abtract class with methods needed to be extended in a salted hashing class. Marcus Krause <marcus#exp2009.info> 2009-09-06 tx_saltedpasswords Contains class "tx_saltedpasswords_salts_blowfish" that provides Blowfish salted hashing. Class that implements Blowfish salted hashing based on PHP's crypt() function. Warning: Blowfish salted hashing with PHP's crypt() is not available on every system. Marcus Krause <marcus#exp2009.info> 2009-09-06 tx_saltedpasswords Contains class "tx_saltedpasswords_salts_factory" that provides a salted hashing method factory. Class that implements Blowfish salted hashing based on PHP's crypt() function. Marcus Krause <marcus#exp2009.info> 2009-09-06 tx_saltedpasswords Contains class "tx_saltedpasswords_salts_md5" that provides MD5 salted hashing. Class that implements MD5 salted hashing based on PHP's crypt() function. MD5 salted hashing with PHP's crypt() should be available on most of the systems. Marcus Krause <marcus#exp2009.info> 2009-09-06 tx_saltedpasswords Contains class "tx_saltedpasswords_salts_phpass" that provides PHPass salted hashing. Derived from Drupal CMS original license: GNU General Public License (GPL) http://drupal.org/node/29706/ Based on the Portable PHP password hashing framework original license: Public Domain http://www.openwall.com/phpass/ Class that implements PHPass salted hashing based on Drupal's modified Openwall implementation. PHPass should work on every system. Marcus Krause <marcus#exp2009.info> 2009-09-06 tx_saltedpasswords Contains interface "tx_saltedpasswords_salts" to be used in classes that provide salted hashing. Interface with public methods needed to be implemented in a salting hashing class. Marcus Krause <marcus#exp2009.info> Steffen Ritter <info@rs-websystems.de> 2009-09-06 tx_saltedpasswords Update plaintext and hashed passwords of existing users to salted passwords. Christian Kuhn <lolli@schwarzbu.ch> Marcus Krause <marcus#exp2010.info> saltedpasswords Contains authentication service class for salted hashed passwords. Class implements salted-password hashes authentication service. Marcus Krause <marcus#exp2009.info> Steffen Ritter <info@rs-websystems.de> 2009-06-14 tx_saltedpasswords Contains testcases for "tx_saltedpasswords_div" that provides various helper functions. Testcases for class tx_saltedpasswords_div. Marcus Krause <marcus#exp2009.info> tx_saltedpasswords Contains class "tx_saltedpasswords_salts_blowfish" that provides Blowfish salted hashing. Testcases for class tx_saltedpasswords_salts_blowfish. Marcus Krause <marcus#exp2009.info> tx_saltedpasswords Contains class "tx_saltedpasswords_salts_factory" that provides a salted hashing method factory. Testcases for class tx_saltedpasswords_salts_factory. Marcus Krause <marcus#exp2009.info> 2009-09-06 tx_saltedpasswords Contains testcases for "tx_saltedpasswords_salts_md5" that provides MD5 salted hashing. Testcases for class tx_saltedpasswords_salts_md5. Marcus Krause <marcus#exp2009.info> tx_saltedpasswords Contains testcases for "tx_saltedpasswords_salts_phpass" that provides PHPass salted hashing. Testcases for class tx_saltedpasswords_salts_phpass. Marcus Krause <marcus#exp2009.info> tx_saltedpasswords TYPO3 Scheduler. This class handles scheduling and execution of tasks. Formerly known as "Gabriel TYPO3 arch angel" François Suter <francois@typo3.org> Christian Jul Jensen <julle@typo3.org> tx_scheduler This class provides calulations for the cron command format. Markus Friedrich <markus.friedrich@dkd.de> Christian Kuhn <lolli@schwarzbu.ch> tx_scheduler Validate and normalize a cron command. Special fields like three letter weekdays, ranges and steps are substituted to a comma separated list of integers. Example: '2-4 10-40/10 * mar * fri' will be nolmalized to '2,4 10,20,30,40 * * 3 1,2' Christian Kuhn <lolli@schwarzbu.ch> scheduler This class manages the logic of a particular execution of a task François Suter <francois@typo3.org> Christian Jul Jensen <julle@typo3.org> Markus Friedrich <markus.friedrich@dkd.de> tx_scheduler Failed execution exception Ingo Renner <ingo@typo3.org> scheduler This is the base class for all Scheduler tasks It's an abstract class, not designed to be instantiated directly All Scheduler tasks should inherit from this class François Suter <francois@typo3.org> Christian Jul Jensen <julle@typo3.org> tx_scheduler Starts all due tasks, used by the command line interface This script must be included by the "CLI module dispatcher" Markus Friedrich <markus.friedrich@dkd.de> tx_scheduler Class "tx_scheduler_SleepTask" provides a task that sleeps for some time This is useful for testing parallel executions François Suter <francois@typo3.org> tx_scheduler Aditional fields provider class for usage with the Scheduler's sleep task François Suter <francois@typo3.org> tx_scheduler Class "tx_scheduler_TestTask" provides testing procedures Markus Friedrich <markus.friedrich@dkd.de> tx_scheduler Aditional fields provider class for usage with the Scheduler's test task François Suter <francois@typo3.org> tx_scheduler Interface for classes who want to provide additional fields when adding a task Ingo Renner <ingo@typo3.org> tx_scheduler Module 'TYPO3 Scheduler administration module' for the 'scheduler' extension. François Suter <francois@typo3.org> Christian Jul Jensen <julle@typo3.org> Ingo Renner <ingo@typo3.org> tx_scheduler Garbage collection of caching framework cache backends. This task finds all configured caching framework caches and calls the garbage collection of a cache if the cache backend is configured to be cleaned. Christian Kuhn <lolli@schwarzbu.ch> scheduler Additional BE fields for caching framework garbage collection task. Creates a multi selectbox with all available cache backends to select from. Christian Kuhn <lolli@schwarzbu.ch> scheduler Testcase for class "tx_scheduler_CachingFrameworkGarbageCollection" tx_scheduler Christian Kuhn <lolli@schwarzbu.ch> Test case for class "tx_scheduler_CronCmd_Normalize" Christian Kuhn <lolli@schwarzbu.ch> tx_scheduler Testcase for class "tx_scheduler_CronCmd" tx_scheduler Christian Kuhn <lolli@schwarzbu.ch> Script class for the Setup module Kasper Skårhøj <kasperYYYY@typo3.com> tx_setup FE admin lib Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 132: class user_feAdmin 179: function init($content,$conf) SECTION: Data processing 423: function parseValues() 518: function processFiles($cmdParts,$theField) 624: function overrideValues() 640: function defaultValues() 659: function evalValues() 781: function userProcess($mConfKey,$passVar) 799: function userProcess_alt($confVal,$confArr,$passVar) SECTION: Database manipulation functions 841: function save() 899: function deleteRecord() 929: function deleteFilesFromRecord($uid) SECTION: Command "display" functions 986: function displayDeleteScreen() 1014: function displayCreateScreen() 1037: function displayEditScreen() 1088: function displayEditForm($origArr) 1116: function procesSetFixed() SECTION: Template processing functions 1205: function removeRequired($templateCode,$failure) 1223: function getPlainTemplate($key,$r='') 1240: function modifyDataArrForFormUpdate($inputArr) 1309: function setCObjects($templateCode,$currentArr=array(),$markerArray='',$specialPrefix='') SECTION: Emailing 1371: function sendInfoMail() 1419: function compileMail($key, $DBrows, $recipient, $setFixedConfig=array()) 1465: function sendMail($recipient, $admin, $content='', $adminContent='') 1510: function isHTMLContent($c) 1531: function sendHTMLMail($content,$recipient,$dummy,$fromEmail,$fromName,$replyTo='') SECTION: Various helper functions 1615: function aCAuth($r) 1629: function authCode($r,$extra='') 1655: function setfixed($markerArray, $setfixed, $r) 1693: function setfixedHash($recCopy,$fields='') 1714: function isPreview() 1723: function createFileFuncObj() 1734: function clearCacheIfSet() 1749: function getFailure($theField, $theCmd, $label) TOTAL FUNCTIONS: 33 (This index is automatically created/updated by the extension "extdeveval") This library provides a HTML-template file based framework for Front End creating/editing/deleting records authenticated by email or fe_user login. It is used in the extensions "direct_mail_subscription" and "feuser_admin" (and the deprecated(!) static template "plugin.feadmin.dmailsubscription" and "plugin.feadmin.fe_users" which are the old versions of these two extensions) Further the extensions "t3consultancies" and "t3references" also uses this library but contrary to the "direct_mail_subscription" and "feuser_admin" extensions which relies on external HTML templates which must be adapted these two extensions delivers the HTML template code from inside. Generally the fe_adminLib appears to be hard to use. Personally I feel turned off by all the template-file work involved and since it is very feature rich (and for that sake pretty stable!) there are lots of things that can go wrong - you feel. Therefore I like the concept used by "t3consultancies"/"t3references" since those extensions uses the library by supplying the HTML-template code automatically. Suggestions for improvement and streamlining is welcome so this powerful class could be used more and effectively. Kasper Skårhøj <kasperYYYY@typo3.com> tslib http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=396&cHash=d267c36546 Contains the GMENU_FOLDOUT extension class, tslib_gmenu_foldout Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 80: class tslib_gmenu_foldout extends tslib_gmenu 96: function extProc_init() 117: function extProc_beforeLinking($key) 134: function extProc_afterLinking($key) 160: function extProc_finish() TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Class extension tslib_gmenu for the creation of DHTML foldout menus Kasper Skårhøj <kasperYYYY@typo3.com> tslib http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=386&cHash=f69ab462e2 Contains the GMENU_LAYERS extension class, tslib_gmenu_layers Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 84: class tslib_gmenu_layers extends tslib_gmenu 116: function extProc_init() 134: function extProc_RO($key) 150: function extProc_beforeLinking($key) 205: function extProc_afterLinking($key) 240: function extProc_beforeAllWrap($item,$key) 253: function isSetIntval($in) 262: function extProc_finish () 444: function extCalcBorderWithin($kind,$integer) TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Class extending tslib_gmenu for the creation of DHTML menus NOTICE: The contents of this class is made so that it can be copied EXACTLY AS IS to the tmenu_layers class! See notes in class (for BEGIN/END) and also "diff.xmenu_layers.txt" Kasper Skårhøj <kasperYYYY@typo3.com> tslib http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=385&cHash=648519dd66 diff.xmenu_layers.txt Generating plain text content of content elements for Direct Mails Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 123: class user_plaintext 137: function main_plaintext($content,$conf) 209: function getMenuSitemap() 220: function getShortcut() 231: function getHTML($str=array()) 241: function getHeader() 251: function getImages() 262: function parseBody($str) 284: function renderUploads($str,$upload_path='uploads/media/') 302: function renderHeader($str,$type=0) 353: function pad($lines,$preLineChar,$len) 369: function breakContent($str) 385: function breakBulletlist($str) 416: function breakTable($str) 472: function addDiv($messure,$content,$divChar,$joinChar,$cols) 488: function traverseTable($tableLines) 515: function renderImages($str,$links,$caption,$upload_path='uploads/pics/') 554: function getLink($ll) 571: function breakLines($str,$implChar="\n",$charWidth=0) 583: function getString($str) 595: function userProcess($mConfKey,$passVar) 613: function atag_to_http($content,$conf) 632: function typolist($content,$conf) 647: function typohead($content,$conf) 666: function typocode($content,$conf) TOTAL FUNCTIONS: 24 (This index is automatically created/updated by the extension "extdeveval") Alternative rendering of content elements for Plain Text emails. That means text-only output. No HTML at all. Used by the Direct Mail extension. Normally the plain text output should appear with type=99. To use this library you can include the static template "plugin.alt.plaintext" ## Insert DMailer Boundaries for all elements. config.insertDmailerBoundaries = 1 includeLibs.plaintextLib = media/scripts/plaintextLib.inc ## Set up page/type number: alt_plaintext > alt_plaintext = PAGE alt_plaintext.typeNum=99 alt_plaintext.config.disableAllHeaderCode = 1 alt_plaintext.10 = TEMPLATE alt_plaintext.10 { template = FILE template.file = {$plugin.alt.plaintext.file.template} marks.CONTENT < styles.content.get marks.CONTENT.renderObj = < lib.alt_plaintext.renderObj marks.DATE = TEXT marks.DATE.data = date:U marks.DATE.strftime = e. B Y } (And then also "lib.alt_plaintext.renderObj" is configured extensively - basically with the TypoScript options passed to this class. See the static template "plugin.alt.plaintext") Kasper Skårhøj <kasperYYYY@typo3.com> tslib http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=398&cHash=e3024de334 Contains the TMENU_LAYERS extension class, tslib_tmenu_layers Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 84: class tslib_tmenu_layers extends tslib_tmenu 116: function extProc_init() 134: function extProc_RO($key) 150: function extProc_beforeLinking($key) 205: function extProc_afterLinking($key) 240: function extProc_beforeAllWrap($item,$key) 253: function isSetIntval($in) 262: function extProc_finish () 444: function extCalcBorderWithin($kind,$integer) TOTAL FUNCTIONS: 8 (This index is automatically created/updated by the extension "extdeveval") Class extending tslib_tmenu for the creation of text based DHTML menus NOTICE: The contents of this class is copied EXACTLY AS IS from gmenu_layers class! See notes in class (for BEGIN/END) and also 'diff.xmenu_layers.txt' Kasper Skårhøj <kasperYYYY@typo3.com> tslib http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=385&cHash=648519dd66 diff.xmenu_layers.txt Contains class for creating WAP pages for TYPO3 Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 129: class user_wapversion 141: function main_wapversion($content,$conf) 200: function contentAbstract() 217: function contentAll($chunkLgd=850) 277: function cHeader($str) 291: function cBodytext($str,$start=0,$max=0) 303: function nl2br($str) 314: function getContentResult($table) 329: function bold($str) 339: function paragraph($str) 349: function line($str) 360: function navLink($str,$pointer) 370: function menuCurrentLevel($indent) 405: function link($str,$id,$deck='') 421: function cleanMenuArray($menu) TOTAL FUNCTIONS: 14 (This index is automatically created/updated by the extension "extdeveval") Class that creates the current page and content element records as an WML structure using the library "t3lib_xml" It is demonstrated in use in the testsite package on page "59" The static template "plugin.alt.wap" is used to trigger this WML creation as well. That template contains this set of TypoScript lines which triggers the WML creation and disables all regular HTML headers ## Set up page/type: alt_wap > alt_wap = PAGE alt_wap { typeNum=97 config.disableAllHeaderCode = 1 config.additionalHeaders = Content-type: text/vnd.wap.wml ## Includes the newsLib: includeLibs.alt_wap = media/scripts/wapversionLib.inc ## Inserting the USER cObject for WAP/XML rendering 10 = USER 10 { userFunc = user_wapversion->main_wapversion debug=0 preTitle = T3WAP navLabels.prev = Prev navLabels.next = Next navLabels.up = Up } } NOTICE: In the static template "plugin.alt.wap" there is a part in the end looking like this: ## If the browser is a WAP-device, [device=wap] alt_wap.typeNum=0 [global] This means that IF the device coming to the URL is a WAP device they will get wap content even if they don't specify "&type=97" since the typeNum is changed to zero here! In fact they CANNOT get any wap-content at "&type=97" anymore! This has been a source of error and confusion for many people tslib Kasper Skårhøj <kasperYYYY@typo3.com> Example class showing how one could make XML export of page content elements in TYPO3 Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 96: class user_xmlversion 107: function main_xmlversion($content,$conf) 137: function getContentResult($table) TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") Class that creates the current page and content element records as an XML structure using the library "t3lib_xml" It is demonstrated in use in the testsite package on page "59" The static template "plugin.alt.xml" is used to trigger this XML creation as well. That template contains this set of TypoScript lines which triggers the XML creation and disables all regular HTML headers ## Set up page/type number: alt_xml > alt_xml = PAGE alt_xml { typeNum=96 config.disableAllHeaderCode = 1 config.additionalHeaders = Content-type: text/xml ## Includes the newsLib: includeLibs.alt_xml = media/scripts/xmlversionLib.inc ## Inserting the USER cObject for XML rendering 10 = USER 10 { userFunc = user_xmlversion->main_xmlversion } } tslib Kasper Skårhøj <kasperYYYY@typo3.com> Service 'User authentication' for the 'sv' extension. René Fritz <r.fritz@colorcube.de> [CLASS/FUNCTION INDEX of SCRIPT] 56: class tx_sv_auth extends tx_sv_authbase 64: function getUser() 89: function authUser($user) 129: function getGroups($user, $knownGroups) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Authentication services class René Fritz <r.fritz@colorcube.de> tx_sv Service base class for 'User authentication'. René Fritz <r.fritz@colorcube.de> [CLASS/FUNCTION INDEX of SCRIPT] 62: class tx_sv_authbase extends t3lib_svbase 87: function initAuth($mode, $loginData, $authInfo, &$pObj) 110: function compareUident($user, $loginData, $security_level='') 129: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='') SECTION: create/update user - EXPERIMENTAL 158: function fetchUserRecord($username, $extraWhere='', $dbUserSetup='') TOTAL FUNCTIONS: 4 (This index is automatically created/updated by the extension "extdeveval") Authentication services class René Fritz <r.fritz@colorcube.de> tx_sv [CLASS/FUNCTION INDEX of SCRIPT] This class contains a BE login form hook. It adds all necessary JavaScript for the superchallenged authentication. Dmitry Dulepov <dmitry@typo3.org> tx_sv This class provides a report displaying a list of all installed services Code inspired by EXT:dam/lib/class.tx_dam_svlist.php by René Fritz Francois Suter <francois@typo3.org> sv This class provides a task for the taskcenter Kasper Skårhøj <kasperYYYY@typo3.com> Georg Ringer <typo3@ringerge.org> tx_sysaction Adds action links to the backend's toolbar Steffen Kamper <info@sk-typo3.de> tx_sysaction Loads TSref information from a XML file an responds to an AJAX call. Refactor and correct phpDoc comments Stephan Petzl <spetzl@gmx.at> Christian Kartnig <office@hahnepeter.de> Status of tasks Georg Ringer <typo3@ringerge.org> taskcenter Interface for classes which provide a task. Georg Ringer <typo3@ringerge.org tx_taskcenter This class provides a taskcenter for BE users Georg Ringer <typo3@ringerge.org> taskcenter Module 'TypoScript Help' for the 'tsconfig_help' extension. Stephane Schitter <stephane.schitter@free.fr> tx_tsconfighelp This class displays the submodule "TypoScript Object Browser" inside the Web > Template module Kasper Skårhøj <kasperYYYY@typo3.com> tx_tstemplateobjbrowser Addition of the versioning item to the clickmenu Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 54: class tx_version_cm1 65: function main(&$backRef,$menuItems,$table,$uid) 111: function includeLL() TOTAL FUNCTIONS: 2 (This index is automatically created/updated by the extension "extdeveval") "Versioning" item added to click menu of elements. Kasper Skårhøj <kasperYYYY@typo3.com> core Versioning module, including workspace management Kasper Skårhøj <kasperYYYY@typo3.com> core This class provides a wrapper around the autopublication mechanism of workspaces, as a Scheduler task François Suter <francois@typo3.org> tx_version Library with Workspace related functionality Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 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 Kasper Skårhøj <kasperYYYY@typo3.com> 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. Kasper Skårhøj <kasperYYYY@typo3.com> Dmitry Dulepov <dmitry@typo3.org> core Module: Workspace manager Kasper Skårhøj <kasperYYYY@typo3.com> core Module: Workspace forms for editing/creating workspaces. Dmitry Dulepov <typo3@fm-world.ru> 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() Kasper Skårhøj <kasperYYYY@typo3.com> core Script Class for the Web > View Kasper Skårhøj <kasperYYYY@typo3.com> core Contains class for "Create pages" wizard Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 70: class tx_wizardcrpages_webfunc_2 extends t3lib_extobjbase 78: function modMenu() 95: function main() 179: function helpBubble() TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Creates the "Create pages" wizard Kasper Skårhøj <kasperYYYY@typo3.com> tx_wizardcrpages Contains class for "Sort pages" wizard Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj XHTML compliant Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 67: class tx_wizardsortpages_webfunc_2 extends t3lib_extobjbase 75: function modMenu() 88: function main() 175: function wiz_linkOrder($title,$order) TOTAL FUNCTIONS: 3 (This index is automatically created/updated by the extension "extdeveval") Creates the "Sort pages" wizard Kasper Skårhøj <kasperYYYY@typo3.com> tx_wizardsortpages 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 Skårhøj Kasper Skårhøj <kasperYYYY@typo3.com> [CLASS/FUNCTION INDEX of SCRIPT] 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. Kasper Skårhøj <kasperYYYY@typo3.com> 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. Kasper Skårhøj <kasperYYYY@typo3.com> core Extension of the parse_html class. Kasper Skårhøj <kasperYYYY@typo3.com> 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. Kasper Skårhøj <kasperYYYY@typo3.com> core Script Class for adding new items to a group/select field. Performs proper redirection as needed. Kasper Skårhøj <kasperYYYY@typo3.com> core Script Class for colorpicker wizard Mathias Schreiber <schreiber@wmdb.de> Peter Kühn <peter@kuehn.com> Kasper Skårhøj <typo3@typo3.com> core Script Class for redirecting a backend user to the editing form when an "Edit wizard" link was clicked in TCEforms somewhere Kasper Skårhøj <kasperYYYY@typo3.com> 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: <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.7.5.1