Files: 60
Total filesizes: 2.3 Mbytes
Functions and classes: 1574
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/
@todo: Need to really extend this class when the tcemain library has been updated and the whole API is better defined. There are some known bugs in this library. Further it would be nice with a facility to not only analyze but also clean up!
@package: TYPO3
@subpackage: t3lib
TYPO3 XMLHTTP class (new in TYPO3 4.0.0)
This class contains two main parts:
(1) generation of JavaScript code which creates an XMLHTTP object in a cross-browser manner
(2) generation of XML data as a reply
@package: TYPO3
@subpackage: t3lib
Class for displaying an array as a tree
See the extension 'lowlevel' /config (Backend module 'Tools > Configuration')
@package: TYPO3
@subpackage: t3lib
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
@package: TYPO3
@subpackage: t3lib
This class holds some functions used to display the sys_log table-content.
Used in the status-scripts and the log-module.
@package: TYPO3
@subpackage: t3lib
Standard functions available for the TYPO3 backend.
Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: t3lib
Extension class for the t3lib_treeView class, specially made for browsing pages
@package: TYPO3
@subpackage: t3lib
TYPO3 clipboard for records and files
@package: TYPO3
@subpackage: t3lib
Class for conversion between charsets
@package: TYPO3
@subpackage: t3lib
TYPO3 "database wrapper" class (new in 3.6.0)
This class contains
- abstraction functions for executing INSERT/UPDATE/DELETE/SELECT queries ("Query execution"; These are REQUIRED for all future connectivity to the database, thus ensuring DBAL compliance!)
- functions for building SQL queries (INSERT/UPDATE/DELETE/SELECT) ("Query building"); These are transitional functions for building SQL queries in a more automated way. Use these to build queries instead of doing it manually in your code!
- mysql() wrapper functions; These are transitional functions. By a simple search/replace you should be able to substitute all mysql*() calls with $GLOBALS['TYPO3_DB']->sql*() and your application will work out of the box. YOU CANNOT (legally) use any mysql functions not found as wrapper functions in this class!
See the Project Coding Guidelines (doc_core_cgl) for more instructions on best-practise
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:
- To direct all database calls through this class so it becomes possible to implement DBAL with extensions.
- To keep it very easy to use for developers used to MySQL in PHP - and preserve as much performance as possible when TYPO3 is used with MySQL directly...
- To create an interface for DBAL implemented by extensions; (Eg. making possible escaping characters, clob/blob handling, reserved words handling)
- Benchmarking the DB bottleneck queries will become much easier; Will make it easier to find optimization possibilities.
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()
@package: TYPO3
@subpackage: t3lib
This class has functions which generates a difference output of a content string
@package: TYPO3
@subpackage: 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()'
@package: TYPO3
@subpackage: t3lib
@todo: Possible improvement: Should it rawurldecode the string first to check if any of these characters is encoded ?
returns exec command for a program
or false
This class is meant to be used without instance:
$cmd = t3lib_exec::getCommand ('awstats','perl');
The data of this class is hold in a global variable. Doing it this way the setup is cached.
That means if a program is found once it don't have to be searched again.
user functions:
addPaths() could be used to extend the search paths
getCommand() get a command string
checkCommand() returns true if a command is available
Search paths that are included:
$TYPO3_CONF_VARS['GFX']['im_path_lzw'] or $TYPO3_CONF_VARS['GFX']['im_path']
$TYPO3_CONF_VARS['SYS']['binPath']
$GLOBALS['_SERVER']['PATH']
'/usr/bin/,/usr/local/bin/' on Unix
binaries can be preconfigured with
$TYPO3_CONF_VARS['SYS']['binSetup']
@package: TYPO3
@subpackage: t3lib
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 the php3/php-extension.
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/'
@package: TYPO3
@subpackage: t3lib
Extension Management functions
This class is never instantiated, rather the methods inside is called as functions like
t3lib_extMgm::isLoaded('my_extension');
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: t3lib
Contains functions for manipulating flex form data
@package: TYPO3
@subpackage: t3lib
Extension class for the t3lib_treeView class, specially made for browsing folders in the File module
@package: TYPO3
@subpackage: t3lib
Formmail class, used by the TYPO3 "cms" extension (default frontend) to send email forms.
@package: TYPO3
@subpackage: 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.
@package: TYPO3
@subpackage: t3lib
HTML mail class
@package: TYPO3
@subpackage: t3lib
Icon generation, backend
This library has functions that returns - and if necessary creates - the icon for an element in TYPO3
Expects global vars:
- $BACK_PATH
- PATH_typo3
- $TCA, $PAGES_TYPES
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()"
@package: TYPO3
@subpackage: t3lib
Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: t3lib
Load Backend Interface modules
Typically instantiated like this:
$this->loadModules = t3lib_div::makeInstance('t3lib_loadModules');
$this->loadModules->load($TBE_MODULES);
@package: TYPO3
@subpackage: t3lib
Matching TypoScript conditions
Used with the TypoScript parser.
Matches browserinfo, IPnumbers for use with templates
@package: TYPO3
@subpackage: t3lib
Manage storing and restoring of $GLOBALS['SOBE']->MOD_SETTINGS settings.
Provides a presets box for BE modules.
@package: TYPO3
@subpackage: t3lib
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
@package: TYPO3
@subpackage: t3lib
Class for generating a page tree.
@package: TYPO3
@subpackage: t3lib
Functions for parsing HTML.
You are encouraged to use this class in your own applications
@package: TYPO3
@subpackage: t3lib
Class for parsing HTML for the Rich Text Editor. (also called transformations)
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: t3lib
Class for generating front end for building queries
@package: TYPO3
@subpackage: t3lib
Functions used to read email content
The class is still just a bunch of miscellaneous functions used to read content out of emails
@package: TYPO3
@subpackage: t3lib
This class is the base for listing of database records and files in the modules Web>List and File>Filelist
@package: TYPO3
@subpackage: t3lib
Reference index processing and relation extraction
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: t3lib
Parent class for 'ScriptClasses' in backend modules.
See example comment above.
@package: TYPO3
@subpackage: t3lib
Class for processing of the default soft reference types for CMS:
- 'substitute' : A full field value targeted for manual substitution (for import /export features)
- 'notify' : Just report if a value is found, nothing more.
- 'images' : HTML <img> tags for RTE images / images from fileadmin/
- 'typolink' : references to page id or file, possibly with anchor/target, possibly commaseparated list.
- 'typolink_tag' : As typolink, but searching for <link> tag to encapsulate it.
- 'TSconfig' processing (filerefs? Domains? what do we know...)
- 'TStemplate' : freetext references to "fileadmin/" files.
- 'email' : Email highlight
- 'url' : URL highlights (with a scheme)
@package: TYPO3
@subpackage: t3lib
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!
@package: TYPO3
@subpackage: t3lib
@todo: Table locking tools?
@todo: Table locking tools?
@package: TYPO3
@subpackage: t3lib
TYPO3 SQL parser class.
@package: TYPO3
@subpackage: t3lib
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
@package: TYPO3
@subpackage: t3lib
Super Admin class has functions for the administration of multiple TYPO3 sites in folders
See 'misc/superadmin.php' for details on how to use!
$Id: class.t3lib_superadmin.php,v 1.13.6.2 2006/03/18 20:57:38 masi Exp $
Revised for TYPO3 3.6 February/2004 by Kasper Skaarhoj
XHTML Compliant
@package: TYPO3
@subpackage: t3lib
Parent class for "Services" classes
@package: TYPO3
@subpackage: t3lib
Syntax Highlighting class.
@package: TYPO3
@subpackage: t3lib
'TCEforms' - Class for creating the backend editing forms.
@package: TYPO3
@subpackage: t3lib
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:
- $GLOBALS['TCA'] must exist
- $GLOBALS['LANG'] (languageobject) may be preferred, but not fatal.
tce_db.php for further comments and SYNTAX! Also see document 'TYPO3 Core API' for details.
@package: TYPO3
@subpackage: t3lib
Frontend Timetracking functions
Is used to register how much time is used with operations in TypoScript
Used by index_ts
@package: TYPO3
@subpackage: t3lib
Class for getting and transforming data for display in backend forms (TCEforms)
@package: TYPO3
@subpackage: t3lib
Base class for creating a browsable array/page/folder tree in HTML
@package: TYPO3
@subpackage: t3lib
TYPO3 backend user authentication in the TSFE frontend.
This includes mainly functions related to the Admin Panel
@package: TYPO3
@subpackage: t3lib
The TypoScript parser
@package: TYPO3
@subpackage: t3lib
TSParser extension class to t3lib_TStemplate
@package: TYPO3
@subpackage: t3lib
Provides a simplified layer for making Constant Editor style configuration forms
@package: TYPO3
@subpackage: t3lib
Template object that is responsible for generating the TypoScript template based on template records.
@package: TYPO3
@subpackage: t3lib
@todo: Apply caching to the parsed Page TSconfig. This is done in the other similar functions for both frontend and backend. However, since this functions works for BOTH frontend and backend we will have to either write our own local caching function or (more likely) detect if we are in FE or BE and use caching functions accordingly. Not having caching affects mostly the backend modules inside the "Template" module since the overhead in the frontend is only seen when TypoScript templates are parsed anyways (after which point they are cached anyways...)
@todo: Implement some caching of the result between hits. (more than just the memory caching used here)
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.
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: t3lib
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.
@package: TYPO3
@subpackage: 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
@package: TYPO3
@subpackage: t3lib
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/
| Filesize: | 25 K |
| Func/Classes: | 15 |
| Tags: | @todo Need to really extend this class when the tcemain library has been updated and the whole API is better defined. There are some known bugs in this library. Further it would be nice with a facility to not only analyze but also clean up! @see SC_mod_tools_dbint_index::func_relations(), SC_mod_tools_dbint_index::func_records() @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib |
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/
| Returns: | [type] | ... |
| @todo Need to really extend this class when the tcemain library has been updated and the whole API is better defined. There are some known bugs in this library. Further it would be nice with a facility to not only analyze but also clean up! | ||
| @see SC_mod_tools_dbint_index::func_relations(), SC_mod_tools_dbint_index::func_records() | ||
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
Generates a list of Page-uid's that corresponds to the tables in the tree. This list should ideally include all records in the pages-table.
| $theID | integer | a pid (page-record id) from which to start making the tree |
| $depthData | string | HTML-code (image-tags) used when this function calls itself recursively. |
| $versions=FALSE | boolean | Internal variable, don't set from outside! |
| Returns: | void |
| $theID | [type] | $theID: ... |
| $depthData | [type] | $depthData: ... |
| $table='' | [type] | $table: ... |
| $versions=FALSE | [type] | $versions: ... |
| Returns: | [type] | ... |
Fills $this->lRecords with the records from all tc-tables that are not attached to a PID in the pid-list.
| $pid_list | string | list of pid's (page-record uid's). This list is probably made by genTree() |
| Returns: | void |
Fixes lost record from $table with uid $uid by setting the PID to zero. If there is a disabled column for the record that will be set as well.
| $table | string | Database tablename |
| $uid | integer | The uid of the record which will have the PID value set to 0 (zero) |
| Returns: | boolean | True if done. |
Counts records from $TCA-tables that ARE attached to an existing page.
| $pid_list | string | list of pid's (page-record uid's). This list is probably made by genTree() |
| Returns: | array | an array with the number of records from all $TCA-tables that are attached to a PID in the pid-list. |
Finding relations in database based on type 'group' (files or database-uid's in a list)
| $mode | string | $mode = file, $mode = db, $mode = '' (all...) |
| Returns: | array | An array with all fields listed that somehow are references to other records (foreign-keys) or files |
Finds all fields that hold filenames from uploadfolder
| $uploadfolder | string | Path to uploadfolder |
| Returns: | array | An array with all fields listed that have references to files in the $uploadfolder |
Returns an array with arrays of table/field pairs which are allowed to hold references to the input table name - according to $TCA
| $theSearchTable | string | Table name |
| Returns: | array |
This selects non-empty-records from the tables/fields in the fkey_array generated by getGroupFields()
| $fkey_arrays | array | Array with tables/fields generated by getGroupFields() |
| Returns: | void | |
| @see getGroupFields() | ||
Depends on selectNonEmpty.... to be executed first!!
| Returns: | array | Report over files; keys are "moreReferences", "noReferences", "noFile", "error" |
Depends on selectNonEmpty.... to be executed first!!
| $theArray | array | Table with key/value pairs being table names and arrays with uid numbers |
| Returns: | string | HTML Error message |
Finding all references to record based on table/uid
| $searchTable | string | Table name |
| $id | integer | Uid of database record |
| Returns: | array | Array with other arrays containing information about where references was found |
Finding all references to file based on uploadfolder / filename
| $uploadfolder | string | Upload folder where file is found |
| $filename | string | Filename to search for |
| Returns: | array | Array with other arrays containing information about where references was found |
TYPO3 XMLHTTP class (new in TYPO3 4.0.0)
This class contains two main parts:
(1) generation of JavaScript code which creates an XMLHTTP object in a cross-browser manner
(2) generation of XML data as a reply
| Filesize: | 4.2 K |
| Func/Classes: | 5 |
| Tags: | @author Sebastian Kurfuerst <sebastian@garbage-group.de> @package TYPO3 @subpackage t3lib |
TYPO3 XMLHTTP class (new in TYPO3 4.0.0)
This class contains two main parts:
(1) generation of JavaScript code which creates an XMLHTTP object in a cross-browser manner
(2) generation of XML data as a reply
| Returns: | [type] | ... |
| @author Sebastian Kurfuerst <sebastian@garbage-group.de> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
Gets the JavaScript code needed to handle an XMLHTTP request in the frontend.
All JS functions have to call ajax_doRequest(url) to make a request to the server.
USE:
See examples of using this function in template.php -> getContextMenuCode and alt_clickmenu.php -> printContent
| $handlerFunction | string | JS function handling the XML data from the server. That function gets the returned XML data as parameter. |
| $fallback='' | string | JS fallback function which is called with the URL of the request in case ajax is not available. |
| $debug=0 | boolean | If set to 1, the returned XML data is outputted as text in an alert window - useful for debugging, PHP errors are shown there, ... |
| Returns: | string | JavaScript code needed to make and handle an XMLHTTP request |
Function outputting XML data for TYPO3 ajax. The function directly outputs headers and content to the browser.
| $innerXML | string | $innerXML XML data which will be sent to the browser |
| Returns: | void |
Class for displaying an array as a tree
See the extension 'lowlevel' /config (Backend module 'Tools > Configuration')
| Filesize: | 8.6 K |
| Func/Classes: | 7 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib @see SC_mod_tools_config_index::main() |
Class for displaying an array as a tree
See the extension 'lowlevel' /config (Backend module 'Tools > Configuration')
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
| @see SC_mod_tools_config_index::main() | ||
Make browsable tree
Before calling this function you may want to set some of the internal vars like depthKeys, regexMode and fixedLgd. For examples see SC_mod_tools_config_index::main()
| $arr | array | The array to display |
| $depth_in | string | Key-position id. Build up during recursive calls - [key1].[key2].[key3] - an so on. |
| $depthData | string | Depth-data - basically a prefix for the icons. For calling this function from outside, let it stay blank. |
| Returns: | string | HTML for the tree |
| @see SC_mod_tools_config_index::main() | ||
Wrapping the value in bold tags etc.
| $theValue | string | The title string |
| $depth | string | Depth path |
| Returns: | string | Title string, htmlspecialchars()'ed |
Wrapping the value in bold tags etc.
| $label | string | The title string |
| $depth | string | Depth path |
| $theValue | string | The value for the array entry. |
| Returns: | string | Title string, htmlspecialchars()'ed |
Creates an array with "depthKeys" which will expand the array to show the search results
| $keyArr | array | The array to search for the value |
| $depth_in | string | Depth string - blank for first call (will build up during recursive calling creating an id of the position: [key1].[key2].[key3] |
| $searchString | string | The string to search for |
| $keyArray | array | Key array, for first call pass empty array |
| Returns: | array |
Fixed length function
| $string | string | String to process |
| $chars | integer | Max number of chars |
| Returns: | string | Processed string |
Function modifying the depthKey array
| $arr | array | Array with instructions to open/close nodes. |
| $settings | array | Input depth_key array |
| Returns: | array | Output depth_key array with entries added/removed based on $arr |
| @see SC_mod_tools_config_index::main() | ||
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
| Filesize: | 18.7 K |
| Func/Classes: | 20 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib @see t3lib_basicFileFunctions::init() |
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
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
| @see t3lib_basicFileFunctions::init() | ||
Constructor
This function should be called to initialise the internal arrays $this->mounts and $this->f_ext
A typical example of the array $mounts is this:
$mounts[xx][path] = (..a mounted path..)
the 'xx'-keys is just numerical from zero. There are also a [name] and [type] value that just denotes the mountname and type. Not used for athentication here.
$this->mounts is traversed in the function checkPathAgainstMounts($thePath), and it is checked that $thePath is actually below one of the mount-paths
The mountpaths are with a trailing '/'. $thePath must be with a trailing '/' also!
As you can see, $this->mounts is very critical! This is the array that decides where the user will be allowed to copy files!!
Typically the global var $WEBMOUNTS would be passed along as $mounts
A typical example of the array $f_ext is this:
$f_ext['webspace']['allow']='';
$f_ext['webspace']['deny']='php3,php';
$f_ext['ftpspace']['allow']='*';
$f_ext['ftpspace']['deny']='';
The control of fileextensions goes in two catagories. Webspace and Ftpspace. Webspace is folders accessible from a webbrowser (below TYPO3_DOCUMENT_ROOT) and ftpspace is everything else.
The control is done like this: If an extension matches 'allow' then the check returns true. If not and an extension matches 'deny' then the check return false. If no match at all, returns true.
You list extensions comma-separated. If the value is a '*' every extension is allowed
The list is case-insensitive when used in this class (see init())
Typically TYPO3_CONF_VARS['BE']['fileExtensions'] would be passed along as $f_ext.
Example:
$basicff->init($GLOBALS['FILEMOUNTS'],$TYPO3_CONF_VARS['BE']['fileExtensions']);
| $mounts | array | Contains the paths of the file mounts for the current BE user. Normally $GLOBALS['FILEMOUNTS'] is passed. This variable is set during backend user initialization; $FILEMOUNTS = $BE_USER->returnFilemounts(); (see typo3/init.php) |
| $f_ext | array | Array with information about allowed and denied file extensions. Typically passed: $TYPO3_CONF_VARS['BE']['fileExtensions'] |
| Returns: | void | |
| @see typo3/init.php, t3lib_userAuthGroup::returnFilemounts() | ||
Returns an array with a whole lot of fileinformation.
| $wholePath | string | Filepath to existing file. Should probably be absolute. Filefunctions are performed on this value. |
| Returns: | array | Information about the file in the filepath |
Checks if a $iconkey (fileextension) is allowed according to $this->f_ext.
| $iconkey | string | The extension to check, eg. "php" or "html" etc. |
| $type | string | Either "webspage" or "ftpspace" - points to a key in $this->f_ext |
| Returns: | boolean | True if file extension is allowed. |
Returns true if you can operate of ANY file ('*') in the space $theDest is in ('webspace' / 'ftpspace')
| $theDest | string | Absolute path |
| Returns: | boolean |
Checks if $this->webPath (should be TYPO3_DOCUMENT_ROOT) is in the first part of $path
Returns true also if $this->init is not set or if $path is empty...
| $path | string | Absolute path to check |
| Returns: | boolean |
If the filename is given, check it against the TYPO3_CONF_VARS[BE][fileDenyPattern] +
Checks if the $ext fileextension is allowed in the path $theDest (this is based on whether $theDest is below the $this->webPath)
| $ext | string | File extension, eg. "php" or "html" |
| $theDest | string | Absolute path for which to test |
| $filename='' | string | Filename to check against TYPO3_CONF_VARS[BE][fileDenyPattern] |
| Returns: | boolean | True if extension/filename is allowed |
Returns true if the input filename string is shorter than $this->maxInputNameLen.
| $fileName | string | Filename, eg "somefile.html" |
| Returns: | boolean |
Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.
| $theDir | string | Directory path to check |
| Returns: | string | Returns the cleaned up directory name if OK, otherwise false. |
Wrapper for t3lib_div::validPathStr()
| $theFile | string | Filepath to evaluate |
| Returns: | boolean | True, if no '//', '..' or '\' is in the $theFile |
| @see t3lib_div::validPathStr() | ||
Returns the destination path/filename of a unique filename/foldername in that path.
If $theFile exists in $theDest (directory) the file have numbers appended up to $this->maxNumber. Hereafter a unique string will be appended.
This function is used by fx. TCEmain when files are attached to records and needs to be uniquely named in the uploads/* folders
| $theFile | string | The input filename to check |
| $theDest | string | The directory for which to return a unique filename for $theFile. $theDest MUST be a valid directory. Should be absolute. |
| $dontCheckForUnique=0 | boolean | If set the filename is returned with the path prepended without checking whether it already existed! |
| Returns: | string | The destination absolute filepath (not just the name!) of a unique filename/foldername in that path. |
| @see t3lib_TCEmain::checkValue() | ||
Checks if $thePath is a path under one of the paths in $this->mounts
See comment in the header of this class.
| $thePath | string | $thePath MUST HAVE a trailing '/' in order to match correctly with the mounts |
| Returns: | string | The key to the first mount found, otherwise nothing is returned. |
| @see init() | ||
Find first web folder (relative to PATH_site.'fileadmin') in filemounts array
| Returns: | string | The key to the first mount inside PATH_site."fileadmin" found, otherwise nothing is returned. |
Removes filemount part of a path, thus blinding the position.
Takes a path, $thePath, and removes the part of the path which equals the filemount.
| $thePath | string | $thePath is a path which MUST be found within one of the internally set filemounts, $this->mounts |
| Returns: | string | The processed input path |
Find temporary folder
Finds the first $this->tempFN ('_temp_' usually) -folder in the internal array of filemounts, $this->mounts
| Returns: | string | Returns the path if found, otherwise nothing if error. |
Removes all dots, slashes and spaces after a path...
| $theDir | string | Input string |
| Returns: | string | Output string |
Converts any double slashes (//) to a single slash (/)
| $string | string | Input value |
| Returns: | string | Returns the converted string |
Returns a string which has a slash '/' appended if it doesn't already have that slash
| $path | string | Input string |
| Returns: | string | Output string with a slash in the end (if not already there) |
Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by '_'
| $fileName | string | Input string, typically the body of a filename |
| $charset='' | string | Charset of the a filename (defaults to current charset; depending on context) |
| Returns: | string | Output string with any characters not matching [.a-zA-Z0-9_-] is substituted by '_' |
Formats an integer, $sizeInBytes, to Mb or Kb or just bytes
| $sizeInBytes | integer | Bytes to be formated |
| Returns: | string | Formatted with M,K or appended. |
This class holds some functions used to display the sys_log table-content.
Used in the status-scripts and the log-module.
| Filesize: | 8.1 K |
| Func/Classes: | 11 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib @see tx_belog_webinfo, SC_mod_tools_log_index |
This class holds some functions used to display the sys_log table-content.
Used in the status-scripts and the log-module.
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
| @see tx_belog_webinfo, SC_mod_tools_log_index | ||
Get time label for log listing
| $code | integer | Timestamp to display |
| Returns: | string | If the timestamp was also shown last time, then "." is returned. Otherwise the new timestamp formatted with ->doc->formatTime() |
Get user name label for log listing
| $code | integer | be_user uid |
| $workspace=0 | integer | Workspace ID |
| Returns: | string | If username is different from last username then the username, otherwise "." |
Get type label for log listing
| $code | string | Key for the type label in locallang |
| Returns: | string | If labe is different from last type label then the label is returned, otherwise "." |
Get action label for log listing
| $code | string | Key for the action label in locallang |
| Returns: | string | If labe is different from last action label then the label is returned, otherwise "." |
Get details for the log entry
| $code | string | Suffix to "msg_" to get label from locallang. |
| $text | string | Details text |
| $data | array | Data array |
| $sys_log_uid=0 | integer | sys_log uid number |
| Returns: | string | Text string |
| @see formatDetailsForList() | ||
Formats input string in red-colored font tags
| $sign | string | Input value |
| $error=0 | integer | Error value |
| Returns: | string | Input wrapped in red font-tag and bold |
Formatting details text for the sys_log row inputted
| $row | array | sys_log row |
| Returns: | string | Details string |
For all entries in the $inArray (expected to be filepaths) the basename is extracted and set as value (if $this->stripPath is set)
This is done for log-entries from the FILE modules
| $inArr | array | Array of file paths |
| Returns: | array | |
| @see formatDetailsForList() | ||
Standard functions available for the TYPO3 backend.
Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
| Filesize: | 139 K |
| Func/Classes: | 100 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib |
Standard functions available for the TYPO3 backend.
Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field is configured in $TCA for the tablename, $table
This function should ALWAYS be called in the backend for selection on tables which are configured in TCA since it will ensure consistent selection of records, even if they are marked deleted (in which case the system must always treat them as non-existent!)
In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering on those fields as well in the backend you can use ->BEenableFields() though.
Usage: 71
| $table | string | Table name present in $TCA |
| $tableAlias='' | string | Table alias if any |
| Returns: | string | WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0" |
Gets record with uid=$uid from $table
You can set $field to a list of fields (default is '*')
Additional WHERE clauses can be added by $where (fx. ' AND blabla=1')
Will automatically check if records has been deleted and if so, not return anything.
$table must be found in $TCA
Usage: 99
| $table | string | Table name present in $TCA |
| $uid | integer | UID of record |
| $fields='*' | string | List of fields to select |
| $where='' | string | Additional WHERE clause, eg. " AND blablabla=0" |
| Returns: | array | Returns the row if found, otherwise nothing |
Like getRecord(), but overlays workspace version if any.
| $table | string | Table name present in $TCA |
| $uid | integer | UID of record |
| $fields='*' | string | List of fields to select |
| $where='' | string | Additional WHERE clause, eg. " AND blablabla=0" |
| Returns: | array | Returns the row if found, otherwise nothing |
Returns the first record found from $table with $where as WHERE clause
This function does NOT check if a record has the deleted flag set.
$table does NOT need to be configured in $TCA
The query used is simply this:
$query='SELECT '.$fields.' FROM '.$table.' WHERE '.$where;
Usage: 5 (ext: sys_todos)
| $table | string | Table name (not necessarily in TCA) |
| $where='' | string | WHERE clause |
| $fields='*' | string | $fields is a list of fields to select, default is '*' |
| Returns: | array | First row found, if any |
Returns records from table, $theTable, where a field ($theField) equals the value, $theValue
The records are returned in an array
If no records were selected, the function returns nothing
Usage: 8
| $theTable | string | Table name present in $TCA |
| $theField | string | Field to select on |
| $theValue | string | Value that $theField must match |
| $whereClause='' | string | Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT! |
| $groupBy='' | string | Optional GROUP BY field(s), if none, supply blank string. |
| $orderBy='' | string | Optional ORDER BY field(s), if none, supply blank string. |
| $limit='' | string | Optional LIMIT value ([begin,]max), if none, supply blank string. |
| Returns: | mixed | Multidimensional array with selected records (if any is selected) |
Returns a WHERE clause which will make an AND search for the words in the $searchWords array in any of the fields in array $fields.
Usage: 0
| $searchWords | array | Array of search words |
| $fields | array | Array of fields |
| $table='' | string | Table in which we are searching (for DBAL detection of quoteStr() method) |
| Returns: | string | WHERE clause for search |
| @deprecated Use $GLOBALS['TYPO3_DB']->searchQuery() directly! | ||
Returns a WHERE clause that can find a value ($value) in a list field ($field)
For instance a record in the database might contain a list of numbers, "34,234,5" (with no spaces between). This query would be able to select that record based on the value "34", "234" or "5" regardless of their positioni in the list (left, middle or right).
Is nice to look up list-relations to records or files in TYPO3 database tables.
Usage: 0
| $field | string | Table field name |
| $value | string | Value to find in list |
| Returns: | string | WHERE clause for a query |
| @deprecated Use $GLOBALS['TYPO3_DB']->listQuery() directly! | ||
Makes an backwards explode on the $str and returns an array with ($table,$uid).
Example: tt_content_45 => array('tt_content',45)
Usage: 1
| $str | string | [tablename]_[uid] string to explode |
| Returns: | array |
Returns a list of pure integers based on $in_list being a list of records with table-names prepended.
Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well.
Usage: 1 (t3lib_userauthgroup)
| $in_list | string | Input list |
| $tablename | string | Table name from which ids is returned |
| $default_tablename | string | $default_tablename denotes what table the number '45' is from (if nothing is prepended on the value) |
| Returns: | string | List of ids |
Backend implementation of enableFields()
Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
$GLOBALS["SIM_EXEC_TIME"] is used for date.
Usage: 5
| $table | string | $table is the table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $TCA. |
| $inv=0 | boolean | $inv means that the query will select all records NOT VISIBLE records (inverted selection) |
| Returns: | string | WHERE clause part |
Returns a SELECT query, selecting fields ($select) from two/three tables joined
$local_table and $mm_table is mandatory. $foreign_table is optional.
The JOIN is done with [$local_table].uid <--> [$mm_table].uid_local / [$mm_table].uid_foreign <--> [$foreign_table].uid
The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $TCA in Inside TYPO3 for more details.
DEPRECATED - Use $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query() instead since that will return the result pointer while this returns the query. Using this function may make your application less fitted for DBAL later.
| $select | string | Field list for SELECT |
| $local_table | string | Tablename, local table |
| $mm_table | string | Tablename, relation table |
| $foreign_table | string | Tablename, foreign table |
| $whereClause='' | string | Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT! |
| $groupBy='' | string | Optional GROUP BY field(s), if none, supply blank string. |
| $orderBy='' | string | Optional ORDER BY field(s), if none, supply blank string. |
| $limit='' | string | Optional LIMIT value ([begin,]max), if none, supply blank string. |
| Returns: | string | Full SQL query |
| @deprecated | ||
| @see t3lib_DB::exec_SELECT_mm_query() | ||
Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
DEPRECATED - $GLOBALS['TYPO3_DB']->INSERTquery() directly instead! But better yet, use $GLOBALS['TYPO3_DB']->exec_INSERTquery()
| $table | string | Table name |
| $fields_values | array | Field values as key=>value pairs. |
| Returns: | string | Full SQL query for INSERT |
| @deprecated | ||
Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
DEPRECATED - $GLOBALS['TYPO3_DB']->UPDATEquery() directly instead! But better yet, use $GLOBALS['TYPO3_DB']->exec_UPDATEquery()
| $table | string | Database tablename |
| $where | string | WHERE clause, eg. "uid=1" |
| $fields_values | array | Field values as key=>value pairs. |
| Returns: | string | Full SQL query for UPDATE |
| @deprecated | ||
Returns what is called the 'RootLine'. That is an array with information about the page records from a page id ($uid) and back to the root.
By default deleted pages are filtered.
This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found.
Usage: 1
| $uid | integer | Page id for which to create the root line. |
| $clause='' | string | $clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to. |
| $workspaceOL=FALSE | boolean | If true, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing! |
| Returns: | array | Root line array, all the way to the page tree root (or as far as $clause allows!) |
Opens the page tree to the specified page id
| $pid | integer | Page id. |
| $clearExpansion | boolean | If set, then other open branches are closed. |
| Returns: | void |
Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
Each part of the path will be limited to $titleLimit characters
Deleted pages are filtered out.
Usage: 15
| $uid | integer | Page uid for which to create record path |
| $clause | string | $clause is additional where clauses, eg. " |
| $titleLimit | integer | Title limit |
| $fullTitleLimit=0 | integer | Title limit of Full title (typ. set to 1000 or so) |
| Returns: | mixed | Path of record (string) OR array with short/long title if $fullTitleLimit is set. |
Returns an array with the exclude-fields as defined in TCA
Used for listing the exclude-fields in be_groups forms
Usage: 2 (t3lib_tceforms + t3lib_transferdata)
| Returns: | array | Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries |
Returns an array with explicit Allow/Deny fields.
Used for listing these field/value pairs in be_groups forms
| Returns: | array | Array with information from all of $TCA |
Returns an array with system languages:
| Returns: | array | Array with languages |
Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not.
If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
In any case ->isInWebMount must return true for the user (regardless of $perms_clause)
Usage: 21
| $id | integer | Page uid for which to check read-access |
| $perms_clause | string | $perms_clause is typically a value generated with $BE_USER->getPagePermsClause(1); |
| Returns: | array | Returns page record if OK, otherwise false. |
Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
Usage: 6
| $table | string | Table name (present in TCA) |
| $rec | array | Record from $table |
| $useFieldNameAsKey=0 | boolean | If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys. |
| Returns: | array |
Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $TCA
If no "type" field is configured in the "ctrl"-section of the $TCA for the table, zero is used.
If zero is not an index in the "types" section of $TCA for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)
Usage: 7
| $table | string | Table name present in TCA |
| $rec | array | Record from $table |
| Returns: | string | Field value |
| @see getTCAtypes() | ||
Parses a part of the field lists in the "types"-section of $TCA arrays, namely the "special configuration" at index 3 (position 4)
Elements are splitted by ":" and within those parts, parameters are splitted by "|".
Everything is returned in an array and you should rather see it visually than listen to me anymore now... Check out example in Inside TYPO3
Usage: 5
| $str | string | Content from the "types" configuration of TCA (the special configuration) - see description of function |
| $defaultExtras | string | The ['defaultExtras'] value from field configuration |
| Returns: | array |
Takes an array of "[key]=[value]" strings and returns an array with the keys set as keys pointing to the value.
Better see it in action! Find example in Inside TYPO3
Usage: 6
| $pArr | array | Array of "[key]=[value]" strings to convert. |
| Returns: | array |
Finds the Data Structure for a FlexForm field
Usage: 5
| $conf | array | Field config array |
| $row | array | Record data |
| $table | string | The table name |
| $fieldName='' | string | Optional fieldname passed to hook object |
| $WSOL=TRUE | boolean | Boolean; If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a true reflection of how things are in the live workspace. |
| Returns: | mixed | If array, the data structure was found and returned as an array. Otherwise (string) it is an error message. |
| @see t3lib_TCEforms::getSingleField_typeFlex() | ||
Stores the string value $data in the 'cache_hash' table with the hash key, $hash, and visual/symbolic identification, $ident
IDENTICAL to the function by same name found in t3lib_page:
Usage: 2
| $hash | string | Hash key, 32 bytes hex |
| $data | string | $data must be serialized before function call |
| $ident | string | Visual/symbolic identification (informational only) |
| Returns: | void |
Retrieves the string content stored with hash key, $hash, in cache_hash
IDENTICAL to the function by same name found in t3lib_page:
Usage: 2
| $hash | string | Hash key, 32 bytes hex |
| $expTime=0 | integer | $expTime represents the expire time in seconds. For instance a value of 3600 would allow cached content within the last hour, otherwise nothing is returned. |
| Returns: | string |
Returns the Page TSconfig for page with id, $id
Requires class "t3lib_TSparser"
Usage: 26 (spec. in ext info_pagetsconfig)
| $id | integer | Page uid for which to create Page TSconfig |
| $rootLine='' | array | If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated |
| $returnPartArray=0 | boolean | If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser. |
| Returns: | array | Page TSconfig |
| @see t3lib_TSparser | ||
Updates Page TSconfig for a page with $id
The function seems to take $pageTS as an array with properties and compare the values with those that already exists for the "object string", $TSconfPrefix, for the page, then sets those values which were not present.
$impParams can be supplied as already known Page TSconfig, otherwise it's calculated.
THIS DOES NOT CHECK ANY PERMISSIONS. SHOULD IT?
More documentation is needed.
Usage: 1 (ext. direct_mail)
| $id | integer | Page id |
| $pageTS | array | Page TS array to write |
| $TSconfPrefix | string | Prefix for object paths |
| $impParams='' | array | [Description needed.] |
| Returns: | void | |
| @internal | ||
| @see implodeTSParams(), getPagesTSconfig() | ||
Implodes a multi dimensional TypoScript array, $p, into a one-dimentional array (return value)
Usage: 3
| $p | array | TypoScript structure |
| $k='' | string | Prefix string |
| Returns: | array | Imploded TypoScript objectstring/values |
Returns an array with be_users records of all user NOT DELETED sorted by their username
Keys in the array is the be_users uid
Usage: 14 (spec. ext. "beuser" and module "web_perm")
| $fields='username,usergroup,usergroup_cached_list,uid' | string | Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields |
| $where='' | string | Optional $where clause (fx. "AND username='pete'") can be used to limit query |
| Returns: | array |
Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
Usage: 8 (spec. ext. "beuser" and module "web_perm")
| $fields='title,uid' | string | Field list |
| $where='' | string | WHERE clause |
| Returns: | array |
Returns an array with be_groups records (like ->getGroupNames) but:
- if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned.
Usage: 2 (module "web_perm" and ext. taskcenter)
| $fields='title,uid' | string | Field list; $fields specify the fields selected (default: title,uid) |
| Returns: | array |
Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!).
If $excludeBlindedFlag is set, then these records are unset from the array $usernames
Takes $usernames (array made by t3lib_BEfunc::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input
Usage: 8
| $usernames | array | User names |
| $groupArray | array | Group names |
| $excludeBlindedFlag=0 | boolean | If $excludeBlindedFlag is set, then these records are unset from the array $usernames |
| Returns: | array | User names, blinded |
Corresponds to blindUserNames but works for groups instead
Usage: 2 (module web_perm)
| $groups | array | Group names |
| $groupArray | array | Group names (reference) |
| $excludeBlindedFlag=0 | boolean | If $excludeBlindedFlag is set, then these records are unset from the array $usernames |
| Returns: | array |
Returns the difference in days between input $tstamp and $EXEC_TIME
Usage: 2 (class t3lib_BEfunc)
| $tstamp | integer | Time stamp, seconds |
| Returns: | integer |
Returns $tstamp formatted as "ddmmyy" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'])
Usage: 11
| $tstamp | integer | Time stamp, seconds |
| Returns: | string | Formatted time |
Returns $tstamp formatted as "ddmmyy hhmm" (According to $TYPO3_CONF_VARS['SYS']['ddmmyy'] AND $TYPO3_CONF_VARS['SYS']['hhmm'])
Usage: 28
| $value | integer | Time stamp, seconds |
| Returns: | string | Formatted time |
Returns $value (in seconds) formatted as hh:mm:ss
For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
Usage: 1 (class t3lib_BEfunc)
| $value | integer | Time stamp, seconds |
| Returns: | string | Formatted time |
Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
Usage: 15
| $seconds | integer | $seconds could be the difference of a certain timestamp and time() |
| $labels = 'min|hrs|days|yrs' | string | $labels should be something like ' min| hrs| days| yrs'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears") |
| Returns: | string | Formatted time |
Returns a formatted timestamp if $tstamp is set.
The date/datetime will be followed by the age in parenthesis.
Usage: 3
| $tstamp | integer | Time stamp, seconds |
| $prefix=1 | integer | 1/-1 depending on polarity of age. |
| $date='' | string | $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm" |
| Returns: | string |
Returns either title='' or alt='' attribute. This depends on the client browser and whether it supports title='' or not (which is the default)
If no $content is given only the attribute name is returned.
The returned attribute with content will have a leading space char.
Warning: Be careful to submit empty $content var - that will return just the attribute name!
Usage: 0
| $content='' | string | String to set as title-attribute. If no $content is given only the attribute name is returned. |
| $hsc=0 | boolean | If $hsc is set, then content of the attribute is htmlspecialchar()'ed (which is good for XHTML and other reasons...) |
| Returns: | string | |
| @deprecated The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead! | ||
Returns alt="" and title="" attributes with the value of $content.
Usage: 7
| $content | string | Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output) |
| Returns: | string |
Returns a linked image-tag for thumbnail(s)/fileicons/truetype-font-previews from a database row with a list of image files in a field
All $TYPO3_CONF_VARS['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
Thumbsnails are linked to the show_item.php script which will display further details.
Usage: 7
| $row | array | $row is the database row from the table, $table. |
| $table | string | Table name for $row (present in TCA) |
| $field | string | $field is pointing to the field with the list of image files |
| $backPath | string | Back path prefix for image tag src="" field |
| $thumbScript='' | string | Optional: $thumbScript os by default 'thumbs.php' if you don't set it otherwise |
| $uploaddir=NULL | string | Optional: $uploaddir is the directory relative to PATH_site where the image files from the $field value is found (Is by default set to the entry in $TCA for that field! so you don't have to!) |
| $abs=0 | boolean | If set, uploaddir is NOT prepended with "../" |
| $tparams='' | string | Optional: $tparams is additional attributes for the image tags |
| $size='' | integer | Optional: $size is [w]x[h] of the thumbnail. 56 is default. |
| Returns: | string | Thumbnail image tag. |
Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
Usage: 3
| $thumbScript | string | $thumbScript must point to "thumbs.php" relative to the script position |
| $theFile | string | $theFile must be the proper reference to the file thumbs.php should show |
| $tparams='' | string | $tparams are additional attributes for the image tag |
| $size='' | integer | $size is the size of the thumbnail send along to "thumbs.php" |
| Returns: | string | Image tag |
Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
Usage: 8
| $row | array | Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table) |
| $perms_clause='' | string | $perms_clause is used to get the record path of the shortcut page, if any (and doktype==4) |
| $includeAttrib=1 | boolean | If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already |
| Returns: | string |
Returns title-attribute information for ANY record (from a table defined in TCA of course)
The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included.
"pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
Usage: 10
| $row | array | Table row; $row is a row from the table, $table |
| $table='pages' | string | Table name |
| Returns: | string |
Returns the label of the first found entry in an "items" array from $TCA (tablename=$table/fieldname=$col) where the value is $key
Usage: 9
| $table | string | Table name, present in $TCA |
| $col | string | Field name, present in $TCA |
| $key | string | items-array value to match |
| Returns: | string | Label for item entry |
Returns the label-value for fieldname $col in table, $table
If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap='<b>|</b>' and the fieldname was 'not_found_field' then the return value would be '<b>not_found_field</b>'
Usage: 17
| $table | string | Table name, present in $TCA |
| $col | string | Field name |
| $printAllWrap='' | string | Wrap value - set function description |
| Returns: | string |
Returns the "title"-value in record, $row, from table, $table
The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
Usage: 26
| $table | string | Table name, present in TCA |
| $row | array | Row from table |
| $prep=0 | boolean | If set, result is prepared for output: The output is cropped to a limited lenght (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '<em>[No title]</em>' is returned (localized). Further, the output is htmlspecialchars()'ed |
| Returns: | string |
Returns a human readable output of a value from a record
For instance a database record relation would be looked up to display the title-value of that record. A checkbox with a "1" value would be "Yes", etc.
$table/$col is tablename and fieldname
REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
Usage: 24
| $table | string | Table name, present in TCA |
| $col | string | Field name, present in TCA |
| $value | string | $value is the value of that field from a selected record |
| $fixed_lgd_chars=0 | integer | $fixed_lgd_chars is the max amount of characters the value may occupy |
| $defaultPassthrough=0 | boolean | $defaultPassthrough flag means that values for columns that has no conversion will just be pass through directly (otherwise cropped to 200 chars or returned as "N/A") |
| $noRecordLookup=FALSE | boolean | If set, no records will be looked up, UIDs are just shown. |
| $uid=0 | integer | uid of the current record |
| Returns: | string |
Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead.
Usage: 2
| $table | string | Table name, present in TCA |
| $fN | string | Field name |
| $fV | string | Field value |
| $fixed_lgd_chars=0 | integer | $fixed_lgd_chars is the max amount of characters the value may occupy |
| $uid=0 | integer | uid of the current record |
| Returns: | string | |
| @see getProcessedValue() | ||
Returns file icon name (from $FILEICONS) for the fileextension $ext
Usage: 10
| $ext | string | File extension, lowercase |
| Returns: | string | File icon filename |
Returns fields for a table, $table, which would typically be interesting to select
This includes uid, the fields defined for title, icon-field.
Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed)
Usage: 3
| $table | string | Table name, present in TCA |
| $prefix='' | string | Table prefix |
| Returns: | string | List of fields. |
Makes a form for configuration of some values based on configuration found in the array $configArray, with default values from $defaults and a data-prefix $dataPrefix
<form>-tags must be supplied separately
Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3. That's were you can expect to find example, if anywhere.
Usage: 1 (ext. direct_mail)
| $configArray | array | Field configuration code. |
| $defaults | array | Defaults |
| $dataPrefix | string | Prefix for formfields |
| Returns: | string | HTML for a form. |
Returns help-text icon if configured for.
TCA_DESCR must be loaded prior to this function and $BE_USER must have 'edit_showFieldHelp' set to 'icon', otherwise nothing is returned
Usage: 6
| $table | string | Table name |
| $field | string | Field name |
| $BACK_PATH | string | Back path |
| $force=0 | boolean | Force display of icon nomatter BE_USER setting for help |
| Returns: | string | HTML content for a help icon/text |
Returns CSH help text (description), if configured for.
TCA_DESCR must be loaded prior to this function and $BE_USER must have "edit_showFieldHelp" set to "text", otherwise nothing is returned
Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text.
Usage: 4
| $table | string | Table name |
| $field | string | Field name |
| $BACK_PATH | string | Back path |
| $styleAttrib='' | string | Additional style-attribute content for wrapping table |
| Returns: | string | HTML content for help text |
API for getting CSH icons/text for use in backend modules.
TCA_DESCR will be loaded if it isn't already
Usage: ?
| $table | string | Table name ('_MOD_'+module name) |
| $field | string | Field name (CSH locallang main key) |
| $BACK_PATH | string | Back path |
| $wrap='' | string | Wrap code for icon-mode, splitted by "|". Not used for full-text mode. |
| $onlyIconMode=FALSE | boolean | If set, the full text will never be shown (only icon). Useful for places where it will break the page if the table with full text is shown. |
| $styleAttrib='' | string | Additional style-attribute content for wrapping table (full text mode only) |
| Returns: | string | HTML content for help text |
| @see helpText(), helpTextIcon() | ||
Returns a JavaScript string (for an onClick handler) which will load the alt_doc.php script that shows the form for editing of the record(s) you have send as params.
REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
Usage: 35
| $params | string | $params is parameters sent along to alt_doc.php. This requires a much more details description which you must seek in Inside TYPO3s documentation of the alt_doc.php API. And example could be '&edit[pages][123]=edit' which will show edit form for page record 123. |
| $backPath='' | string | $backPath must point back to the TYPO3_mainDir directory (where alt_doc.php is) |
| $requestUri='' | string | $requestUri is an optional returnUrl you can set - automatically set to REQUEST_URI. |
| Returns: | string | |
| @see template::issueCommand() | ||
Returns a JavaScript string for viewing the page id, $id
It will detect the correct domain name if needed and provide the link with the right back path. Also it will re-use any window already open.
Usage: 8
| $id | integer | $id is page id |
| $backPath='' | string | $backpath must point back to TYPO3_mainDir (where the site is assumed to be one level above) |
| $rootLine='' | array | If root line is supplied the function will look for the first found domain record and use that URL instead (if found) |
| $anchor='' | string | $anchor is optional anchor to the URL |
| $altUrl='' | string | $altUrl is an alternative URL which - if set - will make all other parameters ignored: The function will just return the window.open command wrapped around this URL! |
| $addGetVars='' | string | Additional GET variables. |
| $switchFocus=TRUE | boolean | If true, then the preview window will gain the focus. |
| Returns: | string |
Returns the merged User/Page TSconfig for page id, $id.
Please read details about module programming elsewhere!
Usage: 15
| $id | integer | Page uid |
| $TSref | string | $TSref is an object string which determines the path of the TSconfig to return. |
| Returns: | array |
Returns a selector box "function menu" for a module
Requires the JS function jumpToUrl() to be available
See Inside TYPO3 for details about how to use / make Function menus
Usage: 50
| $mainParams | mixed | $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=... |
| $elementName | string | $elementName it the form elements name, probably something like "SET[...]" |
| $currentValue | string | $currentValue is the value to be selected currently. |
| $menuItems | array | $menuItems is an array with the menu items for the selector box |
| $script='' | string | $script is the script to send the &id to, if empty it's automatically found |
| $addparams='' | string | $addParams is additional parameters to pass to the script. |
| Returns: | string | HTML code for selector box |
Checkbox function menu.
Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.
Usage: 34
| $mainParams | mixed | $mainParams $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=... |
| $elementName | string | $elementName it the form elements name, probably something like "SET[...]" |
| $currentValue | string | $currentValue is the value to be selected currently. |
| $script='' | string | $script is the script to send the &id to, if empty it's automatically found |
| $addparams='' | string | $addParams is additional parameters to pass to the script. |
| $tagParams='' | string | Additional attributes for the checkbox input tag |
| Returns: | string | HTML code for checkbox |
| @see getFuncMenu() | ||
Input field function menu
Works like ->getFuncMenu() / ->getFuncCheck() but displays a input field instead which updates the script "onchange"
Usage: 1
| $mainParams | mixed | $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=... |
| $elementName | string | $elementName it the form elements name, probably something like "SET[...]" |
| $currentValue | string | $currentValue is the value to be selected currently. |
| $size=10 | integer | Relative size of input field, max is 48 |
| $script="" | string | $script is the script to send the &id to, if empty it's automatically found |
| $addparams="" | string | $addParams is additional parameters to pass to the script. |
| Returns: | string | HTML code for input text field. |
| @see getFuncMenu() | ||
Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig)
See Inside TYPO3 about how to program modules and use this API.
Usage: 4
| $modTSconfig | array | Module TS config array |
| $itemArray | array | Array of items from which to remove items. |
| $TSref | string | $TSref points to the "object string" in $modTSconfig |
| Returns: | array | The modified $itemArray is returned. |
Call to update the page tree frame (or something else..?) after
t3lib_BEfunc::getSetUpdateSignal('updatePageTree') -> will set the page tree to be updated.
t3lib_BEfunc::getSetUpdateSignal() -> will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
Usage: 11
| $set='' | string | Whether to set or clear the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. |
| Returns: | string | HTML code (<script> section) |
Returns an array which is most backend modules becomes MOD_SETTINGS containing values from function menus etc. determining the function of the module.
This is kind of session variable management framework for the backend users.
If a key from MOD_MENU is set in the CHANGED_SETTINGS array (eg. a value is passed to the script from the outside), this value is put into the settings-array
Ultimately, see Inside TYPO3 for how to use this function in relation to your modules.
Usage: 23
| $MOD_MENU | array | MOD_MENU is an array that defines the options in menus. |
| $CHANGED_SETTINGS | array | CHANGED_SETTINGS represents the array used when passing values to the script from the menus. |
| $modName | string | modName is the name of this module. Used to get the correct module data. |
| $type='' | string | If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in. |
| $dontValidateList='' | string | dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus. |
| $setDefaultList='' | string | List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays) |
| Returns: | array | The array $settings, which holds a key for each MOD_MENU key and the values of each key will be within the range of values for each menuitem |
Set preview keyword, eg:
$previewUrl = t3lib_div::getIndpEnv('TYPO3_SITE_URL').'?ADMCMD_prev='.t3lib_BEfunc::compilePreviewKeyword('id='.$pageId.'&L='.$language.'&ADMCMD_view=1&ADMCMD_editIcons=1&ADMCMD_previewWS='.$this->workspace, $GLOBALS['BE_USER']->user['uid'], 120);
todo for sys_preview:
- Add a comment which can be shown to previewer in frontend in some way (plus maybe ability to write back, take other action?)
- Add possibility for the preview keyword to work in the backend as well: So it becomes a quick way to a certain action of sorts?
| $getVarsStr | string | Get variables to preview, eg. 'id=1150&L=0&ADMCMD_view=1&ADMCMD_editIcons=1&ADMCMD_previewWS=8' |
| $beUserUid | string | 32 byte MD5 hash keyword for the URL: "?ADMCMD_prev=[keyword]" |
| $ttl=172800 | integer | Time-To-Live for keyword |
| Returns: | string | Returns keyword to use in URL for ADMCMD_prev= |
Unlock or Lock a record from $table with $uid
If $table and $uid is not set, then all locking for the current BE_USER is removed!
Usage: 5
| $table='' | string | Table name |
| $uid=0 | integer | Record uid |
| $pid=0 | integer | Record pid |
| Returns: | void | |
| @internal | ||
| @see t3lib_transferData::lockRecord(), alt_doc.php, db_layout.php, db_list.php, wizard_rte.php | ||
Returns information about whether the record from table, $table, with uid, $uid is currently locked (edited by another user - which should issue a warning).
Notice: Locking is not strictly carried out since locking is abandoned when other backend scripts are activated - which means that a user CAN have a record "open" without having it locked. So this just serves as a warning that counts well in 90% of the cases, which should be sufficient.
Usage: 5
| $table | string | Table name |
| $uid | integer | Record uid |
| Returns: | array | |
| @internal | ||
| @see class.db_layout.inc, alt_db_navframe.php, alt_doc.php, db_layout.php | ||
Returns select statement for MM relations (as used by TCEFORMs etc)
Usage: 3
| $fieldValue | array | Configuration array for the field, taken from $TCA |
| $field='' | string | Field name |
| $TSconfig=array() | array | TSconfig array from which to get further configuration settings for the field name |
| $prefix='' | string | Prefix string for the key "*foreign_table_where" from $fieldValue array |
| Returns: | string | Part of query |
| @internal | ||
| @see t3lib_transferData::renderRecord(), t3lib_TCEforms::foreignTable() | ||
Returns TSConfig for the TCEFORM object in Page TSconfig.
Used in TCEFORMs
Usage: 4
| $table | string | Table name present in TCA |
| $row | array | Row from table |
| Returns: | array | |
| @see t3lib_transferData::renderRecord(), t3lib_TCEforms::setTSconfig(), SC_wizard_list::main(), SC_wizard_add::main() | ||
Find the real PID of the record (with $uid from $table). This MAY be impossible if the pid is set as a reference to the former record or a page (if two records are created at one time).
NOTICE: Make sure that the input PID is never negativ because the record was an offline version! Therefore, you should always use t3lib_BEfunc::fixVersioningPid($table,$row); on the data you input before calling this function!
Usage: 2
| $table | string | Table name |
| $uid | integer | Record uid |
| $pid | integer | Record pid, could be negative then pointing to a record from same table whos pid to find and return. |
| Returns: | integer | |
| @internal | ||
| @see t3lib_TCEmain::copyRecord(), getTSCpid() | ||
Return $uid if $table is pages and $uid is integer - otherwise the $pid
Usage: 1
| $table | string | Table name |
| $uid | integer | Record uid |
| $pid | integer | Record pid |
| Returns: | integer | |
| @internal | ||
| @see t3lib_TCEforms::getTSCpid() | ||
Returns the REAL pid of the record, if possible. If both $uid and $pid is strings, then pid=-1 is returned as an error indication.
Usage: 8
| $table | string | Table name |
| $uid | integer | Record uid |
| $pid | integer | Record pid |
| Returns: | array | Array of two integers; first is the REAL PID of a record and if its a new record negative values are resolved to the true PID, second value is the PID value for TSconfig (uid if table is pages, otherwise the pid) |
| @internal | ||
| @see t3lib_TCEmain::setHistory(), t3lib_TCEmain::process_datamap() | ||
Returns first found domain record "domainName" (without trailing slash) if found in the input $rootLine
Usage: 2
| $rootLine | array | Root line array |
| Returns: | string | Domain name, if found. |
Returns the sys_domain record for $domain, optionally with $path appended.
Usage: 2
| $domain | string | Domain name |
| $path='' | string | Appended path |
| Returns: | array | Domain record, if found |
Returns overlayered RTE setup from an array with TSconfig. Used in TCEforms and TCEmain
Usage: 8
| $RTEprop | array | The properties of Page TSconfig in the key "RTE." |
| $table | string | Table name |
| $field | string | Field name |
| $type='' | string | Type value of the current record (like from CType of tt_content) |
| Returns: | array | Array with the configuration for the RTE |
| @internal | ||
Returns first possible RTE object if available.
Usage: $RTEobj = &t3lib_BEfunc::RTEgetObj();
| Returns: | mixed | If available, returns RTE object, otherwise an array of messages from possible RTEs |
Returns soft-reference parser for the softRef processing type
Usage: $softRefObj = &t3lib_BEfunc::softRefParserObj('[parser key]');
| $spKey | string | softRef parser key |
| Returns: | mixed | If available, returns Soft link parser object. |
Returns array of soft parser references
| $parserList | string | softRef parser list |
| string | Table name | |
| string | Field name | |
| Returns: | array | Array where the parser key is the key and the value is the parameter string |
Returns true if $modName is set and is found as a main- or submodule in $TBE_MODULES array
Usage: 1
| $modName | string | Module name |
| Returns: | boolean |
Counting references to a record/file
| $table | string | Table name (or "_FILE" if its a file) |
| $ref | string | Reference: If table, then integer-uid, if _FILE, then file reference (relative to PATH_site) |
| $msg='' | string | Message with %s, eg. "There were %s records pointing to this file!" |
| Returns: | string | Output string (or integer count value if no msg string specified) |
Select all versions of a record, ordered by version id (DESC)
| $table | string | Table name to select from |
| $uid | integer | Record uid for which to find versions. |
| $fields='*' | string | Field list to select |
| $workspace=0 | integer | Workspace ID, if zero all versions regardless of workspace is found. |
| Returns: | array | Array of versions of table/uid |
Find page-tree PID for versionized record
Will look if the "pid" value of the input record is -1 and if the table supports versioning - if so, it will translate the -1 PID into the PID of the original record
Used whenever you are tracking something back, like making the root line.
Will only translate if the workspace of the input record matches that of the current user (unless flag set)
Principle; Record offline! => Find online?
| $table | string | Table name |
| &$rr | array | Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query. |
| $ignoreWorkspaceMatch=FALSE | boolean | Ignore workspace match |
| Returns: | void | (Passed by ref). If the record had its pid corrected to the online versions pid, then "_ORIG_pid" is set to the original pid value (-1 of course). The field "_ORIG_pid" is used by various other functions to detect if a record was in fact in a versionized branch. |
| @see t3lib_page::fixVersioningPid() | ||
Workspace Preview Overlay
Generally ALWAYS used when records are selected based on uid or pid. If records are selected on other fields than uid or pid (eg. "email = ....") then usage might produce undesired results and that should be evaluated on individual basis.
Principle; Record online! => Find offline?
| $table | string | Table name |
| &$row | array | Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_swapmode" (pages) fields must exist! Fake fields cannot exist since the fields in the array is used as field names in the SQL look up. |
| $wsid=-99 | integer | Workspace ID, if not specified will use $GLOBALS['BE_USER']->workspace |
| Returns: | void | (Passed by ref). |
| @see fixVersioningPid() | ||
Select the workspace version of a record, if exists
| $workspace | integer | Workspace ID |
| $table | string | Table name to select from |
| $uid | integer | Record uid for which to find workspace version. |
| $fields='*' | string | Field list to select |
| Returns: | array | If found, return record, otherwise false |
Returns live version of record
| $table | string | Table name |
| $uid | integer | Record UID of draft, offline version |
| $fields='*' | string | Field list, default is * |
| Returns: | array | If found, the record, otherwise nothing. |
Will fetch the rootline for the pid, then check if anywhere in the rootline there is a branch point and if so everything is allowed of course.
Alternatively; if the page of the PID itself is a version and swapmode is zero (page+content) then tables from versioning_followPages are allowed as well.
| $pid | integer | Page id inside of which you want to edit/create/delete something. |
| $table='' | string | Table name you are checking for. If you don't give the table name ONLY "branch" types are found and returned true. Specifying table you might also get a positive response if the pid is a "page" versioning type AND the table has "versioning_followPages" set. |
| $returnStage=FALSE | boolean | If set, the keyword "branchpoint" or "first" is not returned by rather the "t3ver_stage" value of the branch-point. |
| Returns: | mixed | Returns either "branchpoint" (if branch) or "first" (if page) or false if nothing. Alternatively, it returns the value of "t3ver_stage" for the branchpoint (if any) |
Will return where clause de-selecting new-versions from other workspaces.
| $table | string | Table name |
| Returns: | string | Where clause if applicable. |
Count number of versions on a page
| $workspace | integer | Workspace ID |
| $pageId | integer | Page ID |
| $allTables=FALSE | boolean | If set, then all tables and not only "versioning_followPages" are found (except other pages) |
| Returns: | array | Overview of records |
Performs mapping of new uids to new versions UID in case of import inside a workspace.
| $table | string | Table name |
| $uid | integer | Record uid (of live record placeholder) |
| Returns: | integer | Uid of offline version if any, otherwise live uid. |
Print error message with header, text etc.
Usage: 19
| $header | string | Header string |
| $text | string | Content string |
| $js='' | boolean | Will return an alert() with the content of header and text. |
| $head=1 | boolean | Print header. |
| Returns: | void |
Prints TYPO3 Copyright notice for About Modules etc. modules.
| Returns: | void |
Display some warning messages if this installation is obviously insecure!!
These warnings are only displayed to admin users
| Returns: | void |
Returns "web" if the $path (absolute) is within the DOCUMENT ROOT - and thereby qualifies as a "web" folder.
Usage: 4
| $path | string | Path to evaluate |
| Returns: | boolean |
Creates ADMCMD parameters for the "viewpage" extension / "cms" frontend
Usage: 1
| $pageinfo | array | Page record |
| Returns: | string | Query-parameters |
| @internal | ||
Returns an array with key=>values based on input text $params
$params is exploded by line-breaks and each line is supposed to be on the syntax [key] = [some value]
These pairs will be parsed into an array an returned.
Usage: 1
| $params | string | String of parameters on multiple lines to parse into key-value pairs (see function description) |
| Returns: | array |
Returns "list of backend modules". Most likely this will be obsolete soon / removed. Don't use.
Usage: 3
| $name | array | Module names in array. Must be "addslashes()"ed |
| $perms_clause | string | Perms clause for SQL query |
| $backPath='' | string | Backpath |
| $script='index.php' | string | The URL/script to jump to (used in A tag) |
| Returns: | array | Two keys, rows and list |
| @internal | ||
| @deprecated | ||
| @obsolete | ||
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.
| Filesize: | 13.9 K |
| Func/Classes: | 10 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib |
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.
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
If flag is set and the extensions 'beuser_tracking' is loaded, this will insert a table row with the REQUEST_URI of current script - thus tracking the scripts the backend users uses...
This function works ONLY with the "beuser_tracking" extension and is deprecated since it does nothing useful.
| $flag | boolean | Activate insertion of the URL. |
| Returns: | void |
If TYPO3_CONF_VARS['BE']['enabledBeUserIPLock'] is enabled and an IP-list is found in the User TSconfig objString "options.lockToIP", then make an IP comparison with REMOTE_ADDR and return the outcome (true/false)
| Returns: | boolean | True, if IP address validates OK (or no check is done at all) |
Check if user is logged in and if so, call ->fetchGroupData() to load group information and access lists of all kind, further check IP, set the ->uc array and send login-notification email if required.
If no user is logged in the default behaviour is to exit with an error message, but this will happen ONLY if the constant TYPO3_PROCEED_IF_NO_USER is set true.
This function is called right after ->start() in fx. init.php
| Returns: | void |
If the backend script is in CLI mode, it will try to load a backend user named by the CLI module name (in lowercase)
| Returns: | boolean | Returns true if a CLI user was loaded, otherwise false! |
Initialize the internal ->uc array for the backend user
Will make the overrides if necessary, and write the UC back to the be_users record if changes has happend
| Returns: | void | |
| @internal | ||
Override: Call this function every time the uc is updated.
That is 1) by reverting to default values, 2) in the setup-module, 3) userTS changes (userauthgroup)
| Returns: | void | |
| @internal | ||
Clears the user[uc] and ->uc to blank strings. Then calls ->backendSetUC() to fill it again with reset contents
| Returns: | void | |
| @internal | ||
Will send an email notification to warning_email_address/the login users email address when a login session is just started.
Depends on various parameters whether mails are send and to whom.
| Returns: | void |
VeriCode returns 10 first chars of a md5 hash of the session cookie AND the encryptionKey from TYPO3_CONF_VARS.
This code is used as an alternative verification when the JavaScript interface executes cmd's to tce_db.php from eg. MSIE 5.0 because the proper referer is not passed with this browser...
| Returns: | string |
Extension class for the t3lib_treeView class, specially made for browsing pages
| Filesize: | 4.8 K |
| Func/Classes: | 4 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @coauthor René Fritz <r.fritz@colorcube.de> @see t3lib_treeView, t3lib_pageTree @package TYPO3 @subpackage t3lib |
Extension class for the t3lib_treeView class, specially made for browsing pages
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @coauthor René Fritz <r.fritz@colorcube.de> | ||
| @see t3lib_treeView, t3lib_pageTree | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
Initialize, setting what is necessary for browsing pages.
Using the current user.
| $clause='' | string | Additional clause for selecting pages. |
| Returns: | void |
Creates title attribute content for pages.
Uses API function in t3lib_BEfunc which will retrieve lots of useful information for pages.
| $row | array | The table row. |
| Returns: | string |
Wrapping the image tag, $icon, for the row, $row (except for mount points)
| $icon | string | The image tag for the icon |
| $row | array | The row for the current element |
| Returns: | string | The processed icon input value. |
TYPO3 clipboard for records and files
| Filesize: | 34 K |
| Func/Classes: | 32 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @package TYPO3 @subpackage t3lib |
TYPO3 clipboard for records and files
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
Call this method after initialization if you want to lock the clipboard to operate on the normal pad only. Trying to switch pad through ->setCmd will not work
This is used by the clickmenu since it only allows operation on single elements at a time (that is the "normal" pad)
| Returns: | void |
The array $cmd may hold various keys which notes some action to take.
Normally perform only one action at a time.
In scripts like db_list.php / file_list.php the GET-var CB is used to control the clipboard.
Selecting / Deselecting elements
Array $cmd['el'] has keys = element-ident, value = element value (see description of clipData array in header)
Selecting elements for 'copy' should be done by simultaneously setting setCopyMode.
| $cmd | array | Array of actions, see function description |
| Returns: | void |
Setting the current pad on clipboard
| $padIdent | string | Key in the array $this->clipData |
| Returns: | void |
Call this after initialization and setCmd in order to save the clipboard to the user session.
The function will check if the internal flag ->changed has been set and if so, save the clipboard. Else not.
| Returns: | void |
Cleans up an incoming element array $CBarr (Array selecting/deselecting elements)
| $CBarr | array | Element array from outside ("key" => "selected/deselected") |
| $table | string | $table is the 'table which is allowed'. Must be set. |
| $removeDeselected=0 | boolean | $removeDeselected can be set in order to remove entries which are marked for deselection. |
| Returns: | array | Processed input $CBarr |
Print the content on a pad. Called from ->printClipboard()
| $pad | string | Pad reference |
| Returns: | array | Array with table rows for the clipboard. |
Wraps title of pad in bold-tags and maybe the number of elements if any.
| $str | string | String (already htmlspecialchars()'ed) |
| $pad | string | Pad reference |
| Returns: | string | HTML output (htmlspecialchar'ed content inside of tags.) |
Wraps the title of the items listed in link-tags. The items will link to the page/folder where they originate from
| $str | string | Title of element - must be htmlspecialchar'ed on beforehand. |
| $rec | mixed | If array, a record is expected. If string, its a path |
| $table='' | string | Table name |
| Returns: | string |
Returns the select-url for database elements
| $table | string | Table name |
| $uid | integer | Uid of record |
| $copy=0 | boolean | If set, copymode will be enabled |
| $deselect=0 | boolean | If set, the link will deselect, otherwise select. |
| $baseArray=array() | array | The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included. |
| Returns: | string | URL linking to the current script but with the CB array set to select the element with table/uid |
Returns the select-url for files
| $path | string | Filepath |
| $copy=0 | boolean | If set, copymode will be enabled |
| $deselect=0 | boolean | If set, the link will deselect, otherwise select. |
| $baseArray=array() | array | The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included. |
| Returns: | string | URL linking to the current script but with the CB array set to select the path |
pasteUrl of the element (database and file)
For the meaning of $table and $uid, please read from ->makePasteCmdArray!!!
The URL will point to tce_file or tce_db depending in $table
| $table | string | Tablename (_FILE for files) |
| $uid | mixed | "destination": can be positive or negative indicating how the paste is done (paste into / paste after) |
| $setRedirect=1 | boolean | If set, then the redirect URL will point back to the current script, but with CB reset. |
| Returns: | string |
deleteUrl for current pad
| $setRedirect=1 | boolean | If set, then the redirect URL will point back to the current script, but with CB reset. |
| $file=0 | boolean | If set, then the URL will link to the tce_file.php script in the typo3/ dir. |
| Returns: | string |
editUrl of all current elements
ONLY database
Links to alt_doc.php
| Returns: | string | The URL to alt_doc.php with parameters. |
Returns the remove-url (file and db)
for file $table='_FILE' and $uid = shortmd5 hash of path
| $table | string | Tablename |
| $uid | string | uid integer/shortmd5 hash |
| Returns: | string | URL |
Returns confirm JavaScript message
| $table | string | Table name |
| $rec | mixed | For records its an array, for files its a string (path) |
| $type | string | Type-code |
| $clElements | array | Array of selected elements |
| Returns: | string | JavaScript "confirm" message |
Clipboard label - getting from "EXT:lang/locallang_core.php:"
| $key | string | Label Key |
| $Akey='labels' | string | Alternative key to "labels" |
| Returns: | string |
Creates GET parameters for linking to the export module.
| Returns: | string | GET parameters for current clipboard content to be exported. |
Removes element on clipboard
| $el | string | Key of element in ->clipData array |
| Returns: | void |
Saves the clipboard, no questions asked.
Use ->endClipboard normally (as it checks if changes has been done so saving is necessary)
| Returns: | void |
This traverses the elements on the current clipboard pane
and unsets elements which does not exist anymore or are disabled.
| Returns: | void |
Counts the number of elements from the table $matchTable. If $matchTable is blank, all tables (except '_FILE' of course) is counted.
| $matchTable='' | string | Table to match/count for. |
| $pad='' | string | $pad can optionally be used to set another pad than the current. |
| Returns: | array | Array with keys from the CB. |
Verifies if the item $table/$uid is on the current pad.
If the pad is "normal", the mode value is returned if the element existed. Thus you'll know if the item was copy or cut moded...
| $table | string | Table name, (_FILE for files...) |
| $uid | integer | Element uid (path for files) |
| Returns: | string |
Returns item record $table,$uid if selected on current clipboard
If table and uid is blank, the first element is returned.
Makes sense only for DB records - not files!
| $table='' | string | Table name |
| $uid='' | integer | Element uid |
| Returns: | array | Element record with extra field _RECORD_TITLE set to the title of the record... |
Reports if the current pad has elements (does not check file/DB type OR if file/DBrecord exists or not. Only counting array)
| Returns: | boolean | True if elements exist. |
Applies the proper paste configuration in the $cmd array send to tce_db.php.
$ref is the target, see description below.
The current pad is pasted
$ref: [tablename]:[paste-uid].
tablename is the name of the table from which elements *on the current clipboard* is pasted with the 'pid' paste-uid.
No tablename means that all items on the clipboard (non-files) are pasted. This requires paste-uid to be positive though.
so 'tt_content:-3' means 'paste tt_content elements on the clipboard to AFTER tt_content:3 record
'tt_content:30' means 'paste tt_content elements on the clipboard into page with id 30
':30' means 'paste ALL database elements on the clipboard into page with id 30
':-30' not valid.
| $ref | string | [tablename]:[paste-uid], see description |
| $CMD | array | Command-array |
| Returns: | array | Modified Command-array |
Delete record entries in CMD array
| $CMD | array | Command-array |
| Returns: | array | Modified Command-array |
Applies the proper paste configuration in the $file array send to tce_file.php.
The current pad is pasted
| $ref | string | Reference to element (splitted by "|") |
| $FILE | array | Command-array |
| Returns: | array | Modified Command-array |
Delete files in CMD array
| $FILE | array | Command-array |
| Returns: | array | Modified Command-array |
Class for conversion between charsets
| Filesize: | 64 K |
| Func/Classes: | 36 |
| Tags: | @author Kasper Skaarhoj <kasperYYYY@typo3.com> @author Martin Kutschker <martin.t.kutschker@blackbox.net> @package TYPO3 @subpackage t3lib |
Class for conversion between charsets
| Returns: | [type] | ... |
| @author Kasper Skaarhoj <kasperYYYY@typo3.com> | ||
| @author Martin Kutschker <martin.t.kutschker@blackbox.net> | ||
| @package TYPO3 | ||
| @subpackage t3lib | ||
Normalize - changes input character set to lowercase letters.
| $charset | string | Input charset |
| Returns: | string | Normalized charset |
| @author Martin Kutschker <martin.t.kutschker@blackbox.net> | ||
Get the charset of a locale.
ln language
ln_CN language / country
ln_CN.cs language / country / charset
ln_CN.cs@mod language / country / charset / modifier
| $locale | string | Locale string |
| Returns: | string | Charset resolved for locale string |
| @author Martin Kutschker <martin.t.kutschker@blackbox.net> | ||
Convert from one charset to another charset.
| $str | string | Input string |
| $fromCS | string | From charset (the current charset of the string) |
| $toCS | string | To charset (the output charset wanted) |
| $useEntityForNoChar=0 | boolean | If set, then characters that are not available in the destination character set will be encoded as numeric entities |
| Returns: | string | Converted string |
| @see convArray() | ||
Convert all elements in ARRAY from one charset to another charset.
NOTICE: Array is passed by reference!
| &$array | string | Input array, possibly multidimensional |
| $fromCS | string | From charset (the current charset of the string) |
| $toCS | string | To charset (the output charset wanted) |
| $useEntityForNoChar=0 | boolean | If set, then characters that are not available in the destination character set will be encoded as numeric entities |
| Returns: | void | |
| @see conv() | ||
Converts $str from $charset to UTF-8
| $str | string | String in local charset to convert to UTF-8 |
| $charset | string | Charset, lowercase. Must be found in csconvtbl/ folder. |
| Returns: | string | Output string, converted to UTF-8 |
Converts $str from UTF-8 to $charset
| $str | string | String in UTF-8 to convert to local charset |
| $charset | string | Charset, lowercase. Must be found in csconvtbl/ folder. |
| $useEntityForNoChar=0 | boolean | If set, then characters that are not available in the destination character set will be encoded as numeric entities |
| Returns: | string | Output string, converted to local charset |
Converts all chars > 127 to numeric entities.
| $str | string | Input string |
| Returns: | string | Output string |
Converts numeric entities (UNICODE, eg. decimal (Ӓ) or hexadecimal ()) to UTF-8 multibyte chars
| $str | string | Input string, UTF-8 |
| $alsoStdHtmlEnt=0 | boolean | If set, then all string-HTML entities (like & or £ will be converted as well) |
| Returns: | string | Output string |
Converts all chars in the input UTF-8 string into integer numbers returned in an array
| $str | string | Input string, UTF-8 |
| $convEntities=0 | boolean | If set, then all HTML entities (like & or £ or { or 㽝) will be detected as characters. |
| $retChar=0 | boolean | If set, then instead of integer numbers the real UTF-8 char is returned. |
| Returns: | array | Output array with the char numbers |
Converts a UNICODE number to a UTF-8 multibyte character
Algorithm based on script found at From: http://czyborra.com/utf/
Unit-tested by Kasper
The binary representation of the character's integer value is thus simply spread across the bytes and the number of high bits set in the lead byte announces the number of bytes in the multibyte sequence:
bytes | bits | representation
1 | 7 | 0vvvvvvv
2 | 11 | 110vvvvv 10vvvvvv
3 | 16 | 1110vvvv 10vvvvvv 10vvvvvv
4 | 21 | 11110vvv 10vvvvvv 10vvvvvv 10vvvvvv
5 | 26 | 111110vv 10vvvvvv 10vvvvvv 10vvvvvv 10vvvvvv
6 | 31 | 1111110v 10vvvvvv 10vvvvvv 10vvvvvv 10vvvvvv 10vvvvvv
| $cbyte | integer | UNICODE integer |
| Returns: | string | UTF-8 multibyte character string |
| @see utf8CharToUnumber() | ||
Converts a UTF-8 Multibyte character to a UNICODE number
Unit-tested by Kasper
| $str | string | UTF-8 multibyte character string |
| $hex=0 | boolean | If set, then a hex. number is returned. |
| Returns: | integer | UNICODE integer |
| @see UnumberToChar() | ||
This will initialize a charset for use if it's defined in the PATH_t3lib.'csconvtbl/' folder
This function is automatically called by the conversion functions
PLEASE SEE: http://www.unicode.org/Public/MAPPINGS/
| $charset | string | The charset to be initialized. Use lowercase charset always (the charset must match exactly with a filename in csconvtbl/ folder ([charset].tbl) |
| Returns: | integer | Returns '1' if already loaded. Returns FALSE if charset conversion table was not found. Returns '2' if the charset conversion table was found and parsed. |
This function initializes all UTF-8 character data tables.
PLEASE SEE: http://www.unicode.org/Public/UNIDATA/
| $mode=null | string | Mode ("case", "ascii", ...) |
| Returns: | integer | Returns FALSE on error, a TRUE value on success: 1 table already loaded, 2, cached version, 3 table parsed (and cached). |
This function initializes the folding table for a charset other than UTF-8.
This function is automatically called by the case folding functions.
| $charset | string | Charset for which to initialize case folding. |
| Returns: | integer | Returns FALSE on error, a TRUE value on success: 1 table already loaded, 2, cached version, 3 table parsed (and cached). |
This function initializes the to-ASCII conversion table for a charset other than UTF-8.
This function is automatically called by the ASCII transliteration functions.
| $charset | string | Charset for which to initialize conversion. |
| Returns: | integer | Returns FALSE on error, a TRUE value on success: 1 table already loaded, 2, cached version, 3 table parsed (and cached). |
Returns a part of a string.
Unit-tested by Kasper (single byte charsets only)
| $charset | string | The character set |
| $string | string | Character string |
| $start | integer | Start position (character position) |
| $len=null | integer | Length (in characters) |
| Returns: | string | The substring |
| @see substr(), mb_substr() | ||
| @author Martin Kutschker <martin.t.kutschker@blackbox.net> | ||
Counts the number of characters.
Unit-tested by Kasper (single byte charsets only)
| $charset | string | The character set |
| $string | string | Character string |
| Returns: | integer | The number of characters |
| @see strlen() | ||
| @author Martin Kutschker <martin.t.kutschker@blackbox.net> | ||
Truncates a string and pre-/appends a string.
Unit tested by Kasper
| $charset | string | The character set |
| $string | string | Character string |
| $len | integer | Length (in characters) |
| $crop='' | string | Crop signifier |
| Returns: | string | The shortened string |
| @see substr(), mb_strimwidth() | ||
| @author Martin Kutschker <martin.t.kutschker@blackbox.net> | ||