File Source for PlainTextFormatter.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package core
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
*
*/
include_once( CLASSPATH."core/Strings.class.php" );
/**
*
*/
include_once( CLASSPATH."RegExpConstants.inc.php" );
/**
* @static
* @package core
* @version 0.2.32
*
* @author Daniel Plücken <daniel@debakel.net>
*
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2003 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class PlainTextFormatter extends ABSTObject
{
/**
* @var integer
* @access public
*/
var $indent = 5;
/**
* @var integer
* @access public
*/
var $maxChars = 70;
/**
* Breaks a line after $maxChars characters if no word will be cut else
* earlier and indent the line for $indent chars
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $text The string which should be modified.
* @param integer $max_chars The maximum of characters that should be in a
line.
* @param integer $indent The indent of all lines.
* @return string
*/
function breakBy( $text, $max_chars = 0, $indent = 0 )
{
$param = func_get_args();
$max_chars = $max_chars > 10
? $max_chars
: $this->maxChars;
$text = Strings::reduceWhiteSpace( $text );
if( $max_chars >= strlen( $text ) )
$out = $text;
else
{
$rowChars = isset( $indent )
? abs( intval( $indent ) ) - 1
: -1;
$switchChar = "";
$out = $indent > 0 ? str_repeat( " ", $indent ) : "";
$dobr = true;
while( $pos = strpos( $text, " " ) )
{
$tmplen = $switchChar == " "
? 1 : 0;
$rowChars += $pos + $tmplen;
$posN = strpos( $text, "\n" );
$text_piece = substr( $text, 0, $pos );
if(
$rowChars >= $max_chars
&& ( $posN > $pos
|| $posN === false )
&& $dobr
)
$switchChar = " \n";
else
$switchChar = " ";
$out .= $switchChar.$text_piece;
if(
$posN < $pos
&& $posN !== false
)
$rowChars = ( $pos - $posN - 1 );
if( $switchChar == " \n" )
$rowChars = $pos;
$text = substr( $text, $pos + 1 );
}
$out .= $switchChar.$text;
}
return trim( $out );
}
/**
* Adds $indent spaces in front of each line.
*
* @version 1.0
* @since 0.1.1
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $text The string which should be modified.
* @param integer $maxChars The maximum of characters that should be in a
line.
* @param integer $indent The indent of all lines.
* @return string
*/
function indentText( $text = "", $indent = 0 )
{
if( empty( $indent ) )
$indent = $this->indent;
$str_indent = str_repeat( " ", $indent );
$doindent = true;
$out = "";
$tok_mem = " ";
$tok = strtok( $text, "\n" );
while( $tok )
{
// except textareas
if( preg_match( "!.*</textarea>.*!i", $tok_mem ) )
$doindent = true;
$doindent = $doindent
&& !preg_match( "!.*<textarea.*!i", $tok_mem );
// except textareas */
if( $doindent )
$out .= $str_indent.$tok."\n";
else
$out .= $tok."\n";
$tok_mem = $tok;
$tok = strtok( "\n" );
}
return $out;
}
/**
* Adds $indent spaces in front of each line from given string and breaks
* after characters count stored in the class variable $maxChars, but only
* if no word will be break (then the break will be earlier; before the
* word).
*
* @version 1.0
* @since 0.1.1
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $text The string which should be modified.
* @param integer $indent The indent of all lines.
* @param integer $max_chars The maximum of characters that should
* be in a line.
* @param integer $first_line_begin The negative indent of the first line.
* @return string
*/
function format(
$text,
$indent = 0,
$max_chars = 70,
$first_line_begin = 0
)
{
$text = Strings::reduceWhiteSpace( $text );
if(
!empty( $first_line_begin )
&& $first_line_begin > 0
)
$firstlineBegin = $first_line_begin;
else
$firstlineBegin = 0;
$indent = !empty( $indent )
? $indent
: $this->indent;
$maxChars = !empty( $max_chars )
? $max_chars
: $this->maxChars;
$showChars = $maxChars - $indent;
$out = PlainTextFormatter
::indentText(
PlainTextFormatter
::breakBy(
$text,
$showChars,
$firstlineBegin
),
$indent
);
if(
!empty( $first_line_begin )
&& $first_line_begin < 0
)
$out = substr( $out, ( $first_line_begin * -1 ) );
return $out;
}
/**
* Cuts the given text that the length is not longer than $max_chars
* characters. The last three characters will be "...".
*
* @version 1.1
* @since 0.1.1
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $text The string which should be modified.
* @return string
*/
function maxchars( $text, $max_chars )
{
$inputstr = empty( $text ) ? "" : $text;
$maxChars = empty( $max_chars ) ? 15 : $max_chars;
$out = ( strlen( $inputstr ) + 3 > $maxChars )
? substr( $inputstr, 0, $maxChars - 3 )."..."
: $inputstr;
return $out;
}
/**
* Replaces special characters to entities. This is very useful for embed
* HTML in XML.
*
* @version 1.0
* @since 0.1.6
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $text The string which should be modified.
* @return string
*/
function makeXMLEmbedded( $text )
{
$outputString = str_replace( "\"", """, $text );
$outputString = str_replace( "'", "′", $outputString );
$outputString = str_replace( "<", "<", $outputString );
$outputString = str_replace( ">", ">", $outputString );
return $outputString;
}
/**
* Replaces entities to special characters. This is very useful for handle
* HTML embedded in XML.
*
* @version 1.0
* @since 0.1.6
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $text The string which should be modified.
* @return string
*/
function extractXMLEmbedded( $text )
{
$outputString = str_replace( """, "\"", $text );
$outputString = str_replace( "′", "'", $outputString );
$outputString = str_replace( "<", "<", $outputString );
$outputString = str_replace( ">", ">", $outputString );
return $outputString;
}
/**
* Formats sql querys.
*
* @version 1.11
* @since 0.2.2
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $str_in The string which should be modified.
* @return string
*/
function formatSQL( $str_in )
{
$out = preg_replace(
"!^\s*(SELECT|INSERT|UPDATE)\s+!is",
" $1 ", $str_in
);
$str_fieldname_pattern = "(?:`[^`]+?`|[^- .+`;'=\\\\()*]+?)";
if ( preg_match( "!^ SELECT!i", $out ) )
{
$fields_of_select = preg_replace(
"!^ SELECT (.+?)FROM.+!is",
"$1", $out
);
$fields_of_select = preg_replace(
"!((?:(?:DISTINCT\s+)?[-_a-z0-9]*\.?".$str_fieldname_pattern."|".SINGLE_QUOTATION_STRING.")(?:\s+AS\s+".$str_fieldname_pattern.")?\s*,)\s*!is",
"$1\r\n ",
$fields_of_select
);
$tables_of_select = preg_replace(
"!^ SELECT (?:.+?)FROM(.+?)(?:LEFT\s+JOIN|RIGHT\s+JOIN|NATURAL\s+JOIN|WHERE|ORDER\s+BY|GROUP\s+BY).*!is",
"$1", $out
);
$tables_of_select = preg_replace(
"!((?:[-_a-z0-9]*\.?".$str_fieldname_pattern."|".SINGLE_QUOTATION_STRING.")(?:\s+AS\s+".$str_fieldname_pattern.")?\s*,)\s*!is",
"$1\r\n ",
$tables_of_select
);
$out = preg_replace(
"!^ SELECT (?:.+?)FROM(?:.+?)(LEFT\s+JOIN|RIGHT\s+JOIN|NATURAL\s+JOIN|WHERE|ORDER\s+BY|GROUP\s+BY)!is",
" SELECT ".$fields_of_select."\r\n"
." FROM ".$tables_of_select."$1", $out
);
}
$out = preg_replace( "!^\s*REPLACE +!is", " REPLACE ", $out );
$out = preg_replace(
"#\s+(?<!LEFT|RIGHT|NATURAL)\s+JOIN +#is",
" \r\n JOIN ", $out
);
$out = preg_replace( "!\s+LEFT\s+JOIN +!is", " \r\n LEFT JOIN ", $out );
$out = preg_replace( "!\s+RIGHT\s+JOIN +!is", " \r\n RIGHT JOIN ", $out );
$out = preg_replace( "!\s+NATURAL\s+JOIN +!is", " \r\nNATURAL JOIN ", $out );
$out = preg_replace( "!\s+FROM +!is", " \r\n FROM ", $out );
$out = preg_replace( "!\s+(OR|ON) +!is", " \r\n $1 ", $out );
$out = preg_replace( "!\s+AND +!is", " \r\n AND ", $out );
$out = preg_replace( "!\s+WHERE +!is", " \r\n WHERE ", $out );
$out = preg_replace( "!\s+AS\s+!is", " AS ", $out );
$out = preg_replace( "!\s+(ORDER\s+BY|GROUP\s+BY) +!is", " \r\n $1 ", $out );
return $out;
}
/**
* Replaces character in that kind, that only html-character remain.
*
* @version 1.1
* @since 0.1.3
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $inputstr The string which should be modified.
* @return string
*/
function text2HTML( $inputstr )
{
$out = htmlentities( $inputstr );
$out = str_replace( "\r\n", "<br />", $out );
$out = str_replace( "\r", "<br />", $out );
$out = str_replace( "\n", "<br />", $out );
return $out;
}
/**
* Replaces character in that kind, that only ascii-character remain.
*
* @version 1.0
* @since 0.1.2
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $inputstr The string which should be modified.
* @return string
*/
function Plaintext2ASCII( $inputstr )
{
$out = $inputstr;
if( !empty( $out ) )
{
$out = str_replace( "\xE4", "ae", $out );
$out = str_replace( "\xF6", "oe", $out );
$out = str_replace( "\xFC", "ue", $out );
$out = str_replace( "\xC4", "Ae", $out );
$out = str_replace( "\xD6", "Oe", $out );
$out = str_replace( "\xDC", "Ue", $out );
$out = str_replace( "\xDF", "ss", $out );
}
return $out;
}
/**
* Replaces each in series appearing whitespaces inside a textarea to only
* one whitespace.
*
* @version 1.0
* @since 0.1.3
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @static
* @param string $string The string which should be modified.
* @return string
*/
function reduceWhiteSpaceOfTextAreas( $string )
{
$outputstr = $string;
$outputstr = preg_replace(
"!<textarea(.*?)>!i",
"<textarea$1>[-#BEGIN#-]",
$outputstr
);
$outputstr = preg_replace(
"!</textarea>!i",
"[-#END#-]</textarea>",
$outputstr
);
$pos_begin = 0;
while( $pos_begin = strpos( $outputstr, "[-#BEGIN#-]", $pos_begin ) )
{
$pos_end = strpos( $outputstr, "[-#END#-]", $pos_begin );
$tmp_str = substr(
$outputstr,
$pos_begin + 11,
$pos_end - $pos_begin - 11
);
$tmp_rep_str = trim( $tmp_str );
$tmp_rep_str = preg_replace( "! +!", " ", $tmp_rep_str );
$tmp_rep_str = str_replace( "\r\n", "\n", $tmp_rep_str );
$tmp_rep_str = str_replace( "\r" , "\n", $tmp_rep_str );
$tmp_rep_str = str_replace( "\n " , "\n", $tmp_rep_str );
$outputstr = str_replace(
"[-#BEGIN#-]".$tmp_str."[-#END#-]",
$tmp_rep_str,
$outputstr
);
}
return $outputstr;
}
/**
* Sets the indent of all lines of a string if the function "breakBy",
* "format" or "blockqoutePlainText" is used and no indent is given by
* parameter.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param integer $int
*/
function setIndent( $int )
{ $this->indent = $int; }
/**
* Sets the maximum of characters that should be in a line if the function
* "breakBy", "format" or "blockqoutePlainText" is used and no indent is
* given by parameter.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param integer $int
*/
function setMaxChars( $int )
{ $this->maxChars = $int; }
} // End of class PlainTextFormatter
?>

Source for file PlainTextFormatter.class.php