![]() |
TYPO3
7.6
|
Public Member Functions | |
__construct (TypoScriptFrontendController $typoScriptFrontendController=null) | |
__sleep () | |
__wakeup () | |
setContentObjectClassMap (array $contentObjectClassMap) | |
registerContentObjectClass ($className, $contentObjectName) | |
start ($data, $table= '') | |
getCurrentTable () | |
setParent ($data, $currentRecord) | |
getCurrentVal () | |
setCurrentVal ($value) | |
cObjGet ($setup, $addKey= '') | |
getContentObject ($name) | |
FLOWPLAYER ($conf) | |
TEXT ($conf) | |
CLEARGIF ($conf) | |
COBJ_ARRAY ($conf, $ext= '') | |
USER ($conf, $ext= '') | |
getUserObjectType () | |
setUserObjectType ($userObjectType) | |
convertToUserIntObject () | |
FILE ($conf) | |
FILES ($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) | |
TEMPLATE ($conf) | |
MULTIMEDIA ($conf) | |
MEDIA ($conf) | |
SWFOBJECT ($conf) | |
QTOBJECT ($conf) | |
SVG ($conf) | |
readFlexformIntoConf ($flexData, &$conf, $recursive=false) | |
getSlidePids ($pidList, $pidConf) | |
cImage ($file, $conf) | |
getBorderAttr ($borderAttr) | |
getImageTagTemplate ($layoutKey, $conf) | |
getImageSourceCollection ($layoutKey, $conf, $file) | |
imageLinkWrap ($string, $imageFile, $conf) | |
fileResource ($fName, $addParams= 'alt=""title=""') | |
lastChanged ($tstamp) | |
linkWrap ($content, $wrap) | |
getAltParam ($conf, $longDesc=true) | |
cleanFormName ($name) | |
getATagParams ($conf, $addGlobal=1) | |
extLinkATagParams ($URL, $TYPE) | |
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) | |
substituteMarkerAndSubpartArrayRecursive ($content, array $markersAndSubparts, $wrap= '', $uppercase=false, $deleteUnused=false) | |
fillInMarkerArray (array $markContentArray, array $row, $fieldList= '', $nl2br=true, $prefix= 'FIELD_', $HSC=false) | |
setCurrentFile ($fileObject) | |
getCurrentFile () | |
stdWrap ($content= '', $conf=array()) | |
stdWrapValue ($key, array $config, $defaultValue= '') | |
stdWrap_cacheRead ($content= '', $conf=array()) | |
stdWrap_addPageCacheTags ($content= '', $conf=array()) | |
stdWrap_setContentToCurrent ($content= '') | |
stdWrap_setCurrent ($content= '', $conf=array()) | |
stdWrap_lang ($content= '', $conf=array()) | |
stdWrap_data ($content= '', $conf=array()) | |
stdWrap_field ($content= '', $conf=array()) | |
stdWrap_current ($content= '', $conf=array()) | |
stdWrap_cObject ($content= '', $conf=array()) | |
stdWrap_numRows ($content= '', $conf=array()) | |
stdWrap_filelist ($content= '', $conf=array()) | |
stdWrap_preUserFunc ($content= '', $conf=array()) | |
stdWrap_override ($content= '', $conf=array()) | |
stdWrap_preIfEmptyListNum ($content= '', $conf=array()) | |
stdWrap_ifNull ($content= '', $conf=array()) | |
stdWrap_ifEmpty ($content= '', $conf=array()) | |
stdWrap_ifBlank ($content= '', $conf=array()) | |
stdWrap_listNum ($content= '', $conf=array()) | |
stdWrap_trim ($content= '') | |
stdWrap_strPad ($content= '', $conf=array()) | |
stdWrap_stdWrap ($content= '', $conf=array()) | |
stdWrap_required ($content= '') | |
stdWrap_if ($content= '', $conf=array()) | |
stdWrap_fieldRequired ($content= '', $conf=array()) | |
stdWrap_csConv ($content= '', $conf=array()) | |
stdWrap_parseFunc ($content= '', $conf=array()) | |
stdWrap_HTMLparser ($content= '', $conf=array()) | |
stdWrap_split ($content= '', $conf=array()) | |
stdWrap_replacement ($content= '', $conf=array()) | |
stdWrap_prioriCalc ($content= '', $conf=array()) | |
stdWrap_char ($content= '', $conf=array()) | |
stdWrap_intval ($content= '') | |
stdWrap_hash ($content= '', array $conf=array()) | |
stdWrap_round ($content= '', $conf=array()) | |
stdWrap_numberFormat ($content= '', $conf=array()) | |
stdWrap_expandList ($content= '') | |
stdWrap_date ($content= '', $conf=array()) | |
stdWrap_strftime ($content= '', $conf=array()) | |
stdWrap_strtotime ($content= '', $conf=array()) | |
stdWrap_age ($content= '', $conf=array()) | |
stdWrap_case ($content= '', $conf=array()) | |
stdWrap_bytes ($content= '', $conf=array()) | |
stdWrap_substring ($content= '', $conf=array()) | |
stdWrap_removeBadHTML ($content= '') | |
stdWrap_cropHTML ($content= '', $conf=array()) | |
stdWrap_stripHtml ($content= '') | |
stdWrap_crop ($content= '', $conf=array()) | |
stdWrap_rawUrlEncode ($content= '') | |
stdWrap_htmlSpecialChars ($content= '', $conf=array()) | |
stdWrap_encodeForJavaScriptValue ($content= '') | |
stdWrap_doubleBrTag ($content= '', $conf=array()) | |
stdWrap_br ($content= '') | |
stdWrap_brTag ($content= '', $conf=array()) | |
stdWrap_encapsLines ($content= '', $conf=array()) | |
stdWrap_keywords ($content= '') | |
stdWrap_innerWrap ($content= '', $conf=array()) | |
stdWrap_innerWrap2 ($content= '', $conf=array()) | |
stdWrap_fontTag ($content= '', $conf=array()) | |
stdWrap_addParams ($content= '', $conf=array()) | |
stdWrap_textStyle ($content= '', $conf=array()) | |
stdWrap_tableStyle ($content= '', $conf=array()) | |
stdWrap_filelink ($content= '', $conf=array()) | |
stdWrap_preCObject ($content= '', $conf=array()) | |
stdWrap_postCObject ($content= '', $conf=array()) | |
stdWrap_wrapAlign ($content= '', $conf=array()) | |
stdWrap_typolink ($content= '', $conf=array()) | |
stdWrap_TCAselectItem ($content= '', $conf=array()) | |
stdWrap_spaceBefore ($content= '', $conf=array()) | |
stdWrap_spaceAfter ($content= '', $conf=array()) | |
stdWrap_space ($content= '', $conf=array()) | |
stdWrap_wrap ($content= '', $conf=array()) | |
stdWrap_noTrimWrap ($content= '', $conf=array()) | |
stdWrap_wrap2 ($content= '', $conf=array()) | |
stdWrap_dataWrap ($content= '', $conf=array()) | |
stdWrap_prepend ($content= '', $conf=array()) | |
stdWrap_append ($content= '', $conf=array()) | |
stdWrap_wrap3 ($content= '', $conf=array()) | |
stdWrap_orderedStdWrap ($content= '', $conf=array()) | |
stdWrap_outerWrap ($content= '', $conf=array()) | |
stdWrap_insertData ($content= '') | |
stdWrap_offsetWrap ($content= '', $conf=array()) | |
stdWrap_postUserFunc ($content= '', $conf=array()) | |
stdWrap_postUserFuncInt ($content= '', $conf=array()) | |
stdWrap_prefixComment ($content= '', $conf=array()) | |
stdWrap_editIcons ($content= '', $conf=array()) | |
stdWrap_editPanel ($content= '', $conf=array()) | |
stdWrap_debug ($content= '') | |
stdWrap_debugFunc ($content= '', $conf=array()) | |
stdWrap_debugData ($content= '') | |
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) | |
cropHTML ($content, $options) | |
removeBadHTML ($text) | |
textStyle ($theValue, $conf) | |
tableStyle ($theValue, $conf) | |
addParams ($content, $conf) | |
calc ($val) | |
calcIntExplode ($delim, $string) | |
splitObj ($value, $conf) | |
numberFormat ($content, $conf) | |
parseFunc ($theValue, $conf, $ref= '') | |
_parseFunc ($theValue, $conf) | |
encaps_lineSplit ($theValue, $conf) | |
http_makelinks ($data, $conf) | |
mailto_makelinks ($data, $conf) | |
getFieldVal ($field) | |
getData ($string, $fieldArray=null) | |
rootLineValue ($key, $field, $slideBack=0, $altRootLine= '') | |
getGlobal ($keyString, $source=null) | |
getKey ($key, $arr) | |
TCAlookup ($inputValue, $conf) | |
typoLink_URL ($conf) | |
getTypoLink ($label, $params, $urlParameters=array(), $target= '') | |
getUrlToCurrentLocation ($addQueryString=true) | |
getTypoLink_URL ($params, $urlParameters=array(), $target= '') | |
typolinkWrap ($conf) | |
currentPageUrl ($urlParameters=array(), $id=0) | |
getClosestMPvalueForPage ($pageId, $raw=false) | |
getMailTo ($mailAddress, $linktxt) | |
getQueryArguments ($conf, $overruleQueryArguments=array(), $forceOverruleArguments=false) | |
wrap ($content, $wrap, $char= '|') | |
noTrimWrap ($content, $wrap, $char= '|') | |
wrapSpace ($content, $wrap, array $conf=null) | |
callUserFunction ($funcName, $conf, $content) | |
processParams ($params) | |
keywords ($content) | |
caseshift ($theValue, $case) | |
HTMLcaseshift ($theValue, $case) | |
calcAge ($seconds, $labels) | |
URLqMark ($url, $params) | |
clearTSProperties ($TSArr, $propList) | |
mergeTSRef ($confArr, $prop) | |
gifBuilderTextBox ($gifbuilderConf, $conf, $text) | |
linebreaks ($string, $chars, $maxLines=0) | |
includeLibs (array $config) | |
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=false, array $ignore_array=array()) | |
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) | |
getRecords ($tableName, array $queryConfiguration) | |
getQuery ($table, $conf, $returnQueryArray=false) | |
getWhere ($table, $conf, $returnQueryArray=false) | |
checkPidArray ($listArr) | |
checkPid ($uid) | |
getQueryMarkers ($table, $conf) | |
editPanel ($content, $conf, $currentRecord= '', $dataArr=array()) | |
editIcons ($content, $params, array $conf=array(), $currentRecord= '', $dataArr=array(), $addUrlParamStr= '') | |
isDisabled ($table, $row) | |
Public Attributes | |
$align | |
$stdWrapOrder | |
$image_compression | |
$image_effects | |
$data = array() | |
$oldData = array() | |
$alternativeData = '' | |
$parameters = array() | |
$currentValKey = 'currentValue_kidjls9dksoje' | |
$currentRecord = '' | |
$currentRecordTotal = 0 | |
$currentRecordNumber = 0 | |
$parentRecordNumber = 0 | |
$parentRecord = array() | |
$INT_include = 0 | |
$checkPid_cache = array() | |
$checkPid_badDoktypeList = '255' | |
$lastTypoLinkUrl = '' | |
$lastTypoLinkTarget = '' | |
$lastTypoLinkLD = array() | |
$substMarkerCache = array() | |
$recordRegister = array() | |
$cObjHookObjectsArr = array() | |
$doConvertToUserIntObject = false | |
const | OBJECTTYPE_USER_INT = 1 |
const | OBJECTTYPE_USER = 2 |
Protected Member Functions | |
getGetImgResourceHookObjects () | |
createExceptionHandler ($configuration=array()) | |
determineExceptionHandlerClassName ($configuration) | |
mergeExceptionHandlerConfiguration ($configuration) | |
FLUIDTEMPLATE (array $conf) | |
replacement ($content, array $configuration) | |
replacementSingle ($content, array $configuration) | |
round ($content, array $conf=array()) | |
resolveMixedLinkParameter ($linkText, $mixedLinkParameter, &$configuration=array()) | |
detectLinkTypeFromLinkParameter ($linkParameter) | |
forceAbsoluteUrl ($url, array $configuration) | |
isClassAvailable ($className, array $config=null) | |
sanitizeSelectPart ($selectPart, $table) | |
getResourceFactory () | |
getEnvironmentVariable ($key) | |
calculateCacheLifetime (array $configuration) | |
calculateCacheTags (array $configuration) | |
calculateCacheKey (array $configuration) | |
getFrontendBackendUser () | |
getDatabaseConnection () | |
getTimeTracker () | |
getTypoScriptFrontendController () | |
Protected Attributes | |
$contentObjectClassMap = array() | |
$table = '' | |
$cObjHookObjectsRegistry = array() | |
$stdWrapHookObjects = array() | |
$getImgResourceHookObjects | |
$currentFile = null | |
$userObjectType = false | |
$stopRendering = array() | |
$stdWrapRecursionLevel = 0 | |
$typoScriptFrontendController | |
$templateService | |
This class contains all main TypoScript features. This includes the rendering of TypoScript content objects (cObjects). Is the backbone of TypoScript Template rendering.
There are lots of functions you can use from your include-scripts. The class is normally instantiated and referred to as "cObj". When you call your own PHP-code typically through a USER or USER_INT cObject then it is this class that instantiates the object and calls the main method. Before it does so it will set (if you are using classes) a reference to itself in the internal variable "cObj" of the object. Thus you can access all functions and data from this class by $this->cObj->... from within you classes written to be USER or USER_INT content objects.
Definition at line 63 of file ContentObjectRenderer.php.
__construct | ( | TypoScriptFrontendController | $typoScriptFrontendController = null | ) |
TypoScriptFrontendController | $typoScriptFrontendController |
Definition at line 584 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$typoScriptFrontendController, and GeneralUtility\makeInstance().
__sleep | ( | ) |
Prevent several objects from being serialized. If currentFile is set, it is either a File or a FileReference object. As the object itself can't be serialized, we have store a hash and restore the object in __wakeup()
Definition at line 598 of file ContentObjectRenderer.php.
References elseif.
__wakeup | ( | ) |
Restore currentFile from hash. If currentFile references a File, the identifier equals file identifier. If it references a FileReference the identifier equals the uid of the reference.
Definition at line 617 of file ContentObjectRenderer.php.
References $GLOBALS, elseif, and ResourceFactory\getInstance().
_parseFunc | ( | $theValue, | |
$conf | |||
) |
Helper function for parseFunc()
string | $theValue | The value to process. |
array | $conf | TypoScript configuration for parseFunc |
Definition at line 5208 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey, ContentObjectRenderer\$data, StringUtility\beginsWith(), ContentObjectRenderer\callUserFunction(), ContentObjectRenderer\checkIf(), StringUtility\endsWith(), GeneralUtility\get_tag_attributes(), ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\http_makelinks(), GeneralUtility\inList(), ContentObjectRenderer\mailto_makelinks(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\parseFunc().
addParams | ( | $content, | |
$conf | |||
) |
Implements the TypoScript function "addParams"
string | $content | The string with the HTML tag. |
array | $conf | The TypoScript configuration properties |
Definition at line 4635 of file ContentObjectRenderer.php.
References GeneralUtility\get_tag_attributes(), GeneralUtility\implodeAttributes(), and ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\stdWrap_addParams().
calc | ( | $val | ) |
Performs basic mathematical evaluation of the input string. Does NOT take parathesis and operator precedence into account! (for that, see ::calculateWithPriorityToAdditionAndSubtraction())
string | $val | The string to evaluate. Example: "3+4*10/5" will generate "35". Only integer numbers can be used. |
Definition at line 4835 of file ContentObjectRenderer.php.
References GeneralUtility\splitCalc().
Referenced by ContentObjectRenderer\calcIntExplode(), ContentObjectRenderer\checkIf(), and ContentObjectRenderer\listNum().
calcAge | ( | $seconds, | |
$labels | |||
) |
Returns the 'age' of the tstamp $seconds
int | $seconds | Seconds to return age for. Example: "70" => "1 min", "3601" => "1 hrs |
string | $labels | The labels of the individual units. Defaults to : ' min| hrs| days| yrs' |
Definition at line 7355 of file ContentObjectRenderer.php.
References MathUtility\canBeInterpretedAsInteger(), elseif, and ContentObjectRenderer\round().
Referenced by ContentObjectRenderer\stdWrap_age().
calcIntExplode | ( | $delim, | |
$string | |||
) |
This explodes a comma-list into an array where the values are parsed through ContentObjectRender::calc() and cast to (int)(so you are sure to have integers in the output array) Used to split and calculate min and max values for GMENUs.
string | $delim | Delimited to explode by |
string | $string | The string with parts in (where each part is evaluated by ->calc()) |
Definition at line 4874 of file ContentObjectRenderer.php.
References ContentObjectRenderer\calc().
|
protected |
Applies stdWrap to the cache key
array | $configuration |
Definition at line 8844 of file ContentObjectRenderer.php.
|
protected |
Calculates the lifetime of a cache entry based on the given configuration
array | $configuration |
Definition at line 8805 of file ContentObjectRenderer.php.
References elseif.
|
protected |
Calculates the tags for a cache entry bases on the given configuration
array | $configuration |
Definition at line 8829 of file ContentObjectRenderer.php.
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).
string | $funcName | 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 | $conf | The TypoScript configuration to pass the function |
string | $content | The content string to pass the function |
Definition at line 7214 of file ContentObjectRenderer.php.
References elseif, ContentObjectRenderer\getTimeTracker(), ContentObjectRenderer\isClassAvailable(), and GeneralUtility\makeInstance().
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\stdWrap_postUserFunc(), and ContentObjectRenderer\stdWrap_preUserFunc().
CASEFUNC | ( | $conf | ) |
Rendering the cObject, CASE
array | $conf | Array of TypoScript properties |
Definition at line 1322 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
caseshift | ( | $theValue, | |
$case | |||
) |
Changing character case of a string, converting typically used western charset characters as well.
string | $theValue | The string to change case for. |
string | $case | The direction; either "upper" or "lower |
Definition at line 7290 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\underscoredToLowerCamelCase(), and GeneralUtility\underscoredToUpperCamelCase().
Referenced by ContentObjectRenderer\HTMLcaseshift().
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
array | $conf | TypoScript properties defining what to compare |
Definition at line 3991 of file ContentObjectRenderer.php.
References ContentObjectRenderer\calc(), GeneralUtility\inList(), and ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\getImageSourceCollection(), SplitProcessor\process(), CommaSeparatedValueProcessor\process(), GalleryProcessor\process(), and ContentObjectRenderer\stdWrap_if().
checkPid | ( | $uid | ) |
Checks if a page UID is available due to enableFields() AND the list of bad doktype numbers ($this->checkPid_badDoktypeList)
int | $uid | Page UID to test |
Definition at line 8593 of file ContentObjectRenderer.php.
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)
array | $listArr | Array of Page UID numbers for select and for which pages with enablefields and bad doktypes should be removed. |
Definition at line 8566 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getSlidePids().
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().
string | $file | File TypoScript resource |
array | $conf | TypoScript configuration properties |
Definition at line 1562 of file ContentObjectRenderer.php.
References elseif, ContentObjectRenderer\getAltParam(), ContentObjectRenderer\getBorderAttr(), ContentObjectRenderer\getImageSourceCollection(), ContentObjectRenderer\getImageTagTemplate(), ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\imageLinkWrap(), ContentObjectRenderer\linkWrap(), GeneralUtility\rawUrlEncodeFP(), ContentObjectRenderer\stdWrap(), ContentObjectRenderer\stdWrapValue(), ContentObjectRenderer\substituteMarkerArray(), and ContentObjectRenderer\wrap().
clean_directory | ( | $theDir | ) |
Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.
string | $theDir | Absolute path to directory |
Definition at line 4158 of file ContentObjectRenderer.php.
References GeneralUtility\isAbsPath(), and GeneralUtility\validPathStr().
Referenced by ContentObjectRenderer\filelist().
cleanFormName | ( | $name | ) |
Removes forbidden characters and spaces from name/id attributes in the form tag and formfields
string | $name | Input string |
Definition at line 1977 of file ContentObjectRenderer.php.
CLEARGIF | ( | $conf | ) |
Rendering the cObject, CLEARGIF
array | $conf | Array of TypoScript properties |
Definition at line 1077 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
clearTSProperties | ( | $TSArr, | |
$propList | |||
) |
Clears TypoScript properties listed in $propList from the input TypoScript array.
array | $TSArr | TypoScript array of values/properties |
string | $propList | List of properties to clear both value/properties for. Eg. "myprop,another_property |
Definition at line 7468 of file ContentObjectRenderer.php.
References $list.
Referenced by ContentObjectRenderer\gifBuilderTextBox().
COBJ_ARRAY | ( | $conf, | |
$ext = '' |
|||
) |
Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT
array | $conf | Array of TypoScript properties |
string | $ext | If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached) |
Definition at line 1091 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
cObjGet | ( | $setup, | |
$addKey = '' |
|||
) |
Rendering of a "numerical array" of cObjects from TypoScript Will call ->cObjGetSingle() for each cObject found and accumulate the output.
array | $setup | array with cObjects as values. |
string | $addKey | A prefix for the debugging information |
Definition at line 795 of file ContentObjectRenderer.php.
References TemplateService\sortedKeyList().
Referenced by ContentObjectRenderer\splitObj().
COLUMNS | ( | $conf | ) |
Rendering the cObject, COLUMNS
array | $conf | Array of TypoScript properties |
Definition at line 1296 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
CONTENT | ( | $conf | ) |
Rendering the cObject, CONTENT
array | $conf | Array of TypoScript properties |
Definition at line 1231 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
convertToUserIntObject | ( | ) |
Requests the current USER object to be converted to USER_INT.
Definition at line 1148 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTimeTracker().
|
protected |
Creates the content object exception handler from local content object configuration or, from global configuration if not explicitly disabled in local configuration
array | $configuration |
ContentRenderingException |
Definition at line 981 of file ContentObjectRenderer.php.
References ContentObjectRenderer\determineExceptionHandlerClassName(), GeneralUtility\makeInstance(), and ContentObjectRenderer\mergeExceptionHandlerConfiguration().
crop | ( | $content, | |
$options | |||
) |
Implements the stdWrap property "crop" which is a modified "substr" function allowing to limit a string length 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.
string | $content | The string to perform the operation on |
string | $options | 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. |
Definition at line 4285 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
Referenced by ContentObjectRenderer\stdWrap_crop().
cropHTML | ( | $content, | |
$options | |||
) |
Implements the stdWrap property "cropHTML" which is a modified "substr" function allowing to limit a string length 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.
Compared to stdWrap.crop it respects HTML tags and entities.
string | $content | The string to perform the operation on |
string | $options | 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. |
Definition at line 4326 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
Referenced by ContentObjectRenderer\stdWrap_cropHTML().
CTABLE | ( | $conf | ) |
Rendering the cObject, CTABLE
array | $conf | Array of TypoScript properties |
Definition at line 1270 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
currentPageUrl | ( | $urlParameters = array() , |
|
$id = 0 |
|||
) |
Returns the current page URL
array | string | $urlParameters | As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already. |
int | $id | An alternative ID to the current id ($GLOBALS['TSFE']->id) |
Definition at line 6931 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoLink_URL(), and ContentObjectRenderer\getTypoScriptFrontendController().
dataWrap | ( | $content, | |
$wrap | |||
) |
Wrapping input value in a regular "wrap" but parses the wrapping value first for "insertData" codes.
string | $content | Input string being wrapped |
string | $wrap | The wrap string, eg. "<strong></strong>" or more likely here '| ' which will wrap the input string in a tag linking to the current page. |
Definition at line 4196 of file ContentObjectRenderer.php.
References ContentObjectRenderer\insertData(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\stdWrap_dataWrap().
DBgetDelete | ( | $table, | |
$uid, | |||
$doExec = false |
|||
) |
Returns an UPDATE/DELETE sql query which will "delete" the record. If the $GLOBALS['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.
string | $table | The table name, should be in $GLOBALS['TCA'] |
int | $uid | The UID of the record from $table which we are going to delete |
bool | $doExec | If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!! |
Definition at line 7648 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$table, elseif, and ContentObjectRenderer\getDatabaseConnection().
DBgetInsert | ( | $table, | |
$pid, | |||
$dataArr, | |||
$fieldList, | |||
$doExec = false |
|||
) |
Returns an INSERT sql query which automatically added "system-fields" according to $GLOBALS['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 $GLOBALS['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.
string | $table | The table name, should be in $GLOBALS['TCA'] |
int | $pid | The PID value for the record to insert |
array | $dataArr | The data array where key/value pairs are fieldnames/values for the record to insert |
string | $fieldList | Comma list of fieldnames which are allowed to be inserted. Only values from the data record for fields in this list will be inserted!! |
bool | $doExec | If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!! |
Definition at line 7727 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$table, ContentObjectRenderer\getDatabaseConnection(), ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\inList(), and GeneralUtility\trimExplode().
DBgetUpdate | ( | $table, | |
$uid, | |||
$dataArr, | |||
$fieldList, | |||
$doExec = false |
|||
) |
Returns an UPDATE sql query. If a "tstamp" field is configured for the $table tablename in $GLOBALS['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.
string | $table | The table name, should be in $GLOBALS['TCA'] |
int | $uid | The UID of the record from $table which we are going to update |
array | $dataArr | The data array where key/value pairs are fieldnames/values for the record to update. |
string | $fieldList | Comma list of fieldnames which are allowed to be updated. Only values from the data record for fields in this list will be updated!! |
bool | $doExec | If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!! |
Definition at line 7687 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$table, ContentObjectRenderer\getDatabaseConnection(), GeneralUtility\inList(), and GeneralUtility\trimExplode().
DBmayFEUserEdit | ( | $table, | |
$row, | |||
$feUserRow, | |||
$allowedGroups = '' , |
|||
$feEditSelf = 0 |
|||
) |
Checks if a frontend user is allowed to edit a certain record
string | $table | The table name, found in $GLOBALS['TCA'] |
array | $row | The record data array for the record in question |
array | $feUserRow | The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user |
string | $allowedGroups | 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. |
bool | int | $feEditSelf | TRUE, if the fe_user may edit his own fe_user record. |
Definition at line 7787 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$table, GeneralUtility\inList(), and GeneralUtility\trimExplode().
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.
string | $table | The table name |
array | $feUserRow | The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user |
string | $allowedGroups | 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. |
bool | int | $feEditSelf | TRUE, if the fe_user may edit his own fe_user record. |
Definition at line 7829 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$table, GeneralUtility\intExplode(), and GeneralUtility\trimExplode().
|
protected |
part of the typolink construction functionality, called by typoLink()
tries to get the type of the link from the link parameter could be
string | $linkParameter | could be "fileadmin/myfile.jpg" or "info@typo3.org" or "13" or "http://www.typo3.org" |
Definition at line 6299 of file ContentObjectRenderer.php.
References MathUtility\canBeInterpretedAsInteger(), elseif, ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\inList().
|
protected |
Determine exception handler class name from global and content object configuration
array | $configuration |
Definition at line 1001 of file ContentObjectRenderer.php.
References GeneralUtility\getApplicationContext(), and ContentObjectRenderer\getTypoScriptFrontendController().
Referenced by ContentObjectRenderer\createExceptionHandler().
editIcons | ( | $content, | |
$params, | |||
array | $conf = array() , |
||
$currentRecord = '' , |
|||
$dataArr = array() , |
|||
$addUrlParamStr = '' |
|||
) |
Adds an edit icon to the content string. The edit icon links to FormEngine 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).
string | $content | The content to which the edit icons should be appended |
string | $params | 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 FormEngine |
array | $conf | TypoScript properties for configuring the edit icons. |
string | $currentRecord | 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 | $dataArr | Alternative data array to use. Default is $this->data |
string | $addUrlParamStr | Additional URL parameters for the link pointing to FormEngine |
Definition at line 8722 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap_editIcons().
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"
string | $content | 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. |
array | $conf | TypoScript configuration properties for the editPanel |
string | $currentRecord | 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 | $dataArr | Alternative data array to use. Default is $this->data |
Definition at line 8695 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap_editPanel().
enableFields | ( | $table, | |
$show_hidden = false , |
|||
array | $ignore_array = array() |
||
) |
Returns a part of a WHERE clause which will filter out records with start/end times or hidden/fe_groups fields set to values that should de-select them according to the current time, preview settings or user login. Definitely a frontend function. THIS IS A VERY IMPORTANT FUNCTION: Basically you must add the output from this function for EVERY select query you create for selecting records of tables in your own applications - thus they will always be filtered according to the "enablefields" configured in TCA Simply calls ::enableFields() BUT will send the show_hidden flag along! This means this function will work in conjunction with the preview facilities of the frontend engine/Admin Panel.
string | $table | The table for which to get the where clause |
bool | $show_hidden | If set, then you want NOT to filter out hidden records. Otherwise hidden record are filtered based on the current preview settings. |
array | $ignore_array | Array you can pass where keys can be "disabled", "starttime", "endtime", "fe_group" (keys from "enablefields" in TCA) and if set they will make sure that part of the clause is not added. Thus disables the specific part of the clause. For previewing etc. |
Definition at line 7876 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$table, and ContentObjectRenderer\getTypoScriptFrontendController().
encaps_lineSplit | ( | $theValue, | |
$conf | |||
) |
Lets you split the content by LF and proces each line independently. Used to format content made with the RTE.
string | $theValue | The input value |
array | $conf | TypoScript options |
Definition at line 5436 of file ContentObjectRenderer.php.
References elseif, GeneralUtility\get_tag_attributes(), GeneralUtility\implodeAttributes(), GeneralUtility\revExplode(), ContentObjectRenderer\stdWrap(), GeneralUtility\trimExplode(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\stdWrap_encapsLines().
exec_getQuery | ( | $table, | |
$conf | |||
) |
Executes a SELECT query for records from $table and with conditions based on the configuration in the $conf array This function is preferred over ->getQuery() if you just need to create and then execute a query.
string | $table | The table name |
array | $conf | The TypoScript configuration properties |
Definition at line 8170 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\numRows().
exec_mm_query | ( | $select, | |
$local_table, | |||
$mm_table, | |||
$foreign_table, | |||
$whereClause = '' , |
|||
$groupBy = '' , |
|||
$orderBy = '' , |
|||
$limit = '' |
|||
) |
Executes a SELECT query for joining three tables according to the MM-relation standards used for tables configured in $GLOBALS['TCA']. That means MM-joins where the join table has the fields "uid_local" and "uid_foreign"
string | $select | List of fields to select |
string | $local_table | The local table |
string | $mm_table | The join-table; The "uid_local" field of this table will be matched with $local_table's "uid" field. |
string | $foreign_table | Optionally: The foreign table; The "uid" field of this table will be matched with $mm_table's "uid_foreign" field. If you set this field to blank the join will be over only the $local_table and $mm_table |
string | $whereClause | Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT! |
string | $groupBy | Optional GROUP BY field(s), if none, supply blank string. |
string | $orderBy | Optional ORDER BY field(s), if none, supply blank string. |
string | $limit | Optional LIMIT value ([begin,]max), if none, supply blank string. |
Definition at line 8088 of file ContentObjectRenderer.php.
exec_mm_query_uidList | ( | $select, | |
$local_table_uidlist, | |||
$mm_table, | |||
$foreign_table = '' , |
|||
$whereClause = '' , |
|||
$groupBy = '' , |
|||
$orderBy = '' , |
|||
$limit = '' |
|||
) |
Executes a SELECT query for joining two tables according to the MM-relation standards used for tables configured in $GLOBALS['TCA']. That means MM-joins where the join table has the fields "uid_local" and "uid_foreign" The two tables joined is the join table ($mm_table) and the foreign table ($foreign_table) - so the "local table" is not included but instead you can supply a list of UID integers from the local table to match in the join-table.
string | $select | List of fields to select |
string | $local_table_uidlist | List of UID integers, eg. "1,2,3,456 @param string $mm_table The join-table; The "uid_local" field of this table will be matched with the list of UID numbers from $local_table_uidlist @param string $foreign_table Optionally: The foreign table; The "uid" field of this table will be matched with $mm_table's "uid_foreign" field. If you set this field to blank only records from the $mm_table is returned. No join performed. |
string | $whereClause | Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT! |
string | $groupBy | Optional GROUP BY field(s), if none, supply blank string. |
string | $orderBy | Optional ORDER BY field(s), if none, supply blank string. |
string | $limit | Optional LIMIT value ([begin,]max), if none, supply blank string. |
Definition at line 8115 of file ContentObjectRenderer.php.
extLinkATagParams | ( | $URL, | |
$TYPE | |||
) |
All extension links should ask this function for additional properties to their tags. Designed to add for instance an "onclick" property for site tracking systems.
string | $URL | URL of the website |
string | $TYPE |
Definition at line 2034 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\http_makelinks().
FILE | ( | $conf | ) |
Rendering the cObject, FILE
array | $conf | Array of TypoScript properties |
Definition at line 1164 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
filelist | ( | $data | ) |
Reads a directory for files and returns the filepaths in a string list separated by comma. Implements the stdWrap property "filelist"
string | $data | The command which contains information about what files/directory listing to return. See the "filelist" property of stdWrap for details. |
Definition at line 4066 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$data, ContentObjectRenderer\clean_directory(), ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\inList(), GeneralUtility\isFirstPartOfStr(), GeneralUtility\split_fileref(), and GeneralUtility\uniqueList().
Referenced by ContentObjectRenderer\stdWrap_filelist().
fileResource | ( | $fName, | |
$addParams = 'alt="" title=""' |
|||
) |
Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.
string | $fName | The filename, being a TypoScript resource data type |
string | $addParams | Additional parameters (attributes). Default is empty alt and title tags. |
Definition at line 1877 of file ContentObjectRenderer.php.
FILES | ( | $conf | ) |
Rendering the cObject, FILES
array | $conf | Array of TypoScript properties |
Definition at line 1177 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
fillInMarkerArray | ( | array | $markContentArray, |
array | $row, | ||
$fieldList = '' , |
|||
$nl2br = true , |
|||
$prefix = 'FIELD_' , |
|||
$HSC = false |
|||
) |
Adds elements to the input $markContentArray based on the values from the fields from $fieldList found in $row
array | $markContentArray | Array with key/values being marker-strings/substitution values. |
array | $row | An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray |
string | $fieldList | A list of fields from the $row array to add to the $markContentArray array. If empty all fields from $row will be added (unless they are integers) |
bool | $nl2br | If set, all values added to $markContentArray will be nl2br()'ed |
string | $prefix | Prefix string to the fieldname before it is added as a key in the $markContentArray. Notice that the keys added to the $markContentArray always start and end with "### |
bool | $HSC | If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance. |
Definition at line 2311 of file ContentObjectRenderer.php.
References MathUtility\canBeInterpretedAsInteger(), ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\trimExplode().
FLOWPLAYER | ( | $conf | ) |
Rendering the cObject, FLOWPLAYER
array | $conf | Array of TypoScript properties |
Definition at line 1051 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
|
protected |
Rendering the cObject, FLUIDTEMPLATE
array | $conf | Array of TypoScript properties |
Definition at line 1397 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
|
protected |
Forces a given URL to be absolute.
string | $url | The URL to be forced to be absolute |
array | $configuration | TypoScript configuration of typolink |
Definition at line 6788 of file ContentObjectRenderer.php.
References $url, ContentObjectRenderer\getEnvironmentVariable(), and ContentObjectRenderer\getTypoScriptFrontendController().
FORM | ( | $conf, | |
$formData = '' |
|||
) |
Rendering the cObject, FORM
array | $conf | Array of TypoScript properties |
array | string | $formData | Alternative formdata overriding whatever comes from TypoScript |
ContentRenderingException | |
\Exception |
Definition at line 1357 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
getAltParam | ( | $conf, | |
$longDesc = true |
|||
) |
An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element. From the $conf array it implements the properties "altText", "titleText" and "longdescURL"
array | $conf | TypoScript configuration properties |
bool | $longDesc | If set, the longdesc attribute will be generated - must only be used for img elements! |
Definition at line 1941 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\cImage().
getATagParams | ( | $conf, | |
$addGlobal = 1 |
|||
) |
An abstraction method to add parameters to an A tag. Uses the ATagParams property.
array | $conf | TypoScript configuration properties |
bool | int | $addGlobal | If set, will add the global config.ATagParams to the link |
Definition at line 1995 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\http_makelinks(), and ContentObjectRenderer\mailto_makelinks().
getBorderAttr | ( | $borderAttr | ) |
Returns the 'border' attribute for an tag only if the doctype is not xhtml_strict, xhtml_11, xhtml_2 or html5 or if the config parameter 'disableImgBorderAttr' is not set.
string | $borderAttr | The border attribute |
Definition at line 1622 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\inList().
Referenced by ContentObjectRenderer\cImage().
getClosestMPvalueForPage | ( | $pageId, | |
$raw = false |
|||
) |
Returns the &MP variable value for a page id. The function will do its best to find a MP value that will keep the page id inside the current Mount Point rootline if any.
int | $pageId | page id |
bool | $raw | If TRUE, the MPvalue is returned raw. Normally it is encoded as &MP=... variable |
Definition at line 6989 of file ContentObjectRenderer.php.
References $GLOBALS, and ContentObjectRenderer\getTypoScriptFrontendController().
getContentObject | ( | $name | ) |
Returns a new content object of type $name. This content object needs to be registered as content object in $this->contentObjectClassMap
string | $name |
ContentRenderingException |
Definition at line 898 of file ContentObjectRenderer.php.
References GeneralUtility\makeInstance().
Referenced by ContentObjectRenderer\CASEFUNC(), ContentObjectRenderer\CLEARGIF(), ContentObjectRenderer\COBJ_ARRAY(), ContentObjectRenderer\COLUMNS(), ContentObjectRenderer\CONTENT(), ContentObjectRenderer\CTABLE(), ContentObjectRenderer\FILE(), ContentObjectRenderer\FILES(), ContentObjectRenderer\FLOWPLAYER(), ContentObjectRenderer\FLUIDTEMPLATE(), ContentObjectRenderer\FORM(), ContentObjectRenderer\HMENU(), ContentObjectRenderer\HRULER(), ContentObjectRenderer\IMAGE(), ContentObjectRenderer\IMG_RESOURCE(), ContentObjectRenderer\IMGTEXT(), ContentObjectRenderer\LOAD_REGISTER(), ContentObjectRenderer\MEDIA(), ContentObjectRenderer\MULTIMEDIA(), ContentObjectRenderer\OTABLE(), ContentObjectRenderer\QTOBJECT(), ContentObjectRenderer\RECORDS(), ContentObjectRenderer\SEARCHRESULT(), ContentObjectRenderer\SVG(), ContentObjectRenderer\SWFOBJECT(), ContentObjectRenderer\TEMPLATE(), ContentObjectRenderer\TEXT(), and ContentObjectRenderer\USER().
getCurrentFile | ( | ) |
Gets the current file object during iterations over files.
Definition at line 2349 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentFile.
getCurrentTable | ( | ) |
Returns the current table
Definition at line 711 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$table.
getCurrentVal | ( | ) |
Returns the "current" value. The "current" value is just an internal variable that can be used by functions to pass a single value on to another function later in the TypoScript processing. It's like "load accumulator" in the good old C64 days... basically a "register" you can use as you like. The TSref will tell if functions are setting this value before calling some other object so that you know if it holds any special information.
Definition at line 769 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey.
getData | ( | $string, | |
$fieldArray = null |
|||
) |
Implements the TypoScript data type "getText". This takes a string with parameters and based on those a value from somewhere in the system is returned.
string | $string | The parameter string, eg. "field : title" or "field : navtitle // field : title" (in the latter case and example of how the value is FIRST splitted by "//" is shown) |
NULL | array | $fieldArray | Alternative field array; If you set this to an array this variable will be used to look up values for the "field" key. Otherwise the current page record in $GLOBALS['TSFE']->page is used. |
Definition at line 5853 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey, $GLOBALS, ContentObjectRenderer\$parentRecordNumber, GeneralUtility\_GET(), GeneralUtility\_POST(), elseif, ContentObjectRenderer\getEnvironmentVariable(), ContentObjectRenderer\getGlobal(), ContentObjectRenderer\getKey(), ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\getUserObj(), ArrayUtility\mergeRecursiveWithOverrule(), ContentObjectRenderer\rootLineValue(), GeneralUtility\trimExplode(), and DebugUtility\viewArray().
Referenced by ContentObjectRenderer\insertData(), and ContentObjectRenderer\stdWrap_data().
|
protected |
Returns the database connection
Definition at line 8867 of file ContentObjectRenderer.php.
References $GLOBALS.
Referenced by ContentObjectRenderer\DBgetDelete(), ContentObjectRenderer\DBgetInsert(), ContentObjectRenderer\DBgetUpdate(), and ContentObjectRenderer\numRows().
|
protected |
Wrapper function for GeneralUtility::getIndpEnv()
string | $key | Name of the "environment variable"/"server variable" you wish to get. |
Definition at line 8773 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\forceAbsoluteUrl(), ContentObjectRenderer\getData(), and ContentObjectRenderer\getQueryArguments().
getFieldVal | ( | $field | ) |
Returns the value for the field from $this->data. If "//" is found in the $field value that token will split the field values apart and the first field having a non-blank value will be returned.
string | $field | The fieldname, eg. "title" or "navtitle // title" (in the latter case the value of $this->data[navtitle] is returned if not blank, otherwise $this->data[title] will be) |
Definition at line 5830 of file ContentObjectRenderer.php.
References GeneralUtility\trimExplode().
Referenced by ContentObjectRenderer\stdWrap_field().
|
protected |
Returns the current BE user.
Definition at line 8857 of file ContentObjectRenderer.php.
References $GLOBALS.
|
protected |
Gets the 'getImgResource' hook objects. The first call initializes the accordant objects.
Definition at line 722 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$getImgResourceHookObjects, $GLOBALS, and GeneralUtility\getUserObj().
getGlobal | ( | $keyString, | |
$source = null |
|||
) |
Return global variable where the input string $var defines array keys separated by "|" Example: $var = "HTTP_SERVER_VARS | something" will return the value $GLOBALS['HTTP_SERVER_VARS']['something'] value
string | $keyString | Global var key, eg. "HTTP_GET_VAR" or "HTTP_GET_VARS|id" to get the GET parameter "id" back. |
array | $source | Alternative array than $GLOBAL to get variables from. |
Definition at line 6134 of file ContentObjectRenderer.php.
References $GLOBALS, and elseif.
Referenced by ContentObjectRenderer\getData().
getImageSourceCollection | ( | $layoutKey, | |
$conf, | |||
$file | |||
) |
Render alternate sources for the image tag. If no source collection is given an empty string is returned.
string | $layoutKey | rendering key |
array | $conf | TypoScript configuration properties |
string | $file |
\UnexpectedValueException |
Definition at line 1658 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\checkIf(), ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\getUserObj(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\substituteMarkerArray().
Referenced by ContentObjectRenderer\cImage().
getImageTagTemplate | ( | $layoutKey, | |
$conf | |||
) |
Returns the html-template for rendering the image-Tag if no template is defined via typoscript the default tag template is returned
string | $layoutKey | rendering key |
array | $conf | TypoScript configuration properties |
Definition at line 1639 of file ContentObjectRenderer.php.
References ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\cImage().
getKey | ( | $key, | |
$arr | |||
) |
Processing of key values pointing to entries in $arr; Here negative values are converted to positive keys pointer to an entry in the array but from behind (based on the negative value). Example: entrylevel = -1 means that entryLevel ends up pointing at the outermost-level, -2 means the level before the outermost...
int | $key | The integer to transform |
array | $arr | array in which the key should be found. |
Definition at line 6167 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getData().
getMailTo | ( | $mailAddress, | |
$linktxt | |||
) |
Creates a href attibute for given $mailAddress. The function uses spamProtectEmailAddresses for encoding the mailto statement. If spamProtectEmailAddresses is disabled, it'll just return a string like "mailto:user@example.tld".
string | $mailAddress | Email address |
string | $linktxt | Link text, default will be the email address. |
Definition at line 7046 of file ContentObjectRenderer.php.
References UrlProcessorInterface\CONTEXT_MAIL, ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\quoteJSvalue().
Referenced by ContentObjectRenderer\mailto_makelinks().
getQuery | ( | $table, | |
$conf, | |||
$returnQueryArray = false |
|||
) |
Creates and returns a SELECT query for records from $table and with conditions based on the configuration in the $conf array Implements the "select" function in TypoScript
string | $table | See ->exec_getQuery() |
array | $conf | See ->exec_getQuery() |
bool | $returnQueryArray | If set, the function will return the query not as a string but array with the various parts. RECOMMENDED! |
Definition at line 8236 of file ContentObjectRenderer.php.
References elseif.
getQueryArguments | ( | $conf, | |
$overruleQueryArguments = array() , |
|||
$forceOverruleArguments = false |
|||
) |
Gets the query arguments and assembles them for URLs. Arguments may be removed or set, depending on configuration.
string | $conf | Configuration |
array | $overruleQueryArguments | Multidimensional key/value pairs that overrule incoming query arguments |
bool | $forceOverruleArguments | If set, key/value pairs not in the query but the overrule array will be set |
Definition at line 7090 of file ContentObjectRenderer.php.
References GeneralUtility\_GET(), GeneralUtility\_POST(), ArrayUtility\arrayDiffAssocRecursive(), GeneralUtility\explodeUrl2Array(), ContentObjectRenderer\getEnvironmentVariable(), GeneralUtility\implodeArrayForUrl(), and ArrayUtility\mergeRecursiveWithOverrule().
getQueryMarkers | ( | $table, | |
$conf | |||
) |
Builds list of marker values for handling PDO-like parameter markers in select parts. Marker values support stdWrap functionality thus allowing a way to use stdWrap functionality in various properties of 'select' AND prevents SQL-injection problems by quoting and escaping of numeric values, strings, NULL values and comma separated lists.
string | $table | Table to select records from |
array | $conf | Select part of CONTENT definition |
Definition at line 8613 of file ContentObjectRenderer.php.
References elseif.
getRecords | ( | $tableName, | |
array | $queryConfiguration | ||
) |
Executes a SELECT query for records from $table and with conditions based on the configuration in the $conf array and overlays with translation and version if available
string | $tableName | the name of the TCA database table |
array | $queryConfiguration | The TypoScript configuration properties, see .select in TypoScript reference |
Definition at line 8184 of file ContentObjectRenderer.php.
|
protected |
Get instance of FAL resource factory
Definition at line 8761 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\resolveMixedLinkParameter().
getSlidePids | ( | $pidList, | |
$pidConf | |||
) |
Returns all parents of the given PID (Page UID) list
string | $pidList | A list of page Content-Element PIDs (Page UIDs) / stdWrap |
array | $pidConf | stdWrap array for the list |
Definition at line 1527 of file ContentObjectRenderer.php.
References ContentObjectRenderer\checkPidArray(), ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\intExplode(), and ContentObjectRenderer\stdWrap().
getSubpart | ( | $content, | |
$marker | |||
) |
Returns a subpart from the input content stream. A subpart is a part of the input stream which is encapsulated in a string matching the input string, $marker. If this string is found inside of HTML comment tags the start/end points of the content block returned will be that right outside that comment block. Example: The contennt string is "Hello <!–###sub1### begin–> World. How are <!–###sub1### end–> you?" If $marker is "###sub1###" then the content returned is " World. How are ". The input content string could just as well have been "Hello ###sub1### World. How are ###sub1### you?" and the result would be the same Wrapper for ::getSubpart which behaves identical
string | $content | The content stream, typically HTML template content. |
string | $marker | The marker string, typically on the form "###[the marker string]### |
Definition at line 2069 of file ContentObjectRenderer.php.
|
protected |
Definition at line 8875 of file ContentObjectRenderer.php.
References $GLOBALS.
Referenced by ContentObjectRenderer\callUserFunction(), ContentObjectRenderer\convertToUserIntObject(), and ContentObjectRenderer\numRows().
getTypoLink | ( | $label, | |
$params, | |||
$urlParameters = array() , |
|||
$target = '' |
|||
) |
Returns a linked string made from typoLink parameters.
This function takes $label as a string, wraps it in a link-tag based on the $params string, which should contain data like that you would normally pass to the popular <LINK>-tag in the TSFE. Optionally you can supply $urlParameters which is an array with key/value pairs that are rawurlencoded and appended to the resulting url.
string | $label | Text string being wrapped by the link. |
string | $params | Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file. |
array | string | $urlParameters | As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already. |
string | $target | Specific target set, if any. (Default is using the current) |
Definition at line 6851 of file ContentObjectRenderer.php.
References GeneralUtility\implodeArrayForUrl().
Referenced by ContentObjectRenderer\getTypoLink_URL().
getTypoLink_URL | ( | $params, | |
$urlParameters = array() , |
|||
$target = '' |
|||
) |
Returns the URL of a "typolink" create from the input parameter string, url-parameters and target
string | $params | Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file. |
array | string | $urlParameters | As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already. |
string | $target | Specific target set, if any. (Default is using the current) |
Definition at line 6904 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$lastTypoLinkUrl, and ContentObjectRenderer\getTypoLink().
Referenced by ContentObjectRenderer\currentPageUrl().
|
protected |
Definition at line 8883 of file ContentObjectRenderer.php.
References $GLOBALS.
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\caseshift(), ContentObjectRenderer\cImage(), ContentObjectRenderer\crop(), ContentObjectRenderer\cropHTML(), ContentObjectRenderer\currentPageUrl(), ContentObjectRenderer\DBgetInsert(), ContentObjectRenderer\detectLinkTypeFromLinkParameter(), ContentObjectRenderer\determineExceptionHandlerClassName(), ContentObjectRenderer\enableFields(), ContentObjectRenderer\filelist(), ContentObjectRenderer\fillInMarkerArray(), ContentObjectRenderer\forceAbsoluteUrl(), ContentObjectRenderer\getBorderAttr(), ContentObjectRenderer\getClosestMPvalueForPage(), ContentObjectRenderer\getData(), ContentObjectRenderer\getImageSourceCollection(), ContentObjectRenderer\getMailTo(), ContentObjectRenderer\getSlidePids(), ContentObjectRenderer\getUrlToCurrentLocation(), ContentObjectRenderer\http_makelinks(), ContentObjectRenderer\imageLinkWrap(), ContentObjectRenderer\includeLibs(), ContentObjectRenderer\isClassAvailable(), ContentObjectRenderer\mailto_makelinks(), ContentObjectRenderer\mergeExceptionHandlerConfiguration(), ContentObjectRenderer\mergeTSRef(), ContentObjectRenderer\replacementSingle(), ContentObjectRenderer\rootLineValue(), ContentObjectRenderer\splitObj(), ContentObjectRenderer\stdWrap_addPageCacheTags(), ContentObjectRenderer\stdWrap_br(), ContentObjectRenderer\stdWrap_csConv(), ContentObjectRenderer\stdWrap_editIcons(), ContentObjectRenderer\stdWrap_editPanel(), ContentObjectRenderer\stdWrap_lang(), ContentObjectRenderer\stdWrap_postUserFuncInt(), ContentObjectRenderer\stdWrap_prefixComment(), ContentObjectRenderer\stdWrap_strftime(), ContentObjectRenderer\substring(), ContentObjectRenderer\tableStyle(), ContentObjectRenderer\TCAlookup(), and ContentObjectRenderer\textStyle().
getUrlToCurrentLocation | ( | $addQueryString = true | ) |
Returns the canonical URL to the current "location", which include the current page ID and type and optionally the query string
bool | $addQueryString | Whether additional GET arguments in the query string should be included or not |
Definition at line 6878 of file ContentObjectRenderer.php.
References GeneralUtility\_GET(), GeneralUtility\explodeUrl2Array(), ContentObjectRenderer\getTypoScriptFrontendController(), and ContentObjectRenderer\typoLink_URL().
getUserObjectType | ( | ) |
Retrieves a type of object called as USER or USER_INT. Object can detect their type by using this call. It returns OBJECTTYPE_USER_INT or OBJECTTYPE_USER depending on the current object execution. In all other cases it will return FALSE to indicate a call out of context.
Definition at line 1127 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$userObjectType.
getWhere | ( | $table, | |
$conf, | |||
$returnQueryArray = false |
|||
) |
Helper function for getQuery(), creating the WHERE clause of the SELECT query
string | $table | The table name |
array | $conf | The TypoScript configuration properties |
bool | $returnQueryArray | If set, the function will return the query not as a string but array with the various parts. RECOMMENDED! |
Definition at line 8390 of file ContentObjectRenderer.php.
gifBuilderTextBox | ( | $gifbuilderConf, | |
$conf, | |||
$text | |||
) |
This function creates a number of TEXT-objects in a Gifbuilder configuration in order to create a text-field like thing.
array | $gifbuilderConf | TypoScript properties for Gifbuilder - TEXT GIFBUILDER objects are added to this array and returned. |
array | $conf | TypoScript properties for this function |
string | $text | The text string to write onto the GIFBUILDER file |
Definition at line 7511 of file ContentObjectRenderer.php.
References ContentObjectRenderer\clearTSProperties(), ContentObjectRenderer\linebreaks(), and ContentObjectRenderer\round().
HMENU | ( | $conf | ) |
Rendering the cObject, HMENU
array | $conf | Array of TypoScript properties |
Definition at line 1257 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
HRULER | ( | $conf | ) |
Rendering the cObject, HRULER
array | $conf | Array of TypoScript properties |
Definition at line 1309 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
HTMLcaseshift | ( | $theValue, | |
$case | |||
) |
Shifts the case of characters outside of HTML tags in the input string
string | $theValue | The string to change case for. |
string | $case | The direction; either "upper" or "lower |
Definition at line 7327 of file ContentObjectRenderer.php.
References ContentObjectRenderer\caseshift().
Referenced by ContentObjectRenderer\stdWrap_case(), and ContentObjectRenderer\textStyle().
HTMLparser_TSbridge | ( | $theValue, | |
$conf | |||
) |
Passes the input value, $theValue, to an instance of "\TYPO3\CMS\Core\Html\HtmlParser" together with the TypoScript options which are first converted from a TS style array to a set of arrays with options for the class.
string | $theValue | The value to parse by the class |
array | $conf | TypoScript properties for the parser. See link. |
Definition at line 4181 of file ContentObjectRenderer.php.
References GeneralUtility\makeInstance().
Referenced by ContentObjectRenderer\stdWrap_HTMLparser().
http_makelinks | ( | $data, | |
$conf | |||
) |
Finds URLS in text and makes it to a real link. Will find all strings prefixed with "http://" and "https://" in the $data string and make them into a link, linking to the URL we should have found.
string | $data | The string in which to search for "http:// |
array | $conf | Configuration for makeLinks, see link |
Definition at line 5541 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$data, UrlProcessorInterface\CONTEXT_COMMON, elseif, ContentObjectRenderer\extLinkATagParams(), ContentObjectRenderer\getATagParams(), ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\_parseFunc().
IMAGE | ( | $conf | ) |
Rendering the cObject, IMAGE
array | $conf | Array of TypoScript properties |
Definition at line 1191 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
imageLinkWrap | ( | $string, | |
$imageFile, | |||
$conf | |||
) |
Wraps the input string in link-tags that opens the image in a new window.
string | $string | String to wrap, probably an tag |
string | File | FileReference | $imageFile | The original image file |
array | $conf | TypoScript properties for the "imageLinkWrap" function |
Definition at line 1764 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$parameters, $url, MathUtility\canBeInterpretedAsInteger(), elseif, ResourceFactory\getInstance(), ContentObjectRenderer\getTypoScriptFrontendController(), GeneralUtility\hmac(), GeneralUtility\inList(), GeneralUtility\intExplode(), GeneralUtility\quoteJSvalue(), and ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\cImage().
IMG_RESOURCE | ( | $conf | ) |
Rendering the cObject, IMG_RESOURCE
array | $conf | Array of TypoScript properties |
Definition at line 1205 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
IMGTEXT | ( | $conf | ) |
Rendering the cObject, IMGTEXT
array | $conf | Array of TypoScript properties |
Definition at line 1218 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
includeLibs | ( | array | $config | ) |
Includes resources if the config property 'includeLibs' is set.
array | $config | TypoScript configuration |
Definition at line 7588 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\trimExplode().
Referenced by ContentObjectRenderer\isClassAvailable().
insertData | ( | $str | ) |
Implements the "insertData" property of stdWrap meaning that if strings matching {...} is found in the input string they will be substituted with the return value from getData (datatype) which is passed the content of the curly braces. Example: If input string is "This is the page title: {page:title}" then the part, '{page:title}', will be substituted with the current pages title field value.
string | $str | Input value |
Definition at line 4209 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getData().
Referenced by ContentObjectRenderer\dataWrap(), ContentObjectRenderer\prefixComment(), and ContentObjectRenderer\stdWrap_insertData().
|
protected |
Checks whether a PHP class is available. If the check fails, the method tries to determine the correct includeLibs to make the class available automatically.
TypoScript example that can cause this: | plugin.tx_myext_pi1 = USER | plugin.tx_myext_pi1 { | includeLibs = EXT:myext/pi1/class.tx_myext_pi1.php | userFunc = tx_myext_pi1->main | } | 10 = USER | 10.userFunc = tx_myext_pi1->renderHeader
string | $className | The name of the PHP class to be checked |
array | $config | TypoScript configuration (naturally of a USER or COA cObject) |
Definition at line 7618 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and ContentObjectRenderer\includeLibs().
Referenced by ContentObjectRenderer\callUserFunction().
isDisabled | ( | $table, | |
$row | |||
) |
Returns TRUE if the input table/row would be hidden in the frontend (according nto the current time and simulate user group)
string | $table | The table name |
array | $row | The data record |
Definition at line 8746 of file ContentObjectRenderer.php.
References $GLOBALS.
keywords | ( | $content | ) |
Cleans up a string of keywords. Keywords at splitted by "," (comma) ";" (semi colon) and linebreak
string | $content | String of keywords |
Definition at line 7273 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap_keywords().
lastChanged | ( | $tstamp | ) |
Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value. The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content. Therefore you should call this function with the last-changed timestamp of any element you display.
int | $tstamp | Unix timestamp (number of seconds since 1970) |
Definition at line 1903 of file ContentObjectRenderer.php.
linebreaks | ( | $string, | |
$chars, | |||
$maxLines = 0 |
|||
) |
Splits a text string into lines and returns an array with these lines but a max number of lines.
string | $string | The string to break |
int | $chars | Max number of characters per line. |
int | $maxLines | Max number of lines in all. |
Definition at line 7562 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\gifBuilderTextBox().
linkWrap | ( | $content, | |
$wrap | |||
) |
Wraps the input string by the $wrap value and implements the "linkWrap" data type as well. The "linkWrap" data type means that this function will find any integer encapsulated in {} (curly braces) in the first wrap part and substitute it with the corresponding page uid from the rootline where the found integer is pointing to the key in the rootline. See link below.
string | $content | Input string |
string | $wrap | A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string |
Definition at line 1921 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\cImage().
listNum | ( | $content, | |
$listNum, | |||
$char | |||
) |
Exploding a string by the $char value (if integer its an ASCII value) and returning index $listNum
string | $content | String to explode |
string | $listNum | Index-number. You can place the word "last" in it and it will be substituted with the pointer to the last value. You can use math operators like "+-/*" (passed to calc()) |
string | $char | Either a string used to explode the content string or an integer value which will then be changed into a character, eg. "10" for a linebreak char. |
Definition at line 3967 of file ContentObjectRenderer.php.
References ContentObjectRenderer\calc(), and MathUtility\canBeInterpretedAsInteger().
Referenced by ContentObjectRenderer\stdWrap_listNum(), and ContentObjectRenderer\stdWrap_preIfEmptyListNum().
LOAD_REGISTER | ( | $conf, | |
$name | |||
) |
Rendering the cObject, LOAD_REGISTER and RESTORE_REGISTER NOTICE: This cObject does NOT return any content since it just sets internal data based on the TypoScript properties.
array | $conf | Array of TypoScript properties |
string | $name | If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER" |
Definition at line 1337 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
mailto_makelinks | ( | $data, | |
$conf | |||
) |
Will find all strings prefixed with "mailto:" in the $data string and make them into a link, linking to the email address they point to.
string | $data | The string in which to search for "mailto: |
array | $conf | Configuration for makeLinks, see link |
Definition at line 5615 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$data, ContentObjectRenderer\getATagParams(), ContentObjectRenderer\getMailTo(), ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\_parseFunc().
MEDIA | ( | $conf | ) |
Rendering the cObject, MEDIA
array | $conf | Array of TypoScript properties |
Definition at line 1423 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
|
protected |
Merges global exception handler configuration with the one from the content object and returns the merged exception handler configuration
array | $configuration |
Definition at line 1031 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
Referenced by ContentObjectRenderer\createExceptionHandler().
mergeTSRef | ( | $confArr, | |
$prop | |||
) |
Resolves a TypoScript reference value to the full set of properties BUT overridden with any local properties set. So the reference is resolved but overlaid with local TypoScript properties of the reference value.
array | $confArr | The TypoScript array |
string | $prop | The property name: If this value is a reference (eg. " < plugins.tx_something") then the reference will be retrieved and inserted at that position (into the properties only, not the value...) AND overlaid with the old properties if any. |
Definition at line 7487 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\makeInstance().
Referenced by ContentObjectRenderer\parseFunc().
MULTIMEDIA | ( | $conf | ) |
Rendering the cObject, MULTIMEDIA
array | $conf | Array of TypoScript properties |
Definition at line 1410 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
noTrimWrap | ( | $content, | |
$wrap, | |||
$char = '|' |
|||
) |
Wrapping a string, preserving whitespace in wrap value. Notice that the wrap value uses part 1/2 to wrap (and not 0/1 which wrap() does)
string | $content | The content to wrap, eg. "HELLO WORLD @param string $wrap The wrap value, eg. " | | |
string | $char | The char used to split the wrapping value, default is "|" |
Definition at line 7162 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap_noTrimWrap().
numberFormat | ( | $content, | |
$conf | |||
) |
Implements the stdWrap property "numberFormat" This is a Wrapper function for php's number_format()
float | $content | Value to process |
array | $conf | TypoScript Configuration for numberFormat |
Definition at line 5080 of file ContentObjectRenderer.php.
References ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\stdWrap_numberFormat().
numRows | ( | $conf | ) |
Returns number of rows selected by the query made by the properties set. Implements the stdWrap "numRows" property
array | $conf | TypoScript properties for the property (see link to "numRows") |
Definition at line 3943 of file ContentObjectRenderer.php.
References ContentObjectRenderer\exec_getQuery(), ContentObjectRenderer\getDatabaseConnection(), and ContentObjectRenderer\getTimeTracker().
Referenced by ContentObjectRenderer\stdWrap_numRows().
OTABLE | ( | $conf | ) |
Rendering the cObject, OTABLE
array | $conf | Array of TypoScript properties |
Definition at line 1283 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
parseFunc | ( | $theValue, | |
$conf, | |||
$ref = '' |
|||
) |
Implements the stdWrap property, "parseFunc". This is a function with a lot of interesting uses. In classic TypoScript this is used to process text from the bodytext field; This included highlighting of search words, changing http:// and mailto: prefixed strings into etc. It is still a very important function for processing of bodytext which is normally stored in the database in a format which is not fully ready to be outputted. This situation has not become better by having a RTE around...
This function is actually just splitting the input content according to the configuration of "external blocks". This means that before the input string is actually "parsed" it will be splitted into the parts configured to BE parsed (while other parts/blocks should NOT be parsed). Therefore the actual processing of the parseFunc properties goes on in ->_parseFunc()
string | $theValue | The value to process. |
array | $conf | TypoScript configuration for parseFunc |
string | $ref | Reference to get configuration from. Eg. "< lib.parseFunc" which means that the configuration of the object path "lib.parseFunc" will be retrieved and MERGED with what is in $conf! |
Definition at line 5107 of file ContentObjectRenderer.php.
References ContentObjectRenderer\_parseFunc(), elseif, GeneralUtility\makeInstance(), ContentObjectRenderer\mergeTSRef(), ContentObjectRenderer\stdWrap(), GeneralUtility\trimExplode(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\stdWrap_parseFunc().
prefixComment | ( | $str, | |
$conf, | |||
$content | |||
) |
Returns a HTML comment with the second part of input string (divided by "|") where first part is an integer telling how many trailing tabs to put before the comment on a new line. Notice; this function (used by stdWrap) can be disabled by a "config.disablePrefixComment" setting in TypoScript.
string | $str | Input value |
array | $conf | TypoScript Configuration (not used at this point.) |
string | $content | The content to wrap the comment around. |
Definition at line 4240 of file ContentObjectRenderer.php.
References ContentObjectRenderer\insertData().
Referenced by ContentObjectRenderer\stdWrap_prefixComment().
processParams | ( | $params | ) |
Parses a set of text lines with "[parameters] = [values]" into an array with parameters as keys containing the value If lines are empty or begins with "/" or "#" then they are ignored.
string | $params | Text which the parameters |
Definition at line 7253 of file ContentObjectRenderer.php.
References GeneralUtility\inList(), and GeneralUtility\trimExplode().
QTOBJECT | ( | $conf | ) |
Rendering the cObject, QTOBJECT
array | $conf | Array of TypoScript properties |
Definition at line 1449 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
readFlexformIntoConf | ( | $flexData, | |
& | $conf, | ||
$recursive = false |
|||
) |
Converts a given config in Flexform to a conf-array
string | array | $flexData | Flexform data |
array | $conf | Array to write the data into, by reference |
bool | $recursive | Is set if called recursive. Don't call function with this parameter, it's used inside the function only |
Definition at line 1481 of file ContentObjectRenderer.php.
References GeneralUtility\xml2array().
RECORDS | ( | $conf | ) |
Rendering the cObject, RECORDS
array | $conf | Array of TypoScript properties |
Definition at line 1244 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
registerContentObjectClass | ( | $className, | |
$contentObjectName | |||
) |
Register a single content object name to class name
This method is private API, please use configuration $GLOBALS['TYPO3_CONF_VARS']['FE']['ContentObjects'] to add new content objects
Definition at line 660 of file ContentObjectRenderer.php.
removeBadHTML | ( | $text | ) |
Function for removing malicious HTML code when you want to provide some HTML code user-editable. The purpose is to avoid XSS attacks and the code will be continously modified to remove such code. For a complete reference with javascript-on-events, see http://www.wdvl.com/Authoring/JavaScript/Events/events_target.html
string | $text | Input string to be cleaned. |
Definition at line 4468 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap_removeBadHTML().
|
protected |
Processes ordered replacements on content data.
string | $content | The content to be processed |
array | $configuration | The TypoScript configuration for stdWrap.replacement |
Definition at line 4961 of file ContentObjectRenderer.php.
References MathUtility\canBeInterpretedAsInteger(), and ContentObjectRenderer\replacementSingle().
Referenced by ContentObjectRenderer\stdWrap_replacement().
|
protected |
Processes a single search/replace on content data.
string | $content | The content to be processed |
array | $configuration | The TypoScript of the search/replace action to be processed |
Definition at line 4981 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\replacement().
|
protected |
called from the typoLink() function
does the magic to split the full "typolink" string like "15,13 _blank myclass &more=1" into separate parts
string | $linkText | The string (text) to link |
string | $mixedLinkParameter | destination data like "15,13 _blank myclass &more=1" used to create the link |
array | $configuration | TypoScript configuration |
Definition at line 6233 of file ContentObjectRenderer.php.
References $GLOBALS, StringUtility\beginsWith(), ContentObjectRenderer\getResourceFactory(), GeneralUtility\getUserObj(), and GeneralUtility\makeInstance().
rootLineValue | ( | $key, | |
$field, | |||
$slideBack = 0 , |
|||
$altRootLine = '' |
|||
) |
Returns a value from the current rootline (site) from $GLOBALS['TSFE']->tmpl->rootLine;
string | $key | Which level in the root line |
string | $field | The field in the rootline record to return (a field from the pages table) |
bool | int | $slideBack | If set, then we will traverse through the rootline from outer level towards the root level until the value found is TRUE |
mixed | $altRootLine | If you supply an array for this it will be used as an alternative root line array |
Definition at line 6109 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
Referenced by ContentObjectRenderer\getData().
|
protected |
Implements the "round" property of stdWrap This is a Wrapper function for PHP's rounding functions (round,ceil,floor), defaults to round()
string | $content | Value to process |
array | $conf | TypoScript configuration for round |
Definition at line 5052 of file ContentObjectRenderer.php.
References ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\calcAge(), ContentObjectRenderer\gifBuilderTextBox(), and ContentObjectRenderer\stdWrap_round().
|
protected |
Helper function for getQuery, sanitizing the select part
This functions checks if the necessary fields are part of the select and adds them if necessary.
string | $selectPart | Select part |
string | $table | Table to select from |
Definition at line 8532 of file ContentObjectRenderer.php.
References $GLOBALS.
SEARCHRESULT | ( | $conf | ) |
Rendering the cObject, SEARCHRESULT
array | $conf | Array of TypoScript properties |
Definition at line 1370 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
searchWhere | ( | $sw, | |
$searchFieldList, | |||
$searchTable = '' |
|||
) |
Generates a search where clause based on the input search words (AND operation - all search words must be found in record.) Example: The $sw is "content management, system" (from an input form) and the $searchFieldList is "bodytext,header" then the output will be ' AND (bodytext LIKE "%content%" OR header LIKE "%content%") AND (bodytext LIKE "%management%" OR header LIKE "%management%") AND (bodytext LIKE "%system%" OR header LIKE "%system%")'
string | $sw | The search words. These will be separated by space and comma. |
string | $searchFieldList | The fields to search in |
string | $searchTable | The table name you search in (recommended for DBAL compliance. Will be prepended field names as well) |
Definition at line 8136 of file ContentObjectRenderer.php.
setContentObjectClassMap | ( | array | $contentObjectClassMap | ) |
Allow injecting content object class map.
This method is private API, please use configuration $GLOBALS['TYPO3_CONF_VARS']['FE']['ContentObjects'] to add new content objects
Definition at line 645 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$contentObjectClassMap.
setCurrentFile | ( | $fileObject | ) |
Sets the current file object during iterations over files.
File | $fileObject | The file object. |
Definition at line 2339 of file ContentObjectRenderer.php.
setCurrentVal | ( | $value | ) |
Sets the "current" value.
mixed | $value | The variable that you want to set as "current |
Definition at line 781 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey.
setParent | ( | $data, | |
$currentRecord | |||
) |
Sets the internal variable parentRecord with information about current record. If the ContentObjectRender was started from CONTENT, RECORD or SEARCHRESULT cObject's this array has two keys, 'data' and 'currentRecord' which indicates the record and data for the parent cObj.
array | $data | The record array |
string | $currentRecord | This is set to the [table]:[uid] of the record delivered in the $data-array, if the cObjects CONTENT or RECORD is in operation. Note that $GLOBALS['TSFE']->currentRecord is set to an equal value but always indicating the latest record rendered. |
Definition at line 748 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentRecord, and ContentObjectRenderer\$data.
setUserObjectType | ( | $userObjectType | ) |
Sets the user object type
mixed | $userObjectType |
Definition at line 1138 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$userObjectType.
splitObj | ( | $value, | |
$conf | |||
) |
Implements the "split" property of stdWrap; Splits a string based on a token (given in TypoScript properties), sets the "current" value to each part and then renders a content object pointer to by a number. In classic TypoScript (like 'content (default)'/'styles.content (default)') this is used to render tables, splitting rows and cells by tokens and putting them together again wrapped in
tags etc. Implements the "optionSplit" processing of the TypoScript options for each splitted value to parse.
string | $value | The string value to explode by $conf[token] and process each part |
array | $conf | TypoScript properties for "split |
Definition at line 4894 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey, $GLOBALS, MathUtility\canBeInterpretedAsInteger(), ContentObjectRenderer\cObjGet(), ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\stdWrap_split().
start | ( | $data, | |
$table = '' |
|||
) |
Class constructor. Well, it has to be called manually since it is not a real constructor function. So after making an instance of the class, call this function and pass to it a database record and the tablename from where the record is from. That will then become the "current" record loaded into memory and accessed by the .fields property found in eg. stdWrap.
array | $data | The record data that is rendered. |
string | $table | The table that the data record is from. |
Definition at line 674 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$data, $GLOBALS, ContentObjectRenderer\$table, and GeneralUtility\getUserObj().
stdWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript. Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties") See the link below for a complete list of properties and what they do. The order of the table with properties found in TSref (the link) follows the actual order of implementation in this function.
If $this->alternativeData is an array it's used instead of the $this->data array in ->getData
string | $content | Input value undergoing processing in this function. Possibly substituted by other values fetched from another source. |
array | $conf | TypoScript "stdWrap properties". |
Definition at line 2370 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$stdWrapRecursionLevel, elseif, and GeneralUtility\inList().
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\addParams(), ContentObjectRenderer\checkIf(), ContentObjectRenderer\cImage(), ContentObjectRenderer\encaps_lineSplit(), ContentObjectRenderer\getImageSourceCollection(), ContentObjectRenderer\getImageTagTemplate(), ContentObjectRenderer\getSlidePids(), ContentObjectRenderer\http_makelinks(), ContentObjectRenderer\imageLinkWrap(), ContentObjectRenderer\mailto_makelinks(), ContentObjectRenderer\numberFormat(), ContentObjectRenderer\parseFunc(), ContentObjectRenderer\replacementSingle(), ContentObjectRenderer\round(), ContentObjectRenderer\splitObj(), ContentObjectRenderer\stdWrap_addPageCacheTags(), ContentObjectRenderer\stdWrap_hash(), ContentObjectRenderer\stdWrap_noTrimWrap(), ContentObjectRenderer\stdWrap_offsetWrap(), ContentObjectRenderer\stdWrap_orderedStdWrap(), ContentObjectRenderer\stdWrap_stdWrap(), ContentObjectRenderer\stdWrap_strPad(), ContentObjectRenderer\stdWrapValue(), ContentObjectRenderer\tableStyle(), and ContentObjectRenderer\textStyle().
stdWrap_addPageCacheTags | ( | $content = '' , |
|
$conf = array() |
|||
) |
Add tags to page cache (comma-separated list)
string | $content | Input value undergoing processing in these functions. |
array | $conf | All stdWrap properties, not just the ones for a particular function. |
Definition at line 2516 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\stdWrap(), and GeneralUtility\trimExplode().
stdWrap_addParams | ( | $content = '' , |
|
$conf = array() |
|||
) |
addParams Adds tag attributes to any content that is a tag
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for addParams. |
Definition at line 3406 of file ContentObjectRenderer.php.
References ContentObjectRenderer\addParams().
stdWrap_age | ( | $content = '' , |
|
$conf = array() |
|||
) |
age Will return the age of a given timestamp based on configuration given by stdWrap properties
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for age. |
Definition at line 3145 of file ContentObjectRenderer.php.
References $GLOBALS, and ContentObjectRenderer\calcAge().
stdWrap_append | ( | $content = '' , |
|
$conf = array() |
|||
) |
append A content object that will be appended to the current content after most of the wraps have already been applied
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for append. |
Definition at line 3662 of file ContentObjectRenderer.php.
stdWrap_br | ( | $content = '' | ) |
br Searches for single line breaks and replaces them with a
/
tag according to the doctype
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for br. |
Definition at line 3311 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_brTag | ( | $content = '' , |
|
$conf = array() |
|||
) |
brTag Searches for single line feeds and replaces them with the given value
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for brTag. |
Definition at line 3324 of file ContentObjectRenderer.php.
stdWrap_bytes | ( | $content = '' , |
|
$conf = array() |
|||
) |
bytes Will return the size of a given number in Bytes *
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for bytes. |
Definition at line 3172 of file ContentObjectRenderer.php.
References GeneralUtility\formatSize().
stdWrap_cacheRead | ( | $content = '' , |
|
$conf = array() |
|||
) |
Check if content was cached before (depending on the given cache key)
string | $content | Input value undergoing processing in these functions. |
array | $conf | All stdWrap properties, not just the ones for a particular function. |
Definition at line 2500 of file ContentObjectRenderer.php.
stdWrap_case | ( | $content = '' , |
|
$conf = array() |
|||
) |
case Will transform the content to be upper or lower case only Leaves HTML tags untouched
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for case. |
Definition at line 3159 of file ContentObjectRenderer.php.
References ContentObjectRenderer\HTMLcaseshift().
stdWrap_char | ( | $content = '' , |
|
$conf = array() |
|||
) |
char Will return a character based on its position within the current character set
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for char. |
Definition at line 3009 of file ContentObjectRenderer.php.
stdWrap_cObject | ( | $content = '' , |
|
$conf = array() |
|||
) |
cObject Will replace the content with the value of an official TypoScript cObject like TEXT, COA, HMENU
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for cObject. |
Definition at line 2624 of file ContentObjectRenderer.php.
stdWrap_crop | ( | $content = '' , |
|
$conf = array() |
|||
) |
crop Crops content to a given size without caring about HTML tags
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for crop. |
Definition at line 3236 of file ContentObjectRenderer.php.
References ContentObjectRenderer\crop().
stdWrap_cropHTML | ( | $content = '' , |
|
$conf = array() |
|||
) |
cropHTML Crops content to a given size while leaving HTML tags untouched
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for cropHTML. |
Definition at line 3211 of file ContentObjectRenderer.php.
References ContentObjectRenderer\cropHTML().
stdWrap_csConv | ( | $content = '' , |
|
$conf = array() |
|||
) |
csConv Will convert the current chracter set of the content to the one given in csConv
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for csConv. |
Definition at line 2920 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_current | ( | $content = '' , |
|
$conf = array() |
|||
) |
current Gets content that has been perviously set as 'current' Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for current. |
Definition at line 2610 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey.
stdWrap_data | ( | $content = '' , |
|
$conf = array() |
|||
) |
data Gets content from different sources based on getText functions, makes use of alternativeData, when set
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for data. |
Definition at line 2580 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getData().
stdWrap_dataWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
dataWrap Sixth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content Can fetch additional content the same way data does (i.e. {field:whatever}) and apply it to the wrap before that is applied to the content
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for dataWrap. |
Definition at line 3636 of file ContentObjectRenderer.php.
References ContentObjectRenderer\dataWrap().
stdWrap_date | ( | $content = '' , |
|
$conf = array() |
|||
) |
date Will return a formatted date based on configuration given according to PHP date/gmdate properties Will return gmdate when the property GMT returns TRUE
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for date. |
Definition at line 3091 of file ContentObjectRenderer.php.
References $GLOBALS.
stdWrap_debug | ( | $content = '' | ) |
debug Will output the content as readable HTML code
string | $content | Input value undergoing processing in this function. |
Definition at line 3899 of file ContentObjectRenderer.php.
stdWrap_debugData | ( | $content = '' | ) |
debugData Will output the data used by the current record in a debug table
string | $content | Input value undergoing processing in this function. |
Definition at line 3925 of file ContentObjectRenderer.php.
References debug().
stdWrap_debugFunc | ( | $content = '' , |
|
$conf = array() |
|||
) |
debugFunc Will output the content in a debug table
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for debugFunc. |
Definition at line 3912 of file ContentObjectRenderer.php.
References debug().
stdWrap_doubleBrTag | ( | $content = '' , |
|
$conf = array() |
|||
) |
doubleBrTag Searches for double line breaks and replaces them with the given value
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for doubleBrTag. |
Definition at line 3293 of file ContentObjectRenderer.php.
stdWrap_editIcons | ( | $content = '' , |
|
$conf = array() |
|||
) |
editIcons Will render icons for frontend editing as long as there is a BE user logged in
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for editIcons. |
Definition at line 3812 of file ContentObjectRenderer.php.
References ContentObjectRenderer\editIcons(), and ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_editPanel | ( | $content = '' , |
|
$conf = array() |
|||
) |
editPanel Will render the edit panel for frontend editing as long as there is a BE user logged in
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for editPanel. |
Definition at line 3831 of file ContentObjectRenderer.php.
References ContentObjectRenderer\editPanel(), and ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_encapsLines | ( | $content = '' , |
|
$conf = array() |
|||
) |
encapsLines Modifies text blocks by searching for lines which are not surrounded by HTML tags yet and wrapping them with values given by stdWrap properties
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for erncapsLines. |
Definition at line 3338 of file ContentObjectRenderer.php.
References ContentObjectRenderer\encaps_lineSplit().
stdWrap_encodeForJavaScriptValue | ( | $content = '' | ) |
encodeForJavaScriptValue Escapes content to be used inside JavaScript strings. No quotes are added around the value as this can easily be done in TypoScript
string | $content | Input value undergoing processing in this function |
Definition at line 3280 of file ContentObjectRenderer.php.
References GeneralUtility\quoteJSvalue().
stdWrap_expandList | ( | $content = '' | ) |
expandList Will return a formatted number based on configuration given as stdWrap properties
string | $content | Input value undergoing processing in this function. |
Definition at line 3077 of file ContentObjectRenderer.php.
References GeneralUtility\expandList().
stdWrap_field | ( | $content = '' , |
|
$conf = array() |
|||
) |
field Gets content from a DB field
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for field. |
Definition at line 2596 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getFieldVal().
stdWrap_fieldRequired | ( | $content = '' , |
|
$conf = array() |
|||
) |
fieldRequired Will immediately stop rendering and return an empty value when there is no content in the field given by fieldRequired
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for fieldRequired. |
Definition at line 2903 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$stdWrapRecursionLevel.
stdWrap_filelink | ( | $content = '' , |
|
$conf = array() |
|||
) |
filelink Used to make lists of links to files See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for filelink. |
Definition at line 3448 of file ContentObjectRenderer.php.
stdWrap_filelist | ( | $content = '' , |
|
$conf = array() |
|||
) |
filelist Will create a list of files based on some additional parameters
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for filelist. |
Definition at line 2651 of file ContentObjectRenderer.php.
References ContentObjectRenderer\filelist().
stdWrap_fontTag | ( | $content = '' , |
|
$conf = array() |
|||
) |
fontTag A wrap formerly used to apply font tags to format the content Still used by lib.stdheader although real font tags are not state of the art anymore See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for fontTag. |
Definition at line 3393 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_hash | ( | $content = '' , |
|
array | $conf = array() |
||
) |
Will return a hashed value of the current content
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for hash. |
Definition at line 3034 of file ContentObjectRenderer.php.
References ContentObjectRenderer\stdWrap().
stdWrap_HTMLparser | ( | $content = '' , |
|
$conf = array() |
|||
) |
HTMLparser Will parse HTML content based on functions given as stdWrap properties Heavily used together with RTE based content
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for HTMLparser. |
Definition at line 2948 of file ContentObjectRenderer.php.
References ContentObjectRenderer\HTMLparser_TSbridge().
stdWrap_htmlSpecialChars | ( | $content = '' , |
|
$conf = array() |
|||
) |
htmlSpecialChars Transforms HTML tags to readable text by replacing special characters with their HTML entity When preserveEntities returns TRUE, existing entities will be left untouched
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for htmlSpecalChars. |
Definition at line 3262 of file ContentObjectRenderer.php.
stdWrap_if | ( | $content = '' , |
|
$conf = array() |
|||
) |
if Will immediately stop rendering and return an empty value when the result of the checks returns FALSE
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for if. |
Definition at line 2885 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$stdWrapRecursionLevel, and ContentObjectRenderer\checkIf().
stdWrap_ifBlank | ( | $content = '' , |
|
$conf = array() |
|||
) |
ifBlank Will set content to a replacement value in case the trimmed value of content has no length 0 (zero) will not be replaced
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for ifBlank. |
Definition at line 2756 of file ContentObjectRenderer.php.
stdWrap_ifEmpty | ( | $content = '' , |
|
$conf = array() |
|||
) |
ifEmpty Will set content to a replacement value in case the trimmed value of content returns FALSE 0 (zero) will be replaced as well
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for ifEmpty. |
Definition at line 2739 of file ContentObjectRenderer.php.
stdWrap_ifNull | ( | $content = '' , |
|
$conf = array() |
|||
) |
ifNull Will set content to a replacement value in case the value of content is NULL
string | NULL | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for ifNull. |
Definition at line 2725 of file ContentObjectRenderer.php.
stdWrap_innerWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
innerWrap First of a set of different wraps which will be applied in a certain order before or after other functions that modify the content See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for innerWrap. |
Definition at line 3364 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_innerWrap2 | ( | $content = '' , |
|
$conf = array() |
|||
) |
innerWrap2 Second of a set of different wraps which will be applied in a certain order before or after other functions that modify the content See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for innerWrap2. |
Definition at line 3378 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_insertData | ( | $content = '' | ) |
insertData Can fetch additional content the same way data does and replaces any occurrence of {field:whatever} with this content
string | $content | Input value undergoing processing in this function. |
Definition at line 3718 of file ContentObjectRenderer.php.
References ContentObjectRenderer\insertData().
stdWrap_intval | ( | $content = '' | ) |
intval Will return an integer value of the current content
string | $content | Input value undergoing processing in this function. |
Definition at line 3021 of file ContentObjectRenderer.php.
stdWrap_keywords | ( | $content = '' | ) |
keywords Transforms content into a CSV list to be used i.e. as keywords within a meta tag
string | $content | Input value undergoing processing in this function. |
Definition at line 3350 of file ContentObjectRenderer.php.
References ContentObjectRenderer\keywords().
stdWrap_lang | ( | $content = '' , |
|
$conf = array() |
|||
) |
lang Translates content based on the language currently used by the FE
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for lang. |
Definition at line 2563 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_listNum | ( | $content = '' , |
|
$conf = array() |
|||
) |
listNum Gets a value off a CSV list after ifEmpty check Might return an empty value in case the CSV does not contain a value at the position given by listNum Use preIfEmptyListNum to avoid that behaviour
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for listNum. |
Definition at line 2774 of file ContentObjectRenderer.php.
References ContentObjectRenderer\listNum().
stdWrap_noTrimWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
noTrimWrap Fourth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content The major difference to any other wrap is, that this one can make use of whitespace without trimming *
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for noTrimWrap. |
Definition at line 3597 of file ContentObjectRenderer.php.
References ContentObjectRenderer\noTrimWrap(), and ContentObjectRenderer\stdWrap().
stdWrap_numberFormat | ( | $content = '' , |
|
$conf = array() |
|||
) |
numberFormat Will return a formatted number based on configuration given as stdWrap properties
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for numberFormat. |
Definition at line 3065 of file ContentObjectRenderer.php.
References ContentObjectRenderer\numberFormat().
stdWrap_numRows | ( | $content = '' , |
|
$conf = array() |
|||
) |
numRows Counts the number of returned records of a DB operation makes use of select internally
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for numRows. |
Definition at line 2638 of file ContentObjectRenderer.php.
References ContentObjectRenderer\numRows().
stdWrap_offsetWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
offsetWrap Creates a so called offset table around the content Still here for historical reasons even not used too much nowadays
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for offsetWrap. |
Definition at line 3732 of file ContentObjectRenderer.php.
References GeneralUtility\makeInstance(), and ContentObjectRenderer\stdWrap().
stdWrap_orderedStdWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
orderedStdWrap Calls stdWrap for each entry in the provided array
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for orderedStdWrap. |
Definition at line 3689 of file ContentObjectRenderer.php.
References TemplateService\sortedKeyList(), and ContentObjectRenderer\stdWrap().
stdWrap_outerWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
outerWrap Eighth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for outerWrap. |
Definition at line 3706 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_override | ( | $content = '' , |
|
$conf = array() |
|||
) |
override Will override the current value of content with its own value'
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for override. |
Definition at line 2695 of file ContentObjectRenderer.php.
stdWrap_parseFunc | ( | $content = '' , |
|
$conf = array() |
|||
) |
parseFunc Will parse the content based on functions given as stdWrap properties Heavily used together with RTE based content
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for parseFunc. |
Definition at line 2934 of file ContentObjectRenderer.php.
References ContentObjectRenderer\parseFunc().
stdWrap_postCObject | ( | $content = '' , |
|
$conf = array() |
|||
) |
postCObject A content object that is appended to the current content but between the innerWraps and the rest of the wraps
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for postCObject. |
Definition at line 3474 of file ContentObjectRenderer.php.
stdWrap_postUserFunc | ( | $content = '' , |
|
$conf = array() |
|||
) |
postUserFunc Will execute a user function after the content has been modified by any other stdWrap function
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for postUserFunc. |
Definition at line 3760 of file ContentObjectRenderer.php.
References ContentObjectRenderer\callUserFunction().
stdWrap_postUserFuncInt | ( | $content = '' , |
|
$conf = array() |
|||
) |
postUserFuncInt Will execute a user function after the content has been created and each time it is fetched from Cache The result of this function itself will not be cached
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for postUserFuncInt. |
Definition at line 3774 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_preCObject | ( | $content = '' , |
|
$conf = array() |
|||
) |
preCObject A content object that is prepended to the current content but between the innerWraps and the rest of the wraps
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for preCObject. |
Definition at line 3461 of file ContentObjectRenderer.php.
stdWrap_prefixComment | ( | $content = '' , |
|
$conf = array() |
|||
) |
prefixComment Will add HTML comments to the content to make it easier to identify certain content elements within the HTML output later on
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for prefixComment. |
Definition at line 3796 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and ContentObjectRenderer\prefixComment().
stdWrap_preIfEmptyListNum | ( | $content = '' , |
|
$conf = array() |
|||
) |
preIfEmptyListNum Gets a value off a CSV list before the following ifEmpty check Makes sure that the result of ifEmpty will be TRUE in case the CSV does not contain a value at the position given by preIfEmptyListNum
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for preIfEmptyListNum. |
Definition at line 2712 of file ContentObjectRenderer.php.
References ContentObjectRenderer\listNum().
stdWrap_prepend | ( | $content = '' , |
|
$conf = array() |
|||
) |
prepend A content object that will be prepended to the current content after most of the wraps have already been applied
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for prepend. |
Definition at line 3649 of file ContentObjectRenderer.php.
stdWrap_preUserFunc | ( | $content = '' , |
|
$conf = array() |
|||
) |
preUserFunc Will execute a user public function before the content will be modified by any other stdWrap function
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for preUserFunc. |
Definition at line 2664 of file ContentObjectRenderer.php.
References ContentObjectRenderer\callUserFunction().
stdWrap_prioriCalc | ( | $content = '' , |
|
$conf = array() |
|||
) |
prioriCalc Will use the content as a mathematical term and calculate the result Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for prioriCalc. |
Definition at line 2992 of file ContentObjectRenderer.php.
References MathUtility\calculateWithParentheses().
stdWrap_rawUrlEncode | ( | $content = '' | ) |
rawUrlEncode Encodes content to be used within URLs
string | $content | Input value undergoing processing in this function. |
Definition at line 3248 of file ContentObjectRenderer.php.
stdWrap_removeBadHTML | ( | $content = '' | ) |
removeBadHTML Removes HTML tags based on stdWrap properties
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for removeBadHTML. |
Definition at line 3198 of file ContentObjectRenderer.php.
References ContentObjectRenderer\removeBadHTML().
stdWrap_replacement | ( | $content = '' , |
|
$conf = array() |
|||
) |
replacement Will execute replacements on the content (optionally with preg-regex)
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for replacement. |
Definition at line 2978 of file ContentObjectRenderer.php.
References ContentObjectRenderer\replacement().
stdWrap_required | ( | $content = '' | ) |
required Will immediately stop rendering and return an empty value when there is no content at this point
string | $content | Input value undergoing processing in this function. |
Definition at line 2867 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$stdWrapRecursionLevel.
stdWrap_round | ( | $content = '' , |
|
$conf = array() |
|||
) |
stdWrap_round will return a rounded number with ceil(), floor() or round(), defaults to round() Only the english number format is supported . (dot) as decimal point
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for round. |
Definition at line 3052 of file ContentObjectRenderer.php.
References ContentObjectRenderer\round().
stdWrap_setContentToCurrent | ( | $content = '' | ) |
setContentToCurrent actually it just does the contrary: Sets the value of 'current' based on current content
string | $content | Input value undergoing processing in this function. |
Definition at line 2535 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey.
stdWrap_setCurrent | ( | $content = '' , |
|
$conf = array() |
|||
) |
setCurrent Sets the value of 'current' based on the outcome of stdWrap operations
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for setCurrent. |
Definition at line 2549 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$currentValKey.
stdWrap_space | ( | $content = '' , |
|
$conf = array() |
|||
) |
space Will add space before or after the current content By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to TRUE See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for space. |
Definition at line 3566 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrapSpace().
stdWrap_spaceAfter | ( | $content = '' , |
|
$conf = array() |
|||
) |
spaceAfter Will add space after the current content By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to TRUE
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for spaceAfter and space. |
Definition at line 3551 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrapSpace().
stdWrap_spaceBefore | ( | $content = '' , |
|
$conf = array() |
|||
) |
spaceBefore Will add space before the current content By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to TRUE
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for spaceBefore and space. |
Definition at line 3537 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrapSpace().
stdWrap_split | ( | $content = '' , |
|
$conf = array() |
|||
) |
split Will split the content by a given token and treat the results separately Automatically fills 'current' with a single result
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for split. |
Definition at line 2965 of file ContentObjectRenderer.php.
References ContentObjectRenderer\splitObj().
stdWrap_stdWrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
stdWrap A recursive call of the stdWrap function set This enables the user to execute stdWrap functions in another than the predefined order It modifies the content, not the property while the new feature of chained stdWrap functions modifies the property and not the content
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for stdWrap. |
Definition at line 2836 of file ContentObjectRenderer.php.
References ContentObjectRenderer\stdWrap().
stdWrap_strftime | ( | $content = '' , |
|
$conf = array() |
|||
) |
strftime Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties Will return gmstrftime when the property GMT returns TRUE
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for strftime. |
Definition at line 3108 of file ContentObjectRenderer.php.
References $GLOBALS, and ContentObjectRenderer\getTypoScriptFrontendController().
stdWrap_stripHtml | ( | $content = '' | ) |
stripHtml Copmletely removes HTML tags from content
string | $content | Input value undergoing processing in this function. |
Definition at line 3223 of file ContentObjectRenderer.php.
stdWrap_strPad | ( | $content = '' , |
|
$conf = array() |
|||
) |
strPad Will return a string padded left/right/on both sides, based on configuration given as stdWrap properties
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for strPad. |
Definition at line 2799 of file ContentObjectRenderer.php.
References elseif, and ContentObjectRenderer\stdWrap().
stdWrap_strtotime | ( | $content = '' , |
|
$conf = array() |
|||
) |
strtotime Will return a timestamp based on configuration given according to PHP strtotime
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for strtotime. |
Definition at line 3129 of file ContentObjectRenderer.php.
References $GLOBALS.
stdWrap_substring | ( | $content = '' , |
|
$conf = array() |
|||
) |
substring Will return a substring based on position information given by stdWrap properties
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for substring. |
Definition at line 3185 of file ContentObjectRenderer.php.
References ContentObjectRenderer\substring().
stdWrap_tableStyle | ( | $content = '' , |
|
$conf = array() |
|||
) |
tableStyle Wraps content with table tags See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for tableStyle. |
Definition at line 3434 of file ContentObjectRenderer.php.
References ContentObjectRenderer\tableStyle().
stdWrap_TCAselectItem | ( | $content = '' , |
|
$conf = array() |
|||
) |
TCAselectItem Returns a list of options available for a given field in the DB which has to be of the type select
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for TCAselectItem. |
Definition at line 3520 of file ContentObjectRenderer.php.
References ContentObjectRenderer\TCAlookup().
stdWrap_textStyle | ( | $content = '' , |
|
$conf = array() |
|||
) |
textStyle Wraps content in font tags See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for textStyle. |
Definition at line 3420 of file ContentObjectRenderer.php.
References ContentObjectRenderer\textStyle().
stdWrap_trim | ( | $content = '' | ) |
trim Cuts off any whitespace at the beginning and the end of the content
string | $content | Input value undergoing processing in this function. |
Definition at line 2786 of file ContentObjectRenderer.php.
stdWrap_typolink | ( | $content = '' , |
|
$conf = array() |
|||
) |
typolink Wraps the content with a link tag URLs and other attributes are created automatically by the values given in the stdWrap properties See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for typolink. |
Definition at line 3507 of file ContentObjectRenderer.php.
stdWrap_wrap | ( | $content = '' , |
|
$conf = array() |
|||
) |
wrap This is the "mother" of all wraps Third of a set of different wraps which will be applied in a certain order before or after other functions that modify the content Basically it will put additional content before and after the current content using a split character as a placeholder for the current content The default split character is | but it can be replaced with other characters by the property splitChar Any other wrap that does not have own splitChar settings will be using the default split char though
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for wrap. |
Definition at line 3583 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_wrap2 | ( | $content = '' , |
|
$conf = array() |
|||
) |
wrap2 Fifth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content The default split character is | but it can be replaced with other characters by the property splitChar
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for wrap2. |
Definition at line 3622 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_wrap3 | ( | $content = '' , |
|
$conf = array() |
|||
) |
wrap3 Seventh of a set of different wraps which will be applied in a certain order before or after other functions that modify the content The default split character is | but it can be replaced with other characters by the property splitChar
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for wrap3. |
Definition at line 3676 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrap_wrapAlign | ( | $content = '' , |
|
$conf = array() |
|||
) |
wrapAlign Wraps content with a div container having the style attribute text-align set to the given value See wrap
string | $content | Input value undergoing processing in this function. |
array | $conf | stdWrap properties for wrapAlign. |
Definition at line 3488 of file ContentObjectRenderer.php.
References ContentObjectRenderer\wrap().
stdWrapValue | ( | $key, | |
array | $config, | ||
$defaultValue = '' |
|||
) |
Gets a configuration value by passing them through stdWrap first and taking a default value if stdWrap doesn't yield a result.
string | $key | The config variable key (from TS array). |
array | $config | The TypoScript array. |
string | $defaultValue | Optional default value. |
Definition at line 2460 of file ContentObjectRenderer.php.
References elseif, and ContentObjectRenderer\stdWrap().
Referenced by ContentObjectRenderer\cImage(), SplitProcessor\process(), CommaSeparatedValueProcessor\process(), and GalleryProcessor\process().
substituteMarker | ( | $content, | |
$marker, | |||
$markContent | |||
) |
Substitutes a marker string in the input content (by a simple str_replace())
string | $content | The content stream, typically HTML template content. |
string | $marker | The marker string, typically on the form "###[the marker string]### |
mixed | $markContent | The content to insert instead of the marker string found. |
Definition at line 2113 of file ContentObjectRenderer.php.
substituteMarkerAndSubpartArrayRecursive | ( | $content, | |
array | $markersAndSubparts, | ||
$wrap = '' , |
|||
$uppercase = false , |
|||
$deleteUnused = false |
|||
) |
Replaces all markers and subparts in a template with the content provided in the structured array.
string | $content | |
array | $markersAndSubparts | |
string | $wrap | |
bool | $uppercase | |
bool | $deleteUnused |
Definition at line 2294 of file ContentObjectRenderer.php.
substituteMarkerArray | ( | $content, | |
array | $markContentArray, | ||
$wrap = '' , |
|||
$uppercase = false , |
|||
$deleteUnused = false |
|||
) |
Traverses the input $markContentArray array and for each key the marker by the same name (possibly wrapped and in upper case) will be substituted with the keys value in the array.
This is very useful if you have a data-record to substitute in some content. In particular when you use the $wrap and $uppercase values to pre-process the markers. Eg. a key name like "myfield" could effectively be represented by the marker "###MYFIELD###" if the wrap value was "###|###" and the $uppercase boolean TRUE.
string | $content | The content stream, typically HTML template content. |
array | $markContentArray | The array of key/value pairs being marker/content values used in the substitution. For each element in this array the function will substitute a marker in the content stream with the content. |
string | $wrap | A wrap value - [part 1] | [part 2] - for the markers before substitution |
bool | $uppercase | If set, all marker string substitution is done with upper-case markers. |
bool | $deleteUnused | If set, all unused marker are deleted. |
Definition at line 2259 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\cImage(), ContentObjectRenderer\getImageSourceCollection(), and ContentObjectRenderer\substituteMarkerInObject().
substituteMarkerArrayCached | ( | $content, | |
array | $markContentArray = null , |
||
array | $subpartContentArray = null , |
||
array | $wrappedSubpartContentArray = null |
||
) |
Multi substitution function with caching.
This function should be a one-stop substitution function for working with HTML-template. It does not substitute by str_replace but by splitting. This secures that the value inserted does not themselves contain markers or subparts.
Note that the "caching" won't cache the content of the substition, but only the splitting of the template in various parts. So if you want only one cache-entry per template, make sure you always pass the exact same set of marker/subpart keys. Else you will be flooding the users cache table.
This function takes three kinds of substitutions in one: $markContentArray is a regular marker-array where the 'keys' are substituted in $content with their values
$subpartContentArray works exactly like markContentArray only is whole subparts substituted and not only a single marker.
$wrappedSubpartContentArray is an array of arrays with 0/1 keys where the subparts pointed to by the main key is wrapped with the 0/1 value alternating.
string | $content | The content stream, typically HTML template content. |
array | $markContentArray | Regular marker-array where the 'keys' are substituted in $content with their values |
array | $subpartContentArray | Exactly like markContentArray only is whole subparts substituted and not only a single marker. |
array | $wrappedSubpartContentArray | An array of arrays with 0/1 keys where the subparts pointed to by the main key is wrapped with the 0/1 value alternating. |
Definition at line 2150 of file ContentObjectRenderer.php.
substituteMarkerInObject | ( | & | $tree, |
array | $markContentArray | ||
) |
Substitute marker array in an array of values
mixed | $tree | If string, then it just calls substituteMarkerArray. If array(and even multi-dim) then for each key/value pair the marker array will be substituted (by calling this function recursively) |
array | $markContentArray | The array of key/value pairs being marker/content values used in the substitution. For each element in this array the function will substitute a marker in the content string/array values. |
Definition at line 2272 of file ContentObjectRenderer.php.
References ContentObjectRenderer\substituteMarkerArray().
substituteSubpart | ( | $content, | |
$marker, | |||
$subpartContent, | |||
$recursive = 1 |
|||
) |
Substitute subpart in input template stream. This function substitutes a subpart in $content with the content of $subpartContent. Wrapper for ::substituteSubpart which behaves identical
string | $content | The content stream, typically HTML template content. |
string | $marker | The marker string, typically on the form "###[the marker string]### |
mixed | $subpartContent | The content to insert instead of the subpart found. If a string, then just plain substitution happens (includes removing the HTML comments of the subpart if found). If $subpartContent happens to be an array, it's [0] and [1] elements are wrapped around the EXISTING content of the subpart (fetched by getSubpart()) thereby not removing the original content. |
bool | int | $recursive | If $recursive is set, the function calls itself with the content set to the remaining part of the content after the second marker. This means that proceding subparts are ALSO substituted! |
Definition at line 2086 of file ContentObjectRenderer.php.
substituteSubpartArray | ( | $content, | |
array | $subpartsContent | ||
) |
Substitues multiple subparts at once
string | $content | The content stream, typically HTML template content. |
array | $subpartsContent | The array of key/value pairs being subpart/content values used in the substitution. For each element in this array the function will substitute a subpart in the content stream with the content. |
Definition at line 2098 of file ContentObjectRenderer.php.
substring | ( | $content, | |
$options | |||
) |
Implements the stdWrap property "substring" which is basically a TypoScript implementation of the PHP function, substr()
string | $content | The string to perform the operation on |
string | $options | The parameters to substring, given as a comma list of integers where the first and second number is passed as arg 1 and 2 to substr(). |
Definition at line 4265 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\intExplode().
Referenced by ContentObjectRenderer\stdWrap_substring().
SVG | ( | $conf | ) |
Rendering the cObject, SVG
array | $conf | Array of TypoScript properties |
Definition at line 1462 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
SWFOBJECT | ( | $conf | ) |
Rendering the cObject, SWFOBJECT
array | $conf | Array of TypoScript properties |
Definition at line 1436 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
tableStyle | ( | $theValue, | |
$conf | |||
) |
Implements the stdWrap property "tableStyle"; Basically this generates a
with properties which is wrapped around the input value.
string | $theValue | The input value |
array | $conf | TypoScript properties for the "TypoScript function" '->textStyle' |
Definition at line 4591 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$align, ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\stdWrap_tableStyle().
TCAlookup | ( | $inputValue, | |
$conf | |||
) |
Looks up the incoming value in the defined TCA configuration Works only with TCA-type 'select' and options defined in 'items'
mixed | $inputValue | Comma-separated list of values to look up |
array | $conf | TS-configuration array, see TSref for details |
Definition at line 6190 of file ContentObjectRenderer.php.
References $GLOBALS, ContentObjectRenderer\$table, ContentObjectRenderer\getTypoScriptFrontendController(), and GeneralUtility\trimExplode().
Referenced by ContentObjectRenderer\stdWrap_TCAselectItem().
TEMPLATE | ( | $conf | ) |
Rendering the cObject, TEMPLATE
array | $conf | Array of TypoScript properties |
Definition at line 1384 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
TEXT | ( | $conf | ) |
Rendering the cObject, TEXT
array | $conf | Array of TypoScript properties |
Definition at line 1064 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
textStyle | ( | $theValue, | |
$conf | |||
) |
Implements the stdWrap property "textStyle"; This generates a <font>-tag (and a
string | $theValue | The input value |
array | $conf | TypoScript properties for the "TypoScript function" '->textStyle' |
Definition at line 4509 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$align, elseif, ContentObjectRenderer\getTypoScriptFrontendController(), ContentObjectRenderer\HTMLcaseshift(), ContentObjectRenderer\stdWrap(), and ContentObjectRenderer\wrap().
Referenced by ContentObjectRenderer\stdWrap_textStyle().
typoLink_URL | ( | $conf | ) |
Based on the input "TypoLink" TypoScript configuration this will return the generated URL
array | $conf | TypoScript properties for "typolink |
Definition at line 6832 of file ContentObjectRenderer.php.
References ContentObjectRenderer\$lastTypoLinkUrl.
Referenced by ContentObjectRenderer\getUrlToCurrentLocation().
typolinkWrap | ( | $conf | ) |
Generates a typolink and returns the two link tags - start and stop - in an array
array | $conf | "typolink" TypoScript properties |
Definition at line 6917 of file ContentObjectRenderer.php.
URLqMark | ( | $url, | |
$params | |||
) |
Checks if $url has a '?' in it and if not, a '?' is inserted between $url and $params, which are anyway concatenated and returned
string | $url | Input URL |
string | $params | URL parameters |
Definition at line 7451 of file ContentObjectRenderer.php.
References $url.
USER | ( | $conf, | |
$ext = '' |
|||
) |
Rendering the cObject, USER and USER_INT
array | $conf | Array of TypoScript properties |
string | $ext | If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached) |
Definition at line 1109 of file ContentObjectRenderer.php.
References ContentObjectRenderer\getContentObject(), and GeneralUtility\logDeprecatedFunction().
wrap | ( | $content, | |
$wrap, | |||
$char = '|' |
|||
) |
Wrapping a string. Implements the TypoScript "wrap" property. Example: $content = "HELLO WORLD" and $wrap = "<strong> | </strong>", result: "<strong>HELLO WORLD</strong>"
string | $content | The content to wrap |
string | $wrap | The wrap value, eg. "<strong> | </strong> @param string $char The char used to split the wrapping value, default is "| |
Definition at line 7143 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\cImage(), ContentObjectRenderer\dataWrap(), ContentObjectRenderer\encaps_lineSplit(), ContentObjectRenderer\http_makelinks(), ContentObjectRenderer\mailto_makelinks(), ContentObjectRenderer\parseFunc(), ContentObjectRenderer\splitObj(), ContentObjectRenderer\stdWrap_fontTag(), ContentObjectRenderer\stdWrap_innerWrap(), ContentObjectRenderer\stdWrap_innerWrap2(), ContentObjectRenderer\stdWrap_outerWrap(), ContentObjectRenderer\stdWrap_wrap(), ContentObjectRenderer\stdWrap_wrap2(), ContentObjectRenderer\stdWrap_wrap3(), ContentObjectRenderer\stdWrap_wrapAlign(), ContentObjectRenderer\tableStyle(), and ContentObjectRenderer\textStyle().
wrapSpace | ( | $content, | |
$wrap, | |||
array | $conf = null |
||
) |
Adds space above/below the input HTML string. It is done by adding a clear-gif and
tag before and/or after the content.
string | $content | The content to add space above/below to. |
string | $wrap | A value like "10 | 20" where the first part denotes the space BEFORE and the second part denotes the space AFTER (in pixels) |
array | $conf | Configuration from TypoScript |
Definition at line 7179 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap_space(), ContentObjectRenderer\stdWrap_spaceAfter(), and ContentObjectRenderer\stdWrap_spaceBefore().
$align |
Definition at line 68 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\tableStyle(), and ContentObjectRenderer\textStyle().
$alternativeData = '' |
Definition at line 403 of file ContentObjectRenderer.php.
$checkPid_badDoktypeList = '255' |
Definition at line 470 of file ContentObjectRenderer.php.
$checkPid_cache = array() |
Definition at line 465 of file ContentObjectRenderer.php.
$cObjHookObjectsArr = array() |
Definition at line 515 of file ContentObjectRenderer.php.
|
protected |
Definition at line 510 of file ContentObjectRenderer.php.
|
protected |
Definition at line 258 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\setContentObjectClassMap().
|
protected |
Definition at line 534 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getCurrentFile().
$currentRecord = '' |
Definition at line 423 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\setParent().
$currentRecordNumber = 0 |
Definition at line 437 of file ContentObjectRenderer.php.
$currentRecordTotal = 0 |
Definition at line 430 of file ContentObjectRenderer.php.
$currentValKey = 'currentValue_kidjls9dksoje' |
Definition at line 415 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\getCurrentVal(), ContentObjectRenderer\getData(), ContentObjectRenderer\setCurrentVal(), ContentObjectRenderer\splitObj(), ContentObjectRenderer\stdWrap_current(), ContentObjectRenderer\stdWrap_setContentToCurrent(), and ContentObjectRenderer\stdWrap_setCurrent().
$data = array() |
Definition at line 384 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\_parseFunc(), ContentObjectRenderer\filelist(), ContentObjectRenderer\http_makelinks(), ContentObjectRenderer\mailto_makelinks(), ContentObjectRenderer\setParent(), and ContentObjectRenderer\start().
$doConvertToUserIntObject = false |
Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT
Definition at line 539 of file ContentObjectRenderer.php.
|
protected |
Definition at line 529 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getGetImgResourceHookObjects().
$image_compression |
Definition at line 266 of file ContentObjectRenderer.php.
$image_effects |
Definition at line 363 of file ContentObjectRenderer.php.
$INT_include = 0 |
Definition at line 458 of file ContentObjectRenderer.php.
$lastTypoLinkLD = array() |
Definition at line 489 of file ContentObjectRenderer.php.
$lastTypoLinkTarget = '' |
Definition at line 484 of file ContentObjectRenderer.php.
$lastTypoLinkUrl = '' |
Definition at line 477 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getTypoLink_URL(), and ContentObjectRenderer\typoLink_URL().
$oldData = array() |
Definition at line 396 of file ContentObjectRenderer.php.
$parameters = array() |
Definition at line 410 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\imageLinkWrap().
$parentRecord = array() |
Definition at line 451 of file ContentObjectRenderer.php.
$parentRecordNumber = 0 |
Definition at line 444 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getData().
$recordRegister = array() |
Definition at line 503 of file ContentObjectRenderer.php.
|
protected |
Definition at line 522 of file ContentObjectRenderer.php.
$stdWrapOrder |
stdWrap functions in their correct order
Definition at line 79 of file ContentObjectRenderer.php.
|
protected |
Definition at line 556 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\stdWrap(), ContentObjectRenderer\stdWrap_fieldRequired(), ContentObjectRenderer\stdWrap_if(), and ContentObjectRenderer\stdWrap_required().
|
protected |
Definition at line 551 of file ContentObjectRenderer.php.
$substMarkerCache = array() |
Definition at line 496 of file ContentObjectRenderer.php.
|
protected |
Definition at line 389 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\DBgetDelete(), ContentObjectRenderer\DBgetInsert(), ContentObjectRenderer\DBgetUpdate(), ContentObjectRenderer\DBmayFEUserEdit(), ContentObjectRenderer\DBmayFEUserEditSelect(), ContentObjectRenderer\enableFields(), ContentObjectRenderer\getCurrentTable(), ContentObjectRenderer\start(), and ContentObjectRenderer\TCAlookup().
|
protected |
Definition at line 566 of file ContentObjectRenderer.php.
|
protected |
Definition at line 561 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\__construct().
|
protected |
Indicates current object type. Can hold one of OBJECTTYPE_ constants or FALSE. The value is set and reset inside USER() function. Any time outside of USER() it is FALSE.
Definition at line 546 of file ContentObjectRenderer.php.
Referenced by ContentObjectRenderer\getUserObjectType(), and ContentObjectRenderer\setUserObjectType().
const OBJECTTYPE_USER = 2 |
Indicates that object type is USER.
Definition at line 579 of file ContentObjectRenderer.php.
Referenced by UserContentObject\render().
const OBJECTTYPE_USER_INT = 1 |
Indicates that object type is USER.
Definition at line 573 of file ContentObjectRenderer.php.
Referenced by UserInternalContentObject\render().