Standard functions available for the TYPO3 backend.
Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
Files: 1
Total filesizes: 100 Kbytes
Functions and classes: 79
Standard functions available for the TYPO3 backend.
Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
@package: TYPO3
@subpackage: t3lib
Standard functions available for the TYPO3 backend.
Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
Filesize: | 100 K |
Func/Classes: | 79 |
Tags: | @author Kasper Skaarhoj <kasper@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 <kasper@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: 80
$table | string | Table name present in $TCA |
Returns: | string | WHERE clause for filtering out deleted records, eg " AND NOT tablename.deleted" |
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: 168
$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: 1 (class t3lib_fullsearch)
$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 |
@depreciated 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: 3
$field | string | Table field name |
$value | string | Value to find in list |
Returns: | string | WHERE clause for a query |
@depreciated 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.
DEPRECIATED - 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 |
@depreciated | ||
@see t3lib_DB::exec_SELECT_mm_query() |
Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
DEPRECIATED - $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 |
@depreciated |
Creates
an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...')
from the array with field/value pairs $fields_values.
DEPRECIATED - $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 |
@depreciated |
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: 13
$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 proces if we meet a page, the user has no reading access to. |
Returns: | array | Root line array, all the way to the page tree root (or as far as $clause allows!) |
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: 23
$uid | integer | Page uid for which to create record path |
$clause | string | $clause is additional where clauses, eg. " |
$titleLimit | integer | Title limit |
Returns: | string | Path of record |
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
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.
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: 3
$str | string | Content from the "types" configuration of TCA (the special configuration) - see description of function |
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
$conf | array | Field config array |
$row | array | Record data |
$table | string | The table name |
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 | 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" of the number of $seconds inputted.
Usage: 15
$seconds | integer | $seconds could be the difference of a certain timestamp and time() |
$labels | 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: 203
$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 | |
@depreciated 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.
$content | string | Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output) |
Returns: | string |
Returns a linked image-tag for thumbnail(s) 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='' | 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
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") |
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 |
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: 10
$table | string | Table name |
$field | string | Field name |
$BACK_PATH | string | Back path |
Returns: | string | HTML content for help text |
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 |
Returns a JavaScript string for viewing the page id, $id
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! |
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
$id | string | $id is the "&id=" parameter value to be sent to the module |
$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
$id | string | $id is the "&id=" parameter value to be sent to the module |
$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
$id | string | $id is the "&id=" parameter value to be sent to the module |
$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 |
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).
Usage: 2
$table | string | Table name |
$uid | integer | Record uid |
$pid | integer | Record pid |
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: | integer | |
@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 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 |
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 |
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 | ||
@depreciated | ||
@obsolete |