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

user_plaintext Class Reference

List of all members.

Public Member Functions

 main_plaintext ($content, $conf)
 getMenuSitemap ()
 getShortcut ()
 getHTML ($str=array())
 getHeader ()
 getImages ()
 parseBody ($str)
 renderUploads ($str, $upload_path='uploads/media/')
 renderHeader ($str, $type=0)
 pad ($lines, $preLineChar, $len)
 breakContent ($str)
 breakBulletlist ($str)
 breakTable ($str)
 addDiv ($messure, $content, $divChar, $joinChar, $cols)
 traverseTable ($tableLines)
 renderImages ($str, $links, $caption, $upload_path='uploads/pics/')
 getLink ($ll)
 breakLines ($str, $implChar="\n", $charWidth=0)
 getString ($str)
 userProcess ($mConfKey, $passVar)
 atag_to_http ($content, $conf)
 typolist ($content, $conf)
 typohead ($content, $conf)
 typocode ($content, $conf)

Public Attributes

 $cObj
 $conf = array()
 $charWidth = 76

Detailed Description

Definition at line 123 of file plaintextLib.inc.

Member Function Documentation

user_plaintext::addDiv (  $  messure,
$  content,
$  divChar,
$  joinChar,
$  cols
) 
 

Subfunction for breakTable(): Adds a divider line between table rows.

Parameters:
array Some information about sizes
string Empty string.
string Character to use for the divider line, typically "-"
string Join character, typically "+"
integer Number of table columns
Returns:
string Divider line for the table private
See also:
breakTable()

Definition at line 472 of file plaintextLib.inc.

user_plaintext::atag_to_http (  $  content,
$  conf
) 
 

Function used by TypoScript "parseFunc" to process links in the bodytext. Extracts the link and shows it in plain text in a parathesis next to the link text. If link was relative the site URL was prepended.

Parameters:
string Empty, ignore.
array TypoScript parameters
Returns:
string Processed output.
See also:
parseBody()

Definition at line 613 of file plaintextLib.inc.

user_plaintext::breakBulletlist (  $  str  ) 
 

Breaks content lines into a bullet list

Parameters:
string Content string to make into a bullet list
Returns:
string Processed value

Definition at line 385 of file plaintextLib.inc.

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

Referenced by getMenuSitemap(), and main_plaintext().

user_plaintext::breakContent (  $  str  ) 
 

Function used to wrap the bodytext field content (or image caption) into lines of a max length of

Parameters:
string The content to break
Returns:
string Processed value.
See also:
main_plaintext(), breakLines()

Definition at line 369 of file plaintextLib.inc.

References breakLines().

Referenced by getHTML(), and main_plaintext().

user_plaintext::breakLines (  $  str,
$  implChar = "\n",
$  charWidth = 0
) 
 

Breaking lines into fixed length lines, using t3lib_div::breakLinesForEmail()

Parameters:
string The string to break
string Line break character
integer Length of lines, default is $this->charWidth
Returns:
string Processed string
See also:
t3lib_div::breakLinesForEmail()

Definition at line 571 of file plaintextLib.inc.

References t3lib_div::breakLinesForEmail().

Referenced by breakContent(), and breakTable().

user_plaintext::breakTable (  $  str  ) 
 

Formatting a table in plain text (based on the paradigm of lines being content rows and cells separated by "|")

Parameters:
string Content string
Returns:
string Processed value

Definition at line 416 of file plaintextLib.inc.

References breakLines().

Referenced by main_plaintext().

user_plaintext::getHeader (   ) 
 

Creates a header (used for most elements)

Returns:
string Content
See also:
renderHeader()

Definition at line 241 of file plaintextLib.inc.

References renderHeader().

Referenced by main_plaintext().

user_plaintext::getHTML (  $  str = array()  ) 
 

Creates an HTML element (stripping tags of course)

Parameters:
string HTML content to process. If not passed along, the bodytext field is used.
Returns:
string Content

Definition at line 231 of file plaintextLib.inc.

References breakContent(), and parseBody().

Referenced by main_plaintext().

user_plaintext::getImages (   ) 
 

Get images found in the "image" field of "tt_content"

Returns:
string Content

Definition at line 251 of file plaintextLib.inc.

References renderImages().

Referenced by main_plaintext().

user_plaintext::getLink (  $  ll  ) 
 

Returns a typolink URL based on input.

Parameters:
string Parameter to typolink
Returns:
string The URL returned from $this->cObj->getTypoLink_URL(); - possibly it prefixed with the URL of the site if not present already

Definition at line 554 of file plaintextLib.inc.

user_plaintext::getMenuSitemap (   ) 
 

Creates a menu/sitemap

Returns:
string Content

Definition at line 209 of file plaintextLib.inc.

References breakBulletlist(), and parseBody().

Referenced by main_plaintext().

user_plaintext::getShortcut (   ) 
 

Creates a shortcut ("Insert Records")

Returns:
string Content

Definition at line 220 of file plaintextLib.inc.

Referenced by main_plaintext().

user_plaintext::getString (  $  str  ) 
 

Explodes a string with "|" and if the second part is found it will return this, otherwise the first part. Used for many TypoScript properties used in this class since they need preceeding whitespace to be preserved.

Parameters:
string Input string
Returns:
string Output string private

Definition at line 583 of file plaintextLib.inc.

Referenced by breakBulletlist(), main_plaintext(), renderHeader(), and renderUploads().

user_plaintext::main_plaintext (  $  content,
$  conf
) 
 

Main function, called from TypoScript A content object that renders "tt_content" records. See the comment to this class for TypoScript example of how to trigger it. This detects the CType of the current content element and renders it accordingly. Only wellknown types are rendered.

Parameters:
string Empty, ignore.
array TypoScript properties for this content object/function call
Returns:
string Plain text content

Definition at line 137 of file plaintextLib.inc.

References $conf, breakBulletlist(), breakContent(), breakTable(), getHeader(), getHTML(), getImages(), getMenuSitemap(), getShortcut(), getString(), parseBody(), renderUploads(), and userProcess().

user_plaintext::pad (  $  lines,
$  preLineChar,
$  len
) 
 

Function used to repeat a char pattern in head lines (like if you want "********" above/below a header)

Parameters:
array Array of existing lines to which the new char-pattern should be added
string The character pattern to repeat. Default is "-"
integer The length of the line. $preLineChar will be repeated to fill in this length.
Returns:
array The input array with a new line added.
See also:
renderHeader()

Definition at line 353 of file plaintextLib.inc.

References t3lib_div::intInRange().

Referenced by renderHeader().

user_plaintext::parseBody (  $  str  ) 
 

Parsing the bodytext field content, removing typical entities and
tags.

Parameters:
string Field content from "bodytext"
Returns:
string Processed content

Definition at line 262 of file plaintextLib.inc.

References t3lib_div::htmlspecialchars_decode().

Referenced by getHTML(), getMenuSitemap(), and main_plaintext().

user_plaintext::renderHeader (  $  str,
$  type = 0
) 
 

Renders a content element header, observing the layout type giving different header formattings

Parameters:
string The header string
integer The layout type of the header (in the content element)
Returns:
string Content

Definition at line 302 of file plaintextLib.inc.

References getString(), t3lib_div::intInRange(), and pad().

Referenced by getHeader().

user_plaintext::renderImages (  $  str,
$  links,
$  caption,
$  upload_path = 'uploads/pics/'
) 
 

Render block of images - which means creating lines with links to the images.

Parameters:
string List of image filenames (from "image" field in tt_content records)
string Link value from the "image_link" field in tt_content records
string Caption text
string Alternative relative path for the files listed in $str
Returns:
string Content
See also:
getImages()

Definition at line 515 of file plaintextLib.inc.

Referenced by getImages().

user_plaintext::renderUploads (  $  str,
$  upload_path = 'uploads/media/'
) 
 

Creates a list of links to uploaded files.

Parameters:
string List of uploaded filenames from "uploads/media/" (or $upload_path)
string Alternative path value
Returns:
string Content

Definition at line 284 of file plaintextLib.inc.

References getString().

Referenced by main_plaintext().

user_plaintext::traverseTable (  $  tableLines  ) 
 

Traverses the table lines/cells and creates arrays with statistics for line numbers and lengths

Parameters:
array Array with [table rows] [table cells] [lines in cell]
Returns:
array Statistics (max lines/lengths) private
See also:
breakTable()

Definition at line 488 of file plaintextLib.inc.

user_plaintext::typocode (  $  content,
$  conf
) 
 

User function (called from TypoScript) for generating a code listing (used in parsefunc)

Parameters:
string Empty, ignore.
array TypoScript parameters
Returns:
string Processed output.

Definition at line 666 of file plaintextLib.inc.

user_plaintext::typohead (  $  content,
$  conf
) 
 

User function (called from TypoScript) for generating a typo header tag (used in parsefunc)

Parameters:
string Empty, ignore.
array TypoScript parameters
Returns:
string Processed output.

Definition at line 647 of file plaintextLib.inc.

user_plaintext::typolist (  $  content,
$  conf
) 
 

User function (called from TypoScript) for generating a bullet list (used in parsefunc)

Parameters:
string Empty, ignore.
array TypoScript parameters
Returns:
string Processed output.

Definition at line 632 of file plaintextLib.inc.

user_plaintext::userProcess (  $  mConfKey,
$  passVar
) 
 

Calls a user function for processing of data

Parameters:
string TypoScript property name, pointing to the definition of the user function to call (from the TypoScript array internally in this class). This array is passed to the user function. Notice that "parentObj" property is a reference to this class ($this)
mixed Variable to process
Returns:
mixed The processed $passVar as returned by the function call

Definition at line 595 of file plaintextLib.inc.

Referenced by main_plaintext().

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