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

t3lib_parsehtml_proc Class Reference

Inheritance diagram for t3lib_parsehtml_proc:

Inheritance graph
[legend]
Collaboration diagram for t3lib_parsehtml_proc:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 init ($elRef='', $recPid=0)
 setRelPath ($path)
 evalWriteFile ($pArr, $currentRecord)
 RTE_transform ($value, $specConf, $direction='rte', $thisConfig=array())
 TS_images_db ($value)
 TS_images_rte ($value)
 TS_reglinks ($value, $direction)
 TS_links_db ($value)
 TS_links_rte ($value)
 TS_preserve_db ($value)
 TS_preserve_rte ($value)
 TS_transform_db ($value, $css=FALSE)
 transformStyledATags ($value)
 TS_transform_rte ($value, $css=0)
 TS_strip_db ($value)
 getURL ($url)
 HTMLcleaner_db ($content, $tagList='')
 getKeepTags ($direction='rte', $tagList='')
 divideIntoLines ($value, $count=5, $returnArray=FALSE)
 setDivTags ($value, $dT='p')
 internalizeFontTags ($value)
 siteUrl ()
 rteImageStorageDir ()
 removeTables ($value, $breakChar='< br/>')
 defaultTStagMapping ($code, $direction='rte')
 getWHFromAttribs ($attribArray)
 urlInfoForLinkTags ($url)
 TS_AtagToAbs ($value, $dontSetRTEKEEP=FALSE)

Public Attributes

 $headListTags = 'PRE,UL,OL,H1,H2,H3,H4,H5,H6,HR,ADDRESS,DL'
 $recPid = 0
 $elRef = ''
 $relPath = ''
 $relBackPath = ''
 $procOptions = ''
 $TS_transform_db_safecounter = 100
 $rte_p = ''
 $getKeepTags_cache = array()
 $allowedClasses = array()
 $preserveTags = ''

Detailed Description

Definition at line 103 of file class.t3lib_parsehtml_proc.php.

Member Function Documentation

t3lib_parsehtml_proc::defaultTStagMapping (  $  code,
$  direction = 'rte'
) 
 

Default tag mapping for TS

Parameters:
string Input code to process
string Direction To databsae (db) or from database to RTE (rte)
Returns:
string Processed value

Definition at line 1441 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::divideIntoLines (  $  value,
$  count = 5,
$  returnArray = FALSE
) 
 

This resolves the $value into parts based on

-sections and

-sections and
-tags. These are returned as lines separated by chr(10). This point is to resolve the HTML-code returned from RTE into ordinary lines so it's 'human-readable' The function ->setDivTags does the opposite. This function processes content to go into the database.

Parameters:
string Value to process.
integer Recursion brake. Decremented on each recursion down to zero. Default is 5 (which equals the allowed nesting levels of p/div tags).
boolean If true, an array with the lines is returned, otherwise a string of the processed input value.
Returns:
string Processed input value.
See also:
setDivTags()

Definition at line 1200 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::trimExplode().

t3lib_parsehtml_proc::evalWriteFile (  $  pArr,
$  currentRecord
) 
 

Evaluate the environment for editing a staticFileEdit file. Called for almost all fields being saved in the database. Is called without an instance of the object: t3lib_parsehtml_proc::evalWriteFile()

Parameters:
array Parameters for the current field as found in types-config
array Current record we are editing.
Returns:
mixed On success an array with various information is returned, otherwise a string with an error message
See also:
t3lib_TCEmain, t3lib_transferData

Definition at line 174 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::validPathStr().

Referenced by t3lib_TCEmain::fillInFieldArray(), t3lib_TCEforms::getSingleField_typeText(), and t3lib_transferData::renderRecord_typesProc().

t3lib_parsehtml_proc::getKeepTags (  $  direction = 'rte',
$  tagList = ''
) 
 

Creates an array of configuration for the HTMLcleaner function based on whether content go TO or FROM the Rich Text Editor ($direction) Unless "tagList" is given, the function will cache the configuration for next time processing goes on. (In this class that is the case only if we are processing a bulletlist)

Parameters:
string The direction of the content being processed by the output configuration; "db" (content going into the database FROM the rte) or "rte" (content going into the form)
string Comma list of tags to keep (overriding default which is to keep all + take notice of internal configuration)
Returns:
array Configuration array
See also:
HTMLcleaner_db()

Definition at line 1091 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::trimExplode().

t3lib_parsehtml_proc::getURL (  $  url  ) 
 

Reads the file or url $url and returns the content

Parameters:
string Filepath/URL to read
Returns:
string The content from the resource given as input.
See also:
t3lib_div::getURL()

Definition at line 1050 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::getURL().

t3lib_parsehtml_proc::getWHFromAttribs (  $  attribArray  ) 
 

Finds width and height from attrib-array If the width and height is found in the style-attribute, use that!

Parameters:
array Array of attributes from tag in which to search. More specifically the content of the key "style" is used to extract "width:xxx / height:xxx" information
Returns:
array Integer w/h in key 0/1. Zero is returned if not found.

Definition at line 1464 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::HTMLcleaner_db (  $  content,
$  tagList = ''
) 
 

Function for cleaning content going into the database. Content is cleaned eg. by removing unallowed HTML and ds-HSC content It is basically calling HTMLcleaner from the parent class with some preset configuration specifically set up for cleaning content going from the RTE into the db

Parameters:
string Content to clean up
string Comma list of tags to specifically allow. Default comes from getKeepTags and is ""
Returns:
string Clean content
See also:
getKeepTags()

Definition at line 1064 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::init (  $  elRef = '',
$  recPid = 0
) 
 

Initialize, setting element reference and record PID

Parameters:
string Element reference, eg "tt_content:bodytext"
integer PID of the record (page id)
Returns:
void

Definition at line 138 of file class.t3lib_parsehtml_proc.php.

References $elRef, and $recPid.

t3lib_parsehtml_proc::internalizeFontTags (  $  value  ) 
 

This splits the $value in font-tag chunks. If there are any

/

sections inside of them, the font-tag is wrapped AROUND the content INSIDE of the P/DIV sections and the outer font-tag is removed. This functions seems to be a good choice for pre-processing content if it has been pasted into the RTE from eg. star-office. In that case the font-tags are normally on the OUTSIDE of the sections. This function is used by eg. divideIntoLines() if the procesing option 'internalizeFontTags' is set.

Parameters:
string Input content
Returns:
string Output content
See also:
divideIntoLines()

Definition at line 1351 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::removeTables (  $  value,
$  breakChar = '<br />'
) 
 

Remove all tables from incoming code The function is trying to to this is some more or less respectfull way. The approach is to resolve each table cells content and implode it all by
chars. Thus at least the content is preserved in some way.

Parameters:
string Input value
string Break character to use for linebreaks.
Returns:
string Output value

Definition at line 1409 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::RTE_transform (  $  value,
$  specConf,
$  direction = 'rte',
$  thisConfig = array()
) 
 

Transform value for RTE based on specConf in the direction specified by $direction (rte/db) This is the main function called from tcemain and transfer data classes

Parameters:
string Input value
array Special configuration for a field; This is coming from the types-configuration of the field in the TCA. In the types-configuration you can setup features for the field rendering and in particular the RTE takes al its major configuration options from there!
string Direction of the transformation. Two keywords are allowed; "db" or "rte". If "db" it means the transformation will clean up content coming from the Rich Text Editor and goes into the database. The other direction, "rte", is of course when content is coming from database and must be transformed to fit the RTE.
array Parsed TypoScript content configuring the RTE, probably coming from Page TSconfig.
Returns:
string Output value
See also:
t3lib_TCEmain::fillInFieldArray(), t3lib_transferData::renderRecord_typesProc()

Definition at line 232 of file class.t3lib_parsehtml_proc.php.

References t3lib_BEfunc::getSpecConfParametersFromArray(), t3lib_div::getUserObj(), and t3lib_div::trimExplode().

t3lib_parsehtml_proc::rteImageStorageDir (   ) 
 

Return the storage folder of RTE image files. Default is $GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir'] unless something else is configured in the types configuration for the RTE.

Returns:
string

Definition at line 1397 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::setDivTags (  $  value,
$  dT = 'p'
) 
 

Converts all lines into

/

-sections (unless the line is a div-section already) For processing of content going FROM database TO RTE.

Parameters:
string Value to convert
string Tag to wrap with. Either "p" or "div" should it be. Lowercase preferably.
Returns:
string Processed value.
See also:
divideIntoLines()

Definition at line 1306 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::setRelPath (  $  path  ) 
 

Setting the ->relPath and ->relBackPath to proper values so absolute references to links and images can be converted to relative dittos. This is used when editing files with the RTE

Parameters:
string The relative path from PATH_site to the place where the file being edited is. Eg. "fileadmin/static".
Returns:
void There is no output, it is set in internal variables. With the above example of "fileadmin/static" as input this will yield ->relPath to be "fileadmin/static/" and ->relBackPath to be "../../"

Definition at line 150 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::siteUrl (   ) 
 

Returns SiteURL based on thisScript.

Returns:
string Value of t3lib_div::getIndpEnv('TYPO3_SITE_URL');
See also:
t3lib_div::getIndpEnv()

Definition at line 1387 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::getIndpEnv().

t3lib_parsehtml_proc::transformStyledATags (  $  value  ) 
 

Wraps a-tags that contain a style attribute with a span-tag

Parameters:
string Content input
Returns:
string Content output

Definition at line 922 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_AtagToAbs (  $  value,
$  dontSetRTEKEEP = FALSE
) 
 

Converting -tags to absolute URLs (+ setting rtekeep attribute)

Parameters:
string Content input
boolean If true, then the "rtekeep" attribute will not be set.
Returns:
string Content output

Definition at line 1550 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_images_db (  $  value  ) 
 

Transformation handler: 'ts_images' / direction: "db" Processing images inserted in the RTE. This is used when content goes from the RTE to the database. Images inserted in the RTE has an absolute URL applied to the src attribute. This URL is converted to a relative URL If it turns out that the URL is from another website than the current the image is read from that external URL and moved to the local server. Also "magic" images are processed here.

Parameters:
string The content from RTE going to Database
Returns:
string Processed content

Definition at line 398 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::getFileAbsFileName(), t3lib_div::getIndpEnv(), t3lib_div::implodeAttributes(), t3lib_div::inList(), t3lib_div::isFirstPartOfStr(), t3lib_div::makeInstance(), t3lib_div::shortMD5(), and t3lib_div::writeFile().

t3lib_parsehtml_proc::TS_images_rte (  $  value  ) 
 

Transformation handler: 'ts_images' / direction: "rte" Processing images from database content going into the RTE. Processing includes converting the src attribute to an absolute URL.

Parameters:
string Content input
Returns:
string Content output

Definition at line 550 of file class.t3lib_parsehtml_proc.php.

References t3lib_div::getIndpEnv(), and t3lib_div::implodeAttributes().

t3lib_parsehtml_proc::TS_links_db (  $  value  ) 
 

Transformation handler: 'ts_links' / direction: "db" Converting -tags to <link tags>="">

Parameters:
string Content input
Returns:
string Content output
See also:
TS_links_rte()

Definition at line 626 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_links_rte (  $  value  ) 
 

Transformation handler: 'ts_links' / direction: "rte" Converting <link tags>=""> to -tags

Parameters:
string Content input
Returns:
string Content output
See also:
TS_links_rte()

Definition at line 675 of file class.t3lib_parsehtml_proc.php.

References t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordsByField(), t3lib_div::inList(), t3lib_div::testInt(), t3lib_div::trimExplode(), and t3lib_div::unQuoteFilenames().

t3lib_parsehtml_proc::TS_preserve_db (  $  value  ) 
 

Preserve special tags

Parameters:
string Content input
Returns:
string Content output

Definition at line 760 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_preserve_rte (  $  value  ) 
 

Preserve special tags

Parameters:
string Content input
Returns:
string Content output

Definition at line 784 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_reglinks (  $  value,
$  direction
) 
 

Transformation handler: 'ts_reglinks' / direction: "db"+"rte" depending on $direction variable. Converting -tags to/from abs/rel

Parameters:
string Content input
string Direction of conversion; "rte" (from database to RTE) or "db" (from RTE to database)
Returns:
string Content output

Definition at line 589 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_strip_db (  $  value  ) 
 

Transformation handler: 'ts_strip' / direction: "db" Removing all non-allowed tags

Parameters:
string Content input
Returns:
string Content output

Definition at line 1019 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_transform_db (  $  value,
$  css = FALSE
) 
 

Transformation handler: 'ts_transform' + 'css_transform' / direction: "db" Cleaning (->db) for standard content elements (ts)

Parameters:
string Content input
boolean If true, the transformation was "css_transform", otherwise "ts_transform"
Returns:
string Content output
See also:
TS_transform_rte()

Definition at line 805 of file class.t3lib_parsehtml_proc.php.

t3lib_parsehtml_proc::TS_transform_rte (  $  value,
$  css = 0
) 
 

Transformation handler: 'ts_transform' + 'css_transform' / direction: "rte" Set (->rte) for standard content elements (ts)

Parameters:
string Content input
boolean If true, the transformation was "css_transform", otherwise "ts_transform"
Returns:
string Content output
See also:
TS_transform_db()

Definition at line 948 of file class.t3lib_parsehtml_proc.php.

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

t3lib_parsehtml_proc::urlInfoForLinkTags (  $  url  ) 
 

Parse -tag href and return status of email,external,file or page

Parameters:
string URL to analyse.
Returns:
array Information in an array about the URL

Definition at line 1491 of file class.t3lib_parsehtml_proc.php.

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