Documentation TYPO3 par Ameos |
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 | |
Definition at line 123 of file plaintextLib.inc.
| 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.
| string | Empty, ignore. | |
| array | TypoScript properties for this content object/function call |
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::getMenuSitemap | ( | ) |
Creates a menu/sitemap
Definition at line 209 of file plaintextLib.inc.
References breakBulletlist(), and parseBody().
Referenced by main_plaintext().
| user_plaintext::getShortcut | ( | ) |
Creates a shortcut ("Insert Records")
Definition at line 220 of file plaintextLib.inc.
Referenced by main_plaintext().
| user_plaintext::getHTML | ( | $ | str = array() |
) |
Creates an HTML element (stripping tags of course)
| string | HTML content to process. If not passed along, the bodytext field is used. |
Definition at line 231 of file plaintextLib.inc.
References breakContent(), and parseBody().
Referenced by main_plaintext().
| user_plaintext::getHeader | ( | ) |
Creates a header (used for most elements)
Definition at line 241 of file plaintextLib.inc.
References renderHeader().
Referenced by main_plaintext(), and typohead().
| user_plaintext::getImages | ( | ) |
Get images found in the "image" field of "tt_content"
Definition at line 251 of file plaintextLib.inc.
References renderImages().
Referenced by main_plaintext().
| user_plaintext::parseBody | ( | $ | str | ) |
Parsing the bodytext field content, removing typical entities and
tags.
| string | Field content from "bodytext" |
Definition at line 262 of file plaintextLib.inc.
References t3lib_div::htmlspecialchars_decode().
Referenced by getHTML(), getMenuSitemap(), and main_plaintext().
| user_plaintext::renderUploads | ( | $ | str, | |
| $ | upload_path = 'uploads/media/' | |||
| ) |
Creates a list of links to uploaded files.
| string | List of uploaded filenames from "uploads/media/" (or $upload_path) | |
| string | Alternative path value |
Definition at line 284 of file plaintextLib.inc.
References getString().
Referenced by main_plaintext().
| user_plaintext::renderHeader | ( | $ | str, | |
| $ | type = 0 | |||
| ) |
Renders a content element header, observing the layout type giving different header formattings
| string | The header string | |
| integer | The layout type of the header (in the content element) |
Definition at line 302 of file plaintextLib.inc.
References getString(), t3lib_div::intInRange(), and pad().
Referenced by getHeader().
| user_plaintext::pad | ( | $ | lines, | |
| $ | preLineChar, | |||
| $ | len | |||
| ) |
Function used to repeat a char pattern in head lines (like if you want "********" above/below a header)
| 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. |
Definition at line 355 of file plaintextLib.inc.
References t3lib_div::intInRange().
Referenced by renderHeader().
| user_plaintext::breakContent | ( | $ | str | ) |
Function used to wrap the bodytext field content (or image caption) into lines of a max length of
| string | The content to break |
Definition at line 371 of file plaintextLib.inc.
References breakLines().
Referenced by getHTML(), main_plaintext(), and renderImages().
| user_plaintext::breakBulletlist | ( | $ | str | ) |
Breaks content lines into a bullet list
| string | Content string to make into a bullet list |
Definition at line 387 of file plaintextLib.inc.
References getString(), and t3lib_div::intInRange().
Referenced by getMenuSitemap(), main_plaintext(), and typolist().
| user_plaintext::breakTable | ( | $ | str | ) |
Formatting a table in plain text (based on the paradigm of lines being content rows and cells separated by "|")
| string | Content string |
Definition at line 418 of file plaintextLib.inc.
References addDiv(), breakLines(), and traverseTable().
Referenced by main_plaintext().
| user_plaintext::addDiv | ( | $ | messure, | |
| $ | content, | |||
| $ | divChar, | |||
| $ | joinChar, | |||
| $ | cols | |||
| ) |
Subfunction for breakTable(): Adds a divider line between table rows.
| 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 |
Definition at line 474 of file plaintextLib.inc.
Referenced by breakTable().
| user_plaintext::traverseTable | ( | $ | tableLines | ) |
Traverses the table lines/cells and creates arrays with statistics for line numbers and lengths
| array | Array with [table rows] [table cells] [lines in cell] |
Definition at line 490 of file plaintextLib.inc.
Referenced by breakTable().
| user_plaintext::renderImages | ( | $ | str, | |
| $ | links, | |||
| $ | caption, | |||
| $ | upload_path = 'uploads/pics/' | |||
| ) |
Render block of images - which means creating lines with links to the images.
| 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 |
Definition at line 517 of file plaintextLib.inc.
References breakContent(), getLink(), and getString().
Referenced by getImages().
| user_plaintext::getLink | ( | $ | ll | ) |
Returns a typolink URL based on input.
| string | Parameter to typolink |
Definition at line 556 of file plaintextLib.inc.
Referenced by renderImages().
| user_plaintext::breakLines | ( | $ | str, | |
| $ | implChar = "\n", |
|||
| $ | charWidth = 0 | |||
| ) |
Breaking lines into fixed length lines, using t3lib_div::breakLinesForEmail()
| string | The string to break | |
| string | Line break character | |
| integer | Length of lines, default is $this->charWidth |
Definition at line 573 of file plaintextLib.inc.
References $charWidth, and t3lib_div::breakLinesForEmail().
Referenced by breakContent(), and breakTable().
| 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.
| string | Input string |
Definition at line 585 of file plaintextLib.inc.
Referenced by breakBulletlist(), main_plaintext(), renderHeader(), renderImages(), and renderUploads().
| user_plaintext::userProcess | ( | $ | mConfKey, | |
| $ | passVar | |||
| ) |
Calls a user function for processing of data
| 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 |
Definition at line 597 of file plaintextLib.inc.
Referenced by main_plaintext().
| 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.
| string | Empty, ignore. | |
| array | TypoScript parameters |
Definition at line 615 of file plaintextLib.inc.
References $conf.
| user_plaintext::typolist | ( | $ | content, | |
| $ | conf | |||
| ) |
User function (called from TypoScript) for generating a bullet list (used in parsefunc)
| string | Empty, ignore. | |
| array | TypoScript parameters |
Definition at line 634 of file plaintextLib.inc.
References $conf, and breakBulletlist().
| user_plaintext::typohead | ( | $ | content, | |
| $ | conf | |||
| ) |
User function (called from TypoScript) for generating a typo header tag (used in parsefunc)
| string | Empty, ignore. | |
| array | TypoScript parameters |
Definition at line 649 of file plaintextLib.inc.
References $conf, and getHeader().
| user_plaintext::typocode | ( | $ | content, | |
| $ | conf | |||
| ) |
User function (called from TypoScript) for generating a code listing (used in parsefunc)
| string | Empty, ignore. | |
| array | TypoScript parameters |
Definition at line 668 of file plaintextLib.inc.
References $conf.
1.4.6