"TYPO3 4.0.1: t3lib_tsparser_ext Class Reference", "datetime" => "Sat Dec 2 19:26:30 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

t3lib_tsparser_ext Class Reference

Inheritance diagram for t3lib_tsparser_ext:

Inheritance graph
[legend]
Collaboration diagram for t3lib_tsparser_ext:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 flattenSetup ($setupArray, $prefix, $resourceFlag)
 substituteConstants ($all)
 substituteConstantsCallBack ($matches)
 substituteCMarkers ($all)
 generateConfig_constants ()
 ext_getSetup ($theSetup, $theKey)
 ext_getObjTree ($arr, $depth_in, $depthData, $parentType="", $parentValue="")
 lineNumberToScript ($lnArr)
 makeHtmlspecialchars ($theValue)
 ext_getSearchKeys ($arr, $depth_in, $searchString, $keyArray)
 ext_getRootlineNumber ($pid)
 ext_getTemplateHierarchyArr ($arr, $depthData, $keyArray, $first=0)
 ext_process_hierarchyInfo ($depthDataArr, &$pointer)
 ext_outputTS ($config, $lineNumbers=0, $comments=0, $crop=0, $syntaxHL=0, $syntaxHLBlockmode=0)
 ext_fixed_lgd ($string, $chars)
 ext_lnBreakPointWrap ($ln, $str)
 ext_formatTS ($input, $ln, $comments=1, $crop=0)
 ext_getFirstTemplate ($id, $template_uid=0)
 ext_getAllTemplates ($id)
 ext_compareFlatSetups ($default)
 ext_categorizeEditableConstants ($editConstArray)
 ext_getCategoryLabelArray ()
 ext_getTypeData ($type)
 ext_getTSCE_config ($category)
 ext_getKeyImage ($key)
 ext_getTSCE_config_image ($imgConf)
 ext_resourceDims ()
 ext_readDirResources ($path)
 readDirectory ($path, $type="file")
 ext_fNandV ($params)
 ext_printFields ($theConstants, $category)
 ext_regObjectPositions ($constants)
 ext_regObjects ($pre)
 ext_putValueInConf ($key, $var)
 ext_removeValueInConf ($key)
 ext_depthKeys ($arr, $settings)
 ext_procesInput ($http_post_vars, $http_post_files, $theConstants, $tplRow)
 upload_copy_file ($typeDat, &$tplRow, $theRealFileName, $tmp_name)
 ext_prevPageWithTemplate ($id, $perms_clause)
 ext_setStar ($val)
 ext_detectAndFixExtensionPrefix ($value)

Public Attributes

 $edit_divider = "###MOD_TS:EDITABLE_CONSTANTS###"
 $HTMLcolorList = "aqua,black,blue,fuchsia,gray,green,lime,maroon,navy,olive,purple,red,silver,teal,yellow,white"
 $categories
 $subCategories
 $resourceDimensions = array()
 $dirResources = array()
 $backend_info = 1
 $ext_inBrace = 0
 $tsbrowser_searchKeys = array()
 $tsbrowser_depthKeys = array()
 $constantMode = ""
 $regexMode = ""
 $fixedLgd = ""
 $resourceCheck = 0
 $ext_lineNumberOffset = 0
 $ext_localGfxPrefix = ""
 $ext_localWebGfxPrefix = ""
 $ext_expandAllNotes = 0
 $ext_noPMicons = 0
 $ext_noSpecialCharsOnLabels = 0
 $ext_listOfTemplatesArr = array()
 $ext_lineNumberOffset_mode = ""
 $ext_dontCheckIssetValues = 0
 $ext_noCEUploadAndCopying = 0
 $ext_printAll = 0
 $ext_CEformName = "forms[0]"
 $ext_defaultOnlineResourceFlag = 0
 $doNotSortCategoriesBeforeMakingForm = FALSE
 $templateTitles = array()

Detailed Description

Definition at line 105 of file class.t3lib_tsparser_ext.php.


Member Function Documentation

t3lib_tsparser_ext::ext_categorizeEditableConstants editConstArray  ) 
 

[Describe function...]

Parameters:
[type] $editConstArray: ...
Returns:
[type] ...

Definition at line 873 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_setValueArray().

t3lib_tsparser_ext::ext_compareFlatSetups default  ) 
 

This function compares the flattened constants (default and all). Returns an array with the constants from the whole template which may be edited by the module.

Parameters:
[type] $default: ...
Returns:
[type] ...

Definition at line 807 of file class.t3lib_tsparser_ext.php.

Referenced by generateConfig_constants().

t3lib_tsparser_ext::ext_depthKeys arr,
settings
 

[Describe function...]

Parameters:
[type] $arr: ...
[type] $settings: ...
Returns:
[type] ...

Definition at line 1472 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_detectAndFixExtensionPrefix value  ) 
 

[Describe function...]

Parameters:
[type] $value: ...
Returns:
[type] ...

Definition at line 1711 of file class.t3lib_tsparser_ext.php.

References t3lib_extMgm::siteRelPath().

t3lib_tsparser_ext::ext_fixed_lgd string,
chars
 

Returns a new string of max. $chars lenght If the string is longer, it will be truncated and prepended with "..." $chars must be an integer of at least 4

Parameters:
[type] $string: ...
[type] $chars: ...
Returns:
[type] ...

Definition at line 698 of file class.t3lib_tsparser_ext.php.

Referenced by ext_getObjTree().

t3lib_tsparser_ext::ext_fNandV params  ) 
 

[Describe function...]

Parameters:
[type] $params: ...
Returns:
[type] ...

Reimplemented in t3lib_tsStyleConfig.

Definition at line 1098 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_formatTS input,
ln,
comments = 1,
crop = 0
 

[Describe function...]

Parameters:
[type] $input: ...
[type] $ln: ...
[type] $comments: ...
[type] $crop: ...
Returns:
[type] ...

Definition at line 727 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getAllTemplates id  ) 
 

[Describe function...]

Parameters:
[type] $id: ...
Returns:
[type] ...

Definition at line 786 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getCategoryLabelArray  ) 
 

[Describe function...]

Returns:
[type] ...

Definition at line 896 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_getCategoriesForModMenu().

t3lib_tsparser_ext::ext_getFirstTemplate id,
template_uid = 0
 

[Describe function...]

Parameters:
[type] $id: ...
[type] $template_uid: ...
Returns:
[type] ...

Definition at line 766 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getKeyImage key  ) 
 

[Describe function...]

Parameters:
[type] $key: ...
Returns:
[type] ...

Reimplemented in t3lib_tsStyleConfig.

Definition at line 994 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getObjTree arr,
depth_in,
depthData,
parentType = "",
parentValue = ""
 

[Describe function...]

Parameters:
[type] $arr: ...
[type] $depth_in: ...
[type] $depthData: ...
[type] $parentType: ...
[type] $parentValue: ...
Returns:
[type] ...

Definition at line 366 of file class.t3lib_tsparser_ext.php.

References ext_fixed_lgd(), t3lib_div::inList(), and t3lib_div::testInt().

t3lib_tsparser_ext::ext_getRootlineNumber pid  ) 
 

[Describe function...]

Parameters:
[type] $pid: ...
Returns:
[type] ...

Definition at line 563 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getSearchKeys arr,
depth_in,
searchString,
keyArray
 

[Describe function...]

Parameters:
[type] $arr: ...
[type] $depth_in: ...
[type] $searchString: ...
[type] $keyArray: ...
Returns:
[type] ...

Definition at line 507 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getSetup theSetup,
theKey
 

[Describe function...]

Parameters:
[type] $theSetup: ...
[type] $theKey: ...
Returns:
[type] ...

Definition at line 335 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getTemplateHierarchyArr arr,
depthData,
keyArray,
first = 0
 

[Describe function...]

Parameters:
[type] $arr: ...
[type] $depthData: ...
[type] $keyArray: ...
[type] $first: ...
Returns:
[type] ...

Definition at line 581 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getTSCE_config category  ) 
 

[Describe function...]

Parameters:
[type] $category: ...
Returns:
[type] ...

Definition at line 955 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_makeHelpInformationForCategory().

t3lib_tsparser_ext::ext_getTSCE_config_image imgConf  ) 
 

[Describe function...]

Parameters:
[type] $imgConf: ...
Returns:
[type] ...

Reimplemented in t3lib_tsStyleConfig.

Definition at line 1004 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_getTypeData type  ) 
 

[Describe function...]

Parameters:
[type] $type: ...
Returns:
[type] ...

Definition at line 913 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_lnBreakPointWrap ln,
str
 

[Describe function...]

Parameters:
[type] $ln: ...
[type] $str: ...
Returns:
[type] ...

Definition at line 714 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_outputTS config,
lineNumbers = 0,
comments = 0,
crop = 0,
syntaxHL = 0,
syntaxHLBlockmode = 0
 

[Describe function...]

Parameters:
[type] $config: ...
[type] $lineNumbers: ...
[type] $comments: ...
[type] $crop: ...
[type] $syntaxHL: ...
[type] $syntaxHLBlockmode: ...
Returns:
[type] ...

Definition at line 671 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_prevPageWithTemplate id,
perms_clause
 

[Describe function...]

Parameters:
[type] $id: ...
[type] $perms_clause: ...
Returns:
[type] ...

Definition at line 1683 of file class.t3lib_tsparser_ext.php.

References t3lib_BEfunc::BEgetRootLine().

t3lib_tsparser_ext::ext_printFields theConstants,
category
 

[Describe function...]

Parameters:
[type] $theConstants: ...
[type] $category: ...
Returns:
[type] ...

Definition at line 1116 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_getForm().

t3lib_tsparser_ext::ext_procesInput http_post_vars,
http_post_files,
theConstants,
tplRow
 

[Describe function...]

Parameters:
[type] $http_post_vars: ...
[type] $http_post_files: ...
[type] $theConstants: ...
[type] $tplRow: ...
Returns:
[type] ...

Definition at line 1507 of file class.t3lib_tsparser_ext.php.

References t3lib_div::inList(), and t3lib_div::intInRange().

t3lib_tsparser_ext::ext_process_hierarchyInfo depthDataArr,
&$  pointer
 

[Describe function...]

Parameters:
[type] $depthDataArr: ...
[type] $pointer: ...
Returns:
[type] ...

Definition at line 640 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_putValueInConf key,
var
 

[Describe function...]

Parameters:
[type] $key: ...
[type] $var: ...
Returns:
[type] ...

Reimplemented in t3lib_tsStyleConfig.

Definition at line 1433 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_readDirResources path  ) 
 

[Describe function...]

Parameters:
[type] $path: ...
Returns:
[type] ...

Definition at line 1058 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_loadResources().

t3lib_tsparser_ext::ext_regObjectPositions constants  ) 
 

Parameters:
[type] $constants: ...
Returns:
[type] ...

Definition at line 1373 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_regObjects pre  ) 
 

[Describe function...]

Parameters:
[type] $pre: ...
Returns:
[type] ...

Definition at line 1388 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_removeValueInConf key  ) 
 

[Describe function...]

Parameters:
[type] $key: ...
Returns:
[type] ...

Reimplemented in t3lib_tsStyleConfig.

Definition at line 1456 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::ext_resourceDims  ) 
 

[Describe function...]

Returns:
[type] ...

Definition at line 1028 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_loadResources().

t3lib_tsparser_ext::ext_setStar val  ) 
 

[Describe function...]

Parameters:
[type] $val: ...
Returns:
[type] ...

Definition at line 1699 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::flattenSetup setupArray,
prefix,
resourceFlag
 

This flattens a hierarchical setuparray to $this->flatSetup The original function fetched the resource-file if any ("file."). This functions doesn't.

Parameters:
[type] $setupArray: ...
[type] $prefix: ...
[type] $resourceFlag: ...
Returns:
[type] ...

Reimplemented from t3lib_TStemplate.

Definition at line 194 of file class.t3lib_tsparser_ext.php.

References t3lib_TStemplate::getFileName().

Referenced by t3lib_tsStyleConfig::ext_setValueArray(), and generateConfig_constants().

t3lib_tsparser_ext::generateConfig_constants  ) 
 

[Describe function...]

Returns:
[type] ...

Definition at line 286 of file class.t3lib_tsparser_ext.php.

References t3lib_TStemplate::$constants, ext_compareFlatSetups(), flattenSetup(), t3lib_div::makeInstance(), and t3lib_TStemplate::mergeConstantsFromPageTSconfig().

Referenced by t3lib_tsStyleConfig::ext_initTSstyleConfig().

t3lib_tsparser_ext::lineNumberToScript lnArr  ) 
 

[Describe function...]

Parameters:
[type] $lnArr: ...
Returns:
[type] ...

Definition at line 463 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::makeHtmlspecialchars theValue  ) 
 

[Describe function...]

Parameters:
[type] $theValue: ...
Returns:
[type] ...

Reimplemented in ext_TSparser.

Definition at line 494 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::readDirectory path,
type = "file"
 

[Describe function...]

Parameters:
[type] $path: ...
[type] $type: ...
Returns:
[type] ...

Definition at line 1073 of file class.t3lib_tsparser_ext.php.

Referenced by t3lib_tsStyleConfig::ext_loadResources().

t3lib_tsparser_ext::substituteCMarkers all  ) 
 

[Describe function...]

Parameters:
[type] $all: ...
Returns:
[type] ...

Definition at line 264 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::substituteConstants all  ) 
 

[Describe function...]

Parameters:
[type] $all: ...
Returns:
[type] ...

Reimplemented from t3lib_TStemplate.

Definition at line 221 of file class.t3lib_tsparser_ext.php.

References substituteConstantsCallBack().

t3lib_tsparser_ext::substituteConstantsCallBack matches  ) 
 

Call back method for preg_replace_callback in substituteConstants

Parameters:
array Regular expression matches
Returns:
string Replacement
See also:
substituteConstants()

Reimplemented from t3lib_TStemplate.

Definition at line 234 of file class.t3lib_tsparser_ext.php.

Referenced by substituteConstants().

t3lib_tsparser_ext::upload_copy_file typeDat,
&$  tplRow,
theRealFileName,
tmp_name
 

[Describe function...]

Parameters:
[type] $typeDat: ...
[type] $tplRow: ...
[type] $theRealFileName: ...
[type] $tmp_name: ...
Returns:
[type] ...

Definition at line 1634 of file class.t3lib_tsparser_ext.php.

References t3lib_BEfunc::getRecordWSOL(), t3lib_div::inList(), t3lib_div::makeInstance(), t3lib_div::split_fileref(), t3lib_div::trimExplode(), t3lib_div::unlink_tempfile(), and t3lib_div::upload_to_tempfile().


Member Data Documentation

t3lib_tsparser_ext::$categories
 

Initial value:

 array(
                "basic" => array(),             // Constants of superior importance for the template-layout. This is dimensions, imagefiles and enabling of various features. The most basic constants, which you would almost always want to configure.
                "menu" => array(),              // Menu setup. This includes fontfiles, sizes, background images. Depending on the menutype.
                "content" => array(),   // All constants related to the display of pagecontent elements
                "page" => array(),              // General configuration like metatags, link targets
                "advanced" => array(),  // Advanced functions, which are used very seldomly.
                "all" => array()                // All constants are put here also!
        )

Reimplemented in t3lib_tsStyleConfig.

Definition at line 111 of file class.t3lib_tsparser_ext.php.

t3lib_tsparser_ext::$subCategories
 

Initial value:

 array(
        // Standard categories:
                "enable" => Array("Enable features", "a"),
                "dims" => Array("Dimensions, widths, heights, pixels", "b"),
                "file" => Array("Files", "c"),
                "typo"  => Array("Typography", "d"),
                "color" => Array("Colors", "e"),
                "links" => Array("Links and targets", "f"),
                "language" => Array("Language specific constants", "g"),

        // subcategories based on the default content elements
                "cheader" => Array("Content: 'Header'", "ma"),
                "cheader_g" => Array("Content: 'Header', Graphical", "ma"),
                "ctext" => Array("Content: 'Text'", "mb"),
//              "ctextpic" =>
                "cimage" => Array("Content: 'Image'", "md"),
                "cbullets" => Array("Content: 'Bullet list'", "me"),
                "ctable" => Array("Content: 'Table'", "mf"),
                "cuploads" => Array("Content: 'Filelinks'", "mg"),
                "cmultimedia" => Array("Content: 'Multimedia'", "mh"),
                "cmailform" => Array("Content: 'Form'", "mi"),
                "csearch" => Array("Content: 'Search'", "mj"),
                "clogin" => Array("Content: 'Login'", "mk"),
                "csplash" => Array("Content: 'Textbox'", "ml"),
                "cmenu" => Array("Content: 'Menu/Sitemap'", "mm"),
                "cshortcut" => Array("Content: 'Insert records'", "mn"),
                "clist" => Array("Content: 'List of records'", "mo"),
                "cscript" => Array("Content: 'Script'", "mp"),
                "chtml" => Array("Content: 'HTML'", "mq")
        )

Definition at line 119 of file class.t3lib_tsparser_ext.php.


The documentation for this class was generated from the following file: