tslib_cObj Class Reference

List of all members.

Public Member Functions

 start ($data, $table='')
 setParent ($data, $currentRecord)
 getCurrentVal ()
 setCurrentVal ($value)
 cObjGet ($setup, $addKey='')
 cObjGetSingle ($name, $conf, $TSkey='__')
 HTML ($conf)
 TEXT ($conf)
 CLEARGIF ($conf)
 COBJ_ARRAY ($conf, $ext='')
 USER ($conf, $ext= '')
 getUserObjectType ()
 convertToUserIntObject ()
 FILE ($conf)
 IMAGE ($conf)
 IMG_RESOURCE ($conf)
 IMGTEXT ($conf)
 CONTENT ($conf)
 RECORDS ($conf)
 HMENU ($conf)
 CTABLE ($conf)
 OTABLE ($conf)
 COLUMNS ($conf)
 HRULER ($conf)
 CASEFUNC ($conf)
 LOAD_REGISTER ($conf, $name)
 FORM ($conf, $formData='')
 SEARCHRESULT ($conf)
 PHP_SCRIPT ($conf, $ext='')
 TEMPLATE ($conf)
 MULTIMEDIA ($conf)
 getSlidePids ($pidList, $pidConf)
 getFieldDefaultValue ($noValueInsert, $fieldName, $defaultVal)
 cImage ($file, $conf)
 getBorderAttr ($borderAttr)
 imageLinkWrap ($string, $imageFile, $conf)
 fileResource ($fName, $addParams='alt=""title=""')
 lastChanged ($tstamp)
 linkWrap ($content, $wrap)
 getAltParam ($conf, $longDesc=true)
 cleanFormName ($name)
 getATagParams ($conf, $addGlobal=1)
 getSubpart ($content, $marker)
 substituteSubpart ($content, $marker, $subpartContent, $recursive=1)
 substituteSubpartArray ($content, array $subpartsContent)
 substituteMarker ($content, $marker, $markContent)
 substituteMarkerArrayCached ($content, array $markContentArray=NULL, array $subpartContentArray=NULL, array $wrappedSubpartContentArray=NULL)
 substituteMarkerArray ($content, array $markContentArray, $wrap= '', $uppercase=false, $deleteUnused=false)
 substituteMarkerInObject (&$tree, array $markContentArray)
 fillInMarkerArray (array $markContentArray, array $row, $fieldList= '', $nl2br=true, $prefix= 'FIELD_', $HSC=false)
 stdWrap ($content, $conf)
 numRows ($conf)
 listNum ($content, $listNum, $char)
 checkIf ($conf)
 filelist ($data)
 clean_directory ($theDir)
 HTMLparser_TSbridge ($theValue, $conf)
 dataWrap ($content, $wrap)
 insertData ($str)
 prefixComment ($str, $conf, $content)
 substring ($content, $options)
 crop ($content, $options)
 removeBadHTML ($text, $conf)
 textStyle ($theValue, $conf)
 tableStyle ($theValue, $conf)
 addParams ($content, $conf)
 filelink ($theValue, $conf)
 locDataJU ($jumpUrl, $conf)
 calc ($val)
 calcIntExplode ($delim, $string)
 splitObj ($value, $conf)
 parseFunc ($theValue, $conf, $ref='')
 _parseFunc ($theValue, $conf)
 encaps_lineSplit ($theValue, $conf)
 http_makelinks ($data, $conf)
 mailto_makelinks ($data, $conf)
 getImgResource ($file, $fileArray)
 getFieldVal ($field)
 getData ($string, $fieldArray)
 rootLineValue ($key, $field, $slideBack=0, $altRootLine='')
 getGlobal ($var, $source=NULL)
 getKey ($key, $arr)
 TCAlookup ($inputValue, $conf)
 typoLink ($linktxt, $conf)
 typoLink_URL ($conf)
 getTypoLink ($label, $params, $urlParameters=array(), $target='')
 getTypoLink_URL ($params, $urlParameters=array(), $target='')
 typolinkWrap ($conf)
 currentPageUrl ($urlParameters=array(), $id=0)
 getClosestMPvalueForPage ($pageId, $raw=FALSE)
 getMailTo ($mailAddress, $linktxt, $initP='?')
 getQueryArguments ($conf, $overruleQueryArgs=array(), $forceArgs=FALSE)
 wrap ($content, $wrap, $char='|')
 noTrimWrap ($content, $wrap)
 wrapSpace ($content, $wrap, array $conf=NULL)
 callUserFunction ($funcName, $conf, $content)
 processParams ($params)
 keywords ($content)
 caseshift ($theValue, $case)
 HTMLcaseshift ($theValue, $case)
 bytes ($sizeInBytes, $labels)
 calcAge ($seconds, $labels)
 sendNotifyEmail ($msg, $recipients, $cc, $email_from, $email_fromName='', $replyTo='')
 URLqMark ($url, $params)
 checkEmail ($email)
 clearTSProperties ($TSArr, $propList)
 mergeTSRef ($confArr, $prop)
 joinTSarrays ($conf, $old_conf)
 gifBuilderTextBox ($gifbuilderConf, $conf, $text)
 linebreaks ($string, $chars, $maxLines=0)
 getUpdateJS ($dataArray, $formName, $arrPrefix, $fieldList)
 DBgetDelete ($table, $uid, $doExec=FALSE)
 DBgetUpdate ($table, $uid, $dataArr, $fieldList, $doExec=FALSE)
 DBgetInsert ($table, $pid, $dataArr, $fieldList, $doExec=FALSE)
 DBmayFEUserEdit ($table, $row, $feUserRow, $allowedGroups='', $feEditSelf=0)
 DBmayFEUserEditSelect ($table, $feUserRow, $allowedGroups='', $feEditSelf=0)
 enableFields ($table, $show_hidden=0)
 getTreeList ($id, $depth, $begin=0, $dontCheckEnableFields=false, $addSelectFields= '', $moreWhereClauses= '', array $prevId_array=array(), $recursionLevel=0)
 whereSelectFromList ($field, $value)
 exec_mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause='', $groupBy='', $orderBy='', $limit='')
 exec_mm_query_uidList ($select, $local_table_uidlist, $mm_table, $foreign_table='', $whereClause='', $groupBy='', $orderBy='', $limit='')
 searchWhere ($sw, $searchFieldList, $searchTable='')
 exec_getQuery ($table, $conf)
 getQuery ($table, $conf, $returnQueryArray=FALSE)
 getWhere ($table, $conf, $returnQueryArray=FALSE)
 checkPidArray ($listArr)
 checkPid ($uid)
 editPanel ($content, $conf, $currentRecord='', $dataArr=array())
 editIcons ($content, $params, $conf=array(), $currentRecord='', $dataArr=array(), $addUrlParamStr='')
 isDisabled ($table, $row)

Public Attributes

 $align = Array ('center', 'right', 'left')
 $image_compression
 $image_effects
 $data = Array()
 $oldData = Array()
 $alternativeData = ''
 $parameters = Array()
 $currentValKey = 'currentValue_kidjls9dksoje'
 $currentRecord = ''
 $currentRecordTotal = 0
 $currentRecordNumber = 0
 $parentRecordNumber = 0
 $parentRecord = array()
 $regObj
 $INT_include = 0
 $checkPid_cache = Array()
 $checkPid_badDoktypeList = '255'
 $lastTypoLinkUrl = ''
 $lastTypoLinkTarget = ''
 $lastTypoLinkLD = array()
 $substMarkerCache = array()
 $recordRegister = array()
 $cObjHookObjectsArr = array()
const OBJECTTYPE_USER_INT = 1
const OBJECTTYPE_USER = 2

Protected Member Functions

 includeLibs (array $config)
 isClassAvailable ($className, array $config=NULL)

Protected Attributes

 $stdWrapHookObjects = array()
 $doConvertToUserIntObject = false
 $userObjectType = false

Detailed Description

Definition at line 256 of file class.tslib_content.php.


Member Function Documentation

tslib_cObj::_parseFunc ( theValue,
conf 
)

Helper function for parseFunc()

Parameters:
string The value to process.
array TypoScript configuration for parseFunc
Returns:
string The processed value private
See also:
parseFunc()

Definition at line 4359 of file class.tslib_content.php.

References $GLOBALS, $key, $val, t3lib_div::get_tag_attributes(), and t3lib_div::inList().

tslib_cObj::addParams ( content,
conf 
)

Implements the TypoScript function "addParams"

Parameters:
string The string with the HTML tag.
array The TypoScript configuration properties
Returns:
string The modified string
Todo:
Make it XHTML compatible. Will not present "/>" endings of tags right now. Further getting the tagname might fail if it is not separated by a normal space from the attributes. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=325&cHash=ae4272e694

Definition at line 3995 of file class.tslib_content.php.

References $content, $key, $val, t3lib_div::get_tag_attributes(), and t3lib_div::implodeAttributes().

Referenced by stdWrap().

tslib_cObj::bytes ( sizeInBytes,
labels 
)

Formats a number to GB, Mb or Kb or just bytes

Parameters:
integer Number of bytes to format.
string Labels for bytes, kilo, mega and giga separated by vertical bar (|) and possibly encapsulated in "". Eg: " | K| M| G" (which is the default value)
Returns:
string
See also:
t3lib_div::formatSize(), stdWrap()
Deprecated:
since TYPO3 4.0 - Use t3lib_div::formatSize() instead

Definition at line 6127 of file class.tslib_content.php.

References t3lib_div::formatSize().

Referenced by stdWrap().

tslib_cObj::calc ( val  ) 

Performs basic mathematical evaluation of the input string. Does NOT take parathesis and operator precedence into account! (for that, see t3lib_div::calcPriority())

Parameters:
string The string to evaluate. Example: "3+4*10/5" will generate "35". Only integer numbers can be used.
Returns:
integer The result (might be a float if you did a division of the numbers).
See also:
t3lib_div::calcPriority()

Definition at line 4138 of file class.tslib_content.php.

References $val, $value, and t3lib_div::splitCalc().

Referenced by calcIntExplode(), checkIf(), listNum(), and tslib_menu::makeMenu().

tslib_cObj::calcAge ( seconds,
labels 
)

Returns the 'age' of the tstamp $seconds

Parameters:
integer Seconds to return age for. Example: "70" => "1 min", "3601" => "1 hrs"
string $labels are the labels of the individual units. Defaults to : ' min| hrs| days| yrs'
Returns:
string The formatted string

Definition at line 6138 of file class.tslib_content.php.

References t3lib_div::testInt().

Referenced by stdWrap().

tslib_cObj::calcIntExplode ( delim,
string 
)

This explodes a comma-list into an array where the values are parsed through tslib_cObj::calc() and intval() (so you are sure to have integers in the output array) Used to split and calculate min and max values for GMENUs.

Parameters:
string Delimited to explode by
string The string with parts in (where each part is evaluated by ->calc())
Returns:
array And array with evaluated values.
See also:
calc(), tslib_gmenu::makeGifs()

Definition at line 4167 of file class.tslib_content.php.

References $key, $val, and calc().

tslib_cObj::callUserFunction ( funcName,
conf,
content 
)

Calling a user function/class-method Notice: For classes the instantiated object will have the internal variable, $cObj, set to be a *reference* to $this (the parent/calling object).

Parameters:
string The functionname, eg "user_myfunction" or "user_myclass->main". Notice that there are rules for the names of functions/classes you can instantiate. If a function cannot be called for some reason it will be seen in the TypoScript log in the AdminPanel.
array The TypoScript configuration to pass the function
string The content string to pass the function
Returns:
string The return content from the function call. Should probably be a string.
See also:
USER(), stdWrap(), typoLink(), _parseFunc()

Definition at line 5996 of file class.tslib_content.php.

References $content, $GLOBALS, t3lib_div::isFirstPartOfStr(), and t3lib_div::makeInstanceClassName().

Referenced by stdWrap(), and USER().

tslib_cObj::CASEFUNC ( conf  ) 

Rendering the cObject, CASE

Parameters:
array Array of TypoScript properties
Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=364&cHash=cffedd09e3

Definition at line 1625 of file class.tslib_content.php.

References $content, $key, checkIf(), cObjGetSingle(), and stdWrap().

Referenced by cObjGetSingle().

tslib_cObj::caseshift ( theValue,
case 
)

Changing character case of a string, converting typically used western charset characters as well.

Parameters:
string The string to change case for.
string The direction; either "upper" or "lower"
Returns:
string
See also:
HTMLcaseshift()

Definition at line 6073 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::checkEmail ( email  ) 

Checking syntax of input email address

Parameters:
string Input string to evaluate
Returns:
boolean Returns true if the $email address (input string) is valid; Has a "@", domain name with at least one period and only allowed a-z characters.
See also:
t3lib_div::validEmail()
Deprecated:
since TYPO3 4.0

Definition at line 6213 of file class.tslib_content.php.

References t3lib_div::validEmail().

tslib_cObj::checkIf ( conf  ) 

Compares values together based on the settings in the input TypoScript array and returns true or false based on the comparison result. Implements the "if" function in TYPO3 TypoScript

Parameters:
array TypoScript properties defining what to compare
Returns:
boolean &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=320&cHash=da01618eab HMENU(), CASEFUNC(), IMAGE(), COLUMN(), stdWrap(), _parseFunc()

Definition at line 3548 of file class.tslib_content.php.

References $value, calc(), t3lib_div::inList(), and stdWrap().

Referenced by CASEFUNC(), COBJ_ARRAY(), COLUMNS(), HMENU(), IMAGE(), and stdWrap().

tslib_cObj::checkPid ( uid  ) 

Checks if a page UID is available due to enableFields() AND the list of bad doktype numbers ($this->checkPid_badDoktypeList)

Parameters:
integer Page UID to test
Returns:
boolean True if OK private
See also:
getWhere(), checkPidArray()

Definition at line 7230 of file class.tslib_content.php.

References $GLOBALS, and $res.

Referenced by RECORDS().

tslib_cObj::checkPidArray ( listArr  ) 

Removes Page UID numbers from the input array which are not available due to enableFields() or the list of bad doktype numbers ($this->checkPid_badDoktypeList)

Parameters:
array Array of Page UID numbers for select and for which pages with enablefields and bad doktypes should be removed.
Returns:
array Returns the array of remaining page UID numbers private
See also:
getWhere(),checkPid()

Definition at line 7206 of file class.tslib_content.php.

References $GLOBALS, $res, and $row.

Referenced by getSlidePids().

tslib_cObj::cImage ( file,
conf 
)

Returns a tag with the image file defined by $file and processed according to the properties in the TypoScript array. Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript. This function is called by "$this->cImage($conf['file'],$conf);" from IMAGE().

Parameters:
string File TypoScript resource
array TypoScript configuration properties
Returns:
string tag, (possibly wrapped in links and other HTML) if any image found. private
See also:
IMAGE()

Definition at line 2707 of file class.tslib_content.php.

References $GLOBALS, getAltParam(), getImgResource(), imageLinkWrap(), linkWrap(), t3lib_div::png_to_gif_by_imagemagick(), and wrap().

Referenced by IMAGE().

tslib_cObj::clean_directory ( theDir  ) 

Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.

Parameters:
string Absolute path to directory
Returns:
string The directory path if it existed as was valid to access. private
See also:
filelist()

Definition at line 3694 of file class.tslib_content.php.

References t3lib_div::isAbsPath(), and t3lib_div::validPathStr().

Referenced by filelist().

tslib_cObj::cleanFormName ( name  ) 

Removes forbidden characters and spaces from name/id attributes in the form tag and formfields

Parameters:
string Input string
Returns:
string the cleaned string
See also:
FORM()

Definition at line 2928 of file class.tslib_content.php.

Referenced by FORM().

tslib_cObj::CLEARGIF ( conf  ) 

Rendering the cObject, CLEARGIF

Parameters:
array Array of TypoScript properties
Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=355&cHash=70c0f19915

Definition at line 676 of file class.tslib_content.php.

References getBorderAttr(), stdWrap(), and wrap().

Referenced by cObjGetSingle().

tslib_cObj::clearTSProperties ( TSArr,
propList 
)

Clears TypoScript properties listed in $propList from the input TypoScript array.

Parameters:
array TypoScript array of values/properties
string List of properties to clear both value/properties for. Eg. "myprop,another_property"
Returns:
array The TypoScript array
See also:
gifBuilderTextBox()

Definition at line 6225 of file class.tslib_content.php.

tslib_cObj::COBJ_ARRAY ( conf,
ext = '' 
)

Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT

Parameters:
array Array of TypoScript properties
string If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached)
Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=351&cHash=a09db0329c

Definition at line 695 of file class.tslib_content.php.

References $content, $GLOBALS, checkIf(), cObjGet(), includeLibs(), stdWrap(), and wrap().

Referenced by cObjGetSingle().

tslib_cObj::cObjGet ( setup,
addKey = '' 
)

Rendering of a "numerical array" of cObjects from TypoScript Will call ->cObjGetSingle() for each cObject found and accumulate the output.

Parameters:
array $setup: Array with cObjects as values.
string $addKey: A prefix for the debugging information
Returns:
string Rendered output from the cObjects in the array.
See also:
cObjGetSingle()

Definition at line 462 of file class.tslib_content.php.

References $content, cObjGetSingle(), and t3lib_TStemplate::sortedKeyList().

Referenced by COBJ_ARRAY(), CTABLE(), IMGTEXT(), and OTABLE().

tslib_cObj::cObjGetSingle ( name,
conf,
TSkey = '__' 
)

Definition at line 486 of file class.tslib_content.php.

References $content, $GLOBALS, $key, $TYPO3_CONF_VARS, CASEFUNC(), CLEARGIF(), COBJ_ARRAY(), COLUMNS(), CONTENT(), CTABLE(), editPanel(), FILE(), FORM(), t3lib_div::getUserObj(), HMENU(), HRULER(), HTML(), IMAGE(), IMG_RESOURCE(), IMGTEXT(), t3lib_extMgm::isLoaded(), joinTSarrays(), LOAD_REGISTER(), t3lib_div::makeInstance(), MULTIMEDIA(), OTABLE(), PHP_SCRIPT(), RECORDS(), SEARCHRESULT(), TEMPLATE(), TEXT(), and USER().

Referenced by CASEFUNC(), cObjGet(), COLUMNS(), FORM(), IMGTEXT(), SEARCHRESULT(), stdWrap(), and TEMPLATE().

tslib_cObj::COLUMNS ( conf  ) 

Rendering the cObject, COLUMNS

Parameters:
array Array of TypoScript properties
Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=361&cHash=7e4e228cad

Definition at line 1521 of file class.tslib_content.php.

References $content, $GLOBALS, $val, checkIf(), cObjGetSingle(), t3lib_div::intInRange(), and stdWrap().

Referenced by cObjGetSingle().

tslib_cObj::CONTENT ( conf  ) 

Rendering the cObject, CONTENT

Parameters:
array Array of TypoScript properties
Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=356&cHash=9f3b5c6ba2

Definition at line 1269 of file class.tslib_content.php.

References $GLOBALS, $res, $row, exec_getQuery(), getSlidePids(), lastChanged(), t3lib_div::makeInstance(), stdWrap(), and wrap().

Referenced by cObjGetSingle().

tslib_cObj::convertToUserIntObject (  ) 

Requests the current USER object to be converted to USER_INT.

Returns:
void

Definition at line 782 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::crop ( content,
options 
)

Implements the stdWrap property "crop" which is a modified "substr" function allowing to limit a string lenght to a certain number of chars (from either start or end of string) and having a pre/postfix applied if the string really was cropped.

Parameters:
string The string to perform the operation on
string The parameters splitted by "|": First parameter is the max number of chars of the string. Negative value means cropping from end of string. Second parameter is the pre/postfix string to apply if cropping occurs. Third parameter is a boolean value. If set then crop will be applied at nearest space.
Returns:
string The processed input value. private
See also:
stdWrap()

Definition at line 3811 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by stdWrap().

tslib_cObj::CTABLE ( conf  ) 

Rendering the cObject, CTABLE

Parameters:
array Array of TypoScript properties
Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=359&cHash=2e0065b4e7

Definition at line 1468 of file class.tslib_content.php.

References cObjGet(), and t3lib_div::makeInstance().

Referenced by cObjGetSingle().

tslib_cObj::currentPageUrl ( urlParameters = array(),
id = 0 
)

Returns the current page URL

Parameters:
array Optionally you can specify additional URL parameters. An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
integer An alternative ID to the current id ($GLOBALS['TSFE']->id)
Returns:
string The URL
See also:
getTypoLink_URL()

Definition at line 5721 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::dataWrap ( content,
wrap 
)

Wrapping input value in a regular "wrap" but parses the wrapping value first for "insertData" codes.

Parameters:
string Input string being wrapped
string The wrap string, eg. "<b></b>" or more likely here '| ' which will wrap the input string in a tag linking to the current page.
Returns:
string Output string wrapped in the wrapping value.
See also:
insertData(), stdWrap()

Definition at line 3726 of file class.tslib_content.php.

References $content, insertData(), and wrap().

Referenced by stdWrap().

tslib_cObj::DBgetDelete ( table,
uid,
doExec = FALSE 
)

Returns an UPDATE/DELETE sql query which will "delete" the record. If the $TCA config for the table tells us to NOT "physically" delete the record but rather set the "deleted" field to "1" then an UPDATE query is returned doing just that. Otherwise it truely is a DELETE query.

Parameters:
string The table name, should be in $TCA
integer The UID of the record from $table which we are going to delete
boolean If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!!
Returns:
string The query, ready to execute unless $doExec was true in which case the return value is false.
See also:
DBgetUpdate(), DBgetInsert(), user_feAdmin

Definition at line 6497 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::DBgetInsert ( table,
pid,
dataArr,
fieldList,
doExec = FALSE 
)

Returns an INSERT sql query which automatically added "system-fields" according to $TCA Automatically fields for "tstamp", "crdate", "cruser_id", "fe_cruser_id" and "fe_crgroup_id" is updated if they are configured in the "ctrl" part of $TCA. The "pid" field is overridden by the input $pid value if >= 0 (zero). "uid" can never be set as a field NOTICE: From TYPO3 3.6.0 this function ALWAYS adds slashes to values inserted in the query.

Parameters:
string The table name, should be in $TCA
integer The PID value for the record to insert
array The data array where key/value pairs are fieldnames/values for the record to insert
string Comma list of fieldnames which are allowed to be inserted. Only values from the data record for fields in this list will be inserted!!
boolean If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!!
Returns:
string The query, ready to execute unless $doExec was true in which case the return value is false.
See also:
DBgetUpdate(), DBgetDelete(), user_feAdmin

Definition at line 6571 of file class.tslib_content.php.

References $GLOBALS, $pid, t3lib_div::inList(), and t3lib_div::trimExplode().

tslib_cObj::DBgetUpdate ( table,
uid,
dataArr,
fieldList,
doExec = FALSE 
)

Returns an UPDATE sql query. If a "tstamp" field is configured for the $table tablename in $TCA then that field is automatically updated to the current time. Notice: It is YOUR responsibility to make sure the data being updated is valid according the tablefield types etc. Also no logging is performed of the update. It's just a nice general usage API function for creating a quick query. NOTICE: From TYPO3 3.6.0 this function ALWAYS adds slashes to values inserted in the query.

Parameters:
string The table name, should be in $TCA
integer The UID of the record from $table which we are going to update
array The data array where key/value pairs are fieldnames/values for the record to update.
string Comma list of fieldnames which are allowed to be updated. Only values from the data record for fields in this list will be updated!!
boolean If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!!
Returns:
string The query, ready to execute unless $doExec was true in which case the return value is false.
See also:
DBgetInsert(), DBgetDelete(), user_feAdmin

Definition at line 6529 of file class.tslib_content.php.

References $GLOBALS, t3lib_div::inList(), and t3lib_div::trimExplode().

tslib_cObj::DBmayFEUserEdit ( table,
row,
feUserRow,
allowedGroups = '',
feEditSelf = 0 
)

Checks if a frontend user is allowed to edit a certain record

Parameters:
string The table name, found in $TCA
array The record data array for the record in question
array The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user
string Commalist of the only fe_groups uids which may edit the record. If not set, then the usergroup field of the fe_user is used.
boolean True, if the fe_user may edit his own fe_user record.
Returns:
boolean
See also:
user_feAdmin

Definition at line 6608 of file class.tslib_content.php.

References $GLOBALS, $row, t3lib_div::inList(), and t3lib_div::trimExplode().

tslib_cObj::DBmayFEUserEditSelect ( table,
feUserRow,
allowedGroups = '',
feEditSelf = 0 
)

Returns part of a where clause for selecting records from the input table name which the user may edit. Conceptually close to the function DBmayFEUserEdit(); It does the same thing but not for a single record, rather for a select query selecting all records which the user HAS access to.

Parameters:
string The table name
array The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user
string Commalist of the only fe_groups uids which may edit the record. If not set, then the usergroup field of the fe_user is used.
boolean True, if the fe_user may edit his own fe_user record.
Returns:
string The where clause part. ALWAYS returns a string. If no access at all, then " AND 1=0"
See also:
DBmayFEUserEdit(), user_feAdmin::displayEditScreen()

Definition at line 6648 of file class.tslib_content.php.

References $GLOBALS, t3lib_div::intExplode(), and t3lib_div::trimExplode().

tslib_cObj::editIcons ( content,
params,
conf = array(),
currentRecord = '',
dataArr = array(),
addUrlParamStr = '' 
)

Adds an edit icon to the content string. The edit icon links to alt_doc.php with proper parameters for editing the table/fields of the context. This implements TYPO3 context sensitive editing facilities. Only backend users will have access (if properly configured as well).

Parameters:
string The content to which the edit icons should be appended
string The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to alt_doc.php
array TypoScript properties for configuring the edit icons.
string The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
array Alternative data array to use. Default is $this->data
string Additional URL parameters for the link pointing to alt_doc.php
Returns:
string The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.

Definition at line 7317 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by IMGTEXT(), and stdWrap().

tslib_cObj::editPanel ( content,
conf,
currentRecord = '',
dataArr = array() 
)

Generates the "edit panels" which can be shown for a page or records on a page when the Admin Panel is enabled for a backend users surfing the frontend. With the "edit panel" the user will see buttons with links to editing, moving, hiding, deleting the element This function is used for the cObject EDITPANEL and the stdWrap property ".editPanel"

Parameters:
string A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.