File Source for Strings.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();
}
/**
* Loading the class to manipulate arrays.
*/
include_once( CLASSPATH."core/Arrays.class.php" );
/**
* Static methods
*
* @static
* @package core
* @version 0.1.96
*
* @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 Strings extends ABSTObject
{
/**
* Functions like strpos( string haystack, string needle [, int offset] ),
* but you can use a regular expression as needle.
* BEWARE: lookahead, lookbehind and all chars itentified by their position
* will NOT function, because of the intern relay to the function
* strpos!
*
* @version 1.0
* @since 0.1.0
* @access public
*
* @static
*
* @param string $haystack
* @param string $needle
* @param string $offset
*
* @return integer
*/
function pregpos( $haystack, $needle, $offset = 0 )
{
$haystack = substr( $haystack, $offset );
$tmp_match_arr = array();
if ( preg_match( $needle, $haystack, $tmp_match_arr ) )
$pos = strpos( $haystack, $tmp_match_arr[0] );
else
return false;
return $offset + $pos;
}
/**
* Make a string uppercase atleast for ISO-8859-1 (Latin 1) full with all
* special characters.
*
* @version 1.0
* @since 0.1.95
* @access public
* @see http://www.php.net/manual/en/function.strtoupper.php#78498
*
* @static
*
* @param string $str
*
* @return string
*/
function strToUpper( $str )
{
// convert to entities
$subject = htmlentities( $str, ENT_QUOTES );
$pattern = '/&([a-z])(uml|acute|circ';
$pattern .= '|tilde|ring|elig|grave|slash|horn|cedil|th);/e';
$replace = "'&'.strtoupper('\\1').'\\2'.';'";
$result = preg_replace( $pattern, $replace, $subject );
// convert from entities back to characters
$htmltable = get_html_translation_table( HTML_ENTITIES );
foreach ( $htmltable as $key => $value )
{ $result = ereg_replace( addslashes( $value ), $key, $result ); }
return strtoupper( $result );
}
/**
* Replaces substrings in string by the matching keys of an array to the
* value of that key.
*
* Example:
* <code>
* $str = listReplace(
* array(
* "ü" => "ue",
* "aniel" => "."
* ),
* "Daniel Plücken"
* );
*
* echo $str;
* </code>
*
* Puts out "D. Pluecken".
*
* @version 1.0
* @since 0.1.9
* @access public
*
* @static
*
* @param array $array The array that holds the replace list.
* @param string $string The string which should be modified.
* @return string
*/
function listReplace( $array, $string )
{
$str_out = $string;
foreach ( $array as $key => $value )
$str_out = str_replace( $key, $value, $str_out );
return $str_out;
}
/**
* Escapes all line breaks in a string with \.
*
* @version 1.0
* @since 0.1.8
* @access public
*
* @static
*
* @param string $text The string which should be modified.
*
* @return string
*/
function escapeLineBreaks( $text )
{
$text = str_replace( "\r" , "\\r", $text );
$text = str_replace( "\n" , "\\n", $text );
return $text;
}
/**
* Removes all line breaks in a string.
*
* @version 1.0
* @since 0.1.0
* @access public
*
* @static
*
* @param string $text The string which should be modified.
*
* @return string
*/
function removeLineBreaks( $text )
{
$text = str_replace( "\r" , "", $text );
$text = str_replace( "\n" , "", $text );
return $text;
}
/**
* Removes all white spaces including tabs and line breaks in a string.
*
* @version 1.0
* @since 0.1.0
* @access public
*
* @static
*
* @param string $text The string which should be modified.
*
* @return string
*/
function removeWhiteSpace( $text )
{
$text = str_replace( "\t", "", $text );
$text = str_replace( "\r", "", $text );
$text = str_replace( "\n", "", $text );
$text = preg_replace( "! +!" , "", $text );
return trim( $text );
}
/**
* Reduces in series lying spaces to only one space. Also all spaces at the
* beginning of a line will be removed.
*
* @version 1.1
* @since 0.1.0
* @access public
*
* @static
*
* @param string $text The string which should be modified.
*
* @return string
*/
function reduceWhiteSpace( $text )
{
$text = preg_replace( "! +!", " ", $text );
return trim( $text );
}
/**
* Adds $char to string until string has the length of $digits.
*
* Example:
* Strings::leadingChar( "0", "5", 4 );
* returns "0005"
*
* @version 1.1
* @since 0.1.0
* @access public
*
* @static
*
* @param char $char The char that should add to $string.
* @param string $string The string that schould be extended.
* @param integer $digits The count of digits $string schould get.
*
* @return string
*/
function leadingChar( $char, $string, $digits )
{
$tmp = $digits - strlen( $string );
if( $tmp > 0 )
return str_repeat( $char, $tmp ).$string;
else
return $string;
}
/**
* Returns whether the given string begins with substring $what.
*
* @version 1.1
* @since 0.1.0
* @access public
*
* @static
*
* @param string $string The string which should be checked if it starts
* with $what
* @param string $what The substring which will be compared with the
* beginning of $string
*
* @return boolean
*/
function startsWith( $string, $what )
{
$what = preg_quote( $what );
return preg_match( "!^".$what."!i", $string );
}
/**
* Returns whether the given string ends with substring $what.
*
* @version 1.0
* @since 0.1.0
* @access public
*
* @static
*
* @param string $string The string which should be checked if it ends
* with $what
* @param string $what The substring which will be compared with the
* end of $string
*
* @return boolean
*/
function endsWith( $string, $what )
{
$what = preg_quote( $what );
return preg_match( "!".$what."$!i", $string );
}
/**
* Splits a string by $separator. Every extracted piece will be concatenate
* with $beforeRPL at the beginning and $behindRPL at the ending of its own.
* At least all pieces will put together to a new string. Optionally the
* pieces will be separate by a new separator which is given with the fifth
* parameter.
*
* @version 1.1
* @since 0.1.1
* @access public
*
* @static
*
* @param string $string
* @param string $seperator
* @param string $beforeRPL
* @param string $behindRPL
* @param string $seperatorRPL
*
* @return string
*/
function explodeReplace(
$string,
$separator,
$beforeRPL,
$behindRPL,
$separatorRPL = ""
)
{
$string = Strings::reduceWhiteSpace( $string );
$tmp = explode( $separator, $string );
$out = $beforeRPL
.implode( $behindRPL.$separatorRPL.$beforeRPL, $tmp )
.$behindRPL;
return $out;
}
/**
* Returns the first Word from a text.
*
* @version 1.1
* @since 0.1.0
* @access public
*
* @static
*
* @param string $string The string that schould be extended.
*
* @return string
*/
function getFirstWord( $string )
{
$string = trim( $string );
return preg_replace( "!^([^ \t\n\r]+).*$!is", "$1", $string );
}
/**
* Returns a coincidence created password with given digits.
*
* @version 1.0
* @since 0.1.2
* @access public
*
* @static
*
* @param integer $digits
*
* @return string
*/
function getRandomPassword( $digits = 8 )
{
if( !is_int( $digits ) )
{ die( "\"".$digits."\" is not an integer!" ); }
else
{
$arr = array(
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k',
'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S',
'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '0', '1', '2', '3',
'4', '5', '6', '7', '8', '9', '.', ',', ';', ':', '#',
'+', '-', '!', '\"', '$', '\'', '*', '%', '/', '<', '>',
'|', '(', ')', '[', ']', '{', '}', '?', '=', '&', '\\'
);
$out = "";
for( $i = 0; $i < $digits; $i++ )
$out .= Arrays::getRandomRecord( $arr );
return $out;
}
}
/**
* Returns a coincidence created word with given digits.
*
* @version 1.0
* @since 0.1.2
* @access public
*
* @static
*
* @param integer $digits
*
* @return string
*/
function getRandomWord( $digits = 8 )
{
if( !is_int( $digits ) )
{ die( "\"".$digits."\" is not an integer!" ); }
else
{
$arr = array(
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k',
'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S',
'T', 'U', 'V', 'W', 'X', 'Y', 'Z'
);
$out = "";
for( $i = 0; $i < $digits; $i++ )
$out .= Arrays::getRandomRecord( $arr );
return $out;
}
}
/**
* Interprets arguments given by an URL.
*
* @version 1.0
* @since 0.1.4
* @access public
*
* @static
*
* @param string $string
* @param string $kind
*
* @return void
*/
function parseParam( $string, $kind = "ALL" )
{
if( $string === "" )
return;
if( !preg_match( "!GLOBALS|GET|POST|REQUEST|ALL!i", $kind ) )
die(
"Following values are possible to set the output-kind "
."of the arguments:<br><br>"
."GLOBALS (to store the values in the \"\x24GLOBALS\"-array)<br>"
."GET (to store the values in the \"\x24_GET\"-array)<br>"
."POST (to store the values in the \"\x24_POST\"-array)<br>"
."REQUEST (to store the values in the \"\x24_REQUEST\"-array)<br><br>"
."ALL (to store the values in every possible kind of array - "
."this overrules the other settings)<br><br>"
."All kinds can be used in combination, but the \"ALL\"-kind "
."overrules the other settings."
);
# extract tokens
$token = array();
preg_match_all( "![?&]([^?&]+)!", $string, $token, PREG_PATTERN_ORDER );
for( $i = 0; $i < count( $token[1] ); $i++ )
{
# extract arguments and values
$param_val = array();
preg_match_all(
"!^([^=]+)=(.*)$!",
$token[1][$i], $param_val,
PREG_PATTERN_ORDER
);
if( preg_match( "!REQUEST|ALL!i", $kind ) )
$_REQUEST[$param_val[1][0]] = $param_val[2][0];
if( preg_match( "!POST|ALL!i", $kind ) )
$_POST[$param_val[1][0]] = $param_val[2][0];
if( preg_match( "!GET|ALL!i", $kind ) )
$_GET[$param_val[1][0]] = $param_val[2][0];
if( preg_match( "!GLOBALS|ALL!i", $kind ) )
$GLOBALS[$param_val[1][0]] = $param_val[2][0];
}
}
} // End of class Strings
?>

Source for file Strings.class.php