Class Dwoo_Plugin_textformat

Description

Formats a string to the given format, you can wrap lines at a certain

length and indent them

  * wrap : maximum line length
  * wrap_char : the character(s) to use to break the line
  * wrap_cut : if true, the words that are longer than $wrap are cut instead of overflowing
  * indent : amount of $indent_char to insert before every line
  * indent_char : character(s) to insert before every line
  * indent_first : amount of additional $indent_char to insert before the first line of each paragraphs
  * style : some predefined formatting styles that set up every required variables, can be "email" or "html"
  * assign : if set, the formatted text is assigned to that variable instead of being output
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

This file is released under the LGPL "GNU Lesser General Public License" More information can be found here: http://www.gnu.org/copyleft/lesser.html

Located in /plugins/builtin/blocks/textformat.php (line 32)

Dwoo_Plugin
   |
   --Dwoo_Block_Plugin
      |
      --Dwoo_Plugin_textformat
Variable Summary
mixed $assign
mixed $indChar
mixed $indent
mixed $indFirst
mixed $wrap
mixed $wrapChar
mixed $wrapCut
Method Summary
void init ([ $wrap = 80], [ $wrap_char = "\r\n"], [ $wrap_cut = false], [ $indent = 0], [ $indent_char = " "], [ $indent_first = 0], [ $style = ""], [ $assign = ""])
void process ()
Variables
mixed $assign (line 40)
  • access: protected
mixed $indChar (line 38)
  • access: protected
mixed $indent (line 37)
  • access: protected
mixed $indFirst (line 39)
  • access: protected
mixed $wrap (line 34)
  • access: protected
mixed $wrapChar (line 35)
  • access: protected
mixed $wrapCut (line 36)
  • access: protected

Inherited Variables

Inherited from Dwoo_Block_Plugin

Dwoo_Block_Plugin::$buffer

Inherited from Dwoo_Plugin

Dwoo_Plugin::$dwoo
Methods
init (line 42)
  • access: public
void init ([ $wrap = 80], [ $wrap_char = "\r\n"], [ $wrap_cut = false], [ $indent = 0], [ $indent_char = " "], [ $indent_first = 0], [ $style = ""], [ $assign = ""])
  • $wrap
  • $wrap_char
  • $wrap_cut
  • $indent
  • $indent_char
  • $indent_first
  • $style
  • $assign
process (line 70)
  • access: public
void process ()

Redefinition of:
Dwoo_Block_Plugin::process()
called when the block output is required by a parent block

Inherited Methods

Inherited From Dwoo_Block_Plugin

Dwoo_Block_Plugin::buffer()
Dwoo_Block_Plugin::end()
Dwoo_Block_Plugin::postProcessing()
Dwoo_Block_Plugin::preProcessing()
Dwoo_Block_Plugin::process()

Inherited From Dwoo_Plugin

Dwoo_Plugin::__construct()
Dwoo_Plugin::paramsToAttributes()

Documentation generated on Sun, 03 Aug 2008 15:12:47 +0200 by phpDocumentor 1.4.0