Class: Strings

Source Location: /Strings.php

Class Overview

This class manages Strings objects. Many functions are available: RemoveSpaces(), RemoveAccent(), QuoteStrip(), etc.

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Child classes:

HTML: This class manages HTML objects.

PHPCode: Created on 1 april 09

STRdates: This class manages STRdates objects. It is used to manipulate dates strings.

STRemailAddresses: This class manages STRemailAddresses objects. It is used to manipulate email addresses strings.

STRip: This class manages time objects.

STRLeetSpeak: This class manages LeetSpeak objects. This class manages STRLeetSpeak strings objects.

STRlines: This class manages lines (strings) objects.

STRnumbers: This class manages STRnumbers objects.

STRpasswords: This class manages STRpasswords objects.

STRphones: This class manages STRphones objects.

STRpostcodes: This class manages STRpostcodes objects. It is used to manipulate postcode strings.

STRregexs: This class manages regular expressions objects.

STRtimes: This class manages time objects.

STRwebsites: This class manages websites objects.

Class Details

[line 36]
This class manages Strings objects. Many functions are available: RemoveSpaces(), RemoveAccent(), QuoteStrip(), etc.

Created on 05 sep 06

Changes: 2.2 -> 2.3: 16 jul 09 updated: file is PEAR compatible 2.1 to 2.2: 22 jun 09 added: stringHasNumbers() function 2.0 to 2.1: 25 may 09 updated: placing error message in $this->error for console() function 1.0 to 2.0: updated: phpdoc compatible in the way to generate documentation

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	2.3
usedby:	Links_Hardgoods_Owners::__construct()
usedby:	Hardgoods_Types::__construct()
usedby:	MacAddresses::__construct()
usedby:	Programs::__construct()
usedby:	WBobject::__construct()
usedby:	HTMLtablesRowsCells::HTMLTableCellConstruct()
usedby:	Hardgoods_Models::__construct()
usedby:	MySQL::__construct()
usedby:	GEOcurrencies::__construct()
usedby:	Brands::__construct()
license:	GNU Public License
usedby:	EW_Manufacturer_Models::__construct()
usedby:	EW_Manufacturers::__construct()
usedby:	Exchange_Rates::__construct()
usedby:	EW_People::__construct()
usedby:	Hardgoods::__construct()

[ Top ]

Class Variables

$api_render =

[line 97]

Variable that defines the API rendering the message

The current available APIs are Terminal or xHTML browser

Tags:

access:

public

Type:

string

[ Top ]

$charset = "UTF-8"

[line 50]

Variable that defines charset

The charset of Strings::value is defined by this variable

Tags:

access:

public

Type:

string

[ Top ]

$colors = array(
 "cli" => array(
 "debug_begin" => "\033[31m\033[01m",
 "debug_end" => "\033[00m",
 "error_begin" => "\033[31m\033[01m\007",
 "error_end" => "\033[00m",
 "warning_begin" => "\033[33m\033[01m",
 "warning_end" => "\033[00m",
 "success_begin" => "\033[32m\033[01m",
 "success_end" => "\033[00m",
 "newline" => "\n"
 ),"html"=>array("debug_begin"=>"","debug_end"=>"","error_begin"=>"","error_end"=>"","warning_begin"=>"","warning_end"=>"","success_begin"=>"","success_end"=>"","newline"=>" \n"))

[line 69]

Variable that lists colors for messages

Those colors are defined for specific message type AND specific output

Tags:

access:

protected

Type:

array

[ Top ]

$directoutput = true

[line 103]

Variable that defines if the message is directly outputted

If the variable is equal to false, the message will be temporized and API must not be self selected

Tags:

access:

public

Type:

bool

[ Top ]

$error =

[line 111]

Variable used to render errors

This variable contains the error message and the error number

Tags:

access:

public

Type:

array

[ Top ]

$msgtypes = array(
        "debug",
        "error",
        "warning",
        "success"
    )

[line 58]

Variable that lists message types

Those message types are used to render console messages

Tags:

access:

protected

Type:

array

[ Top ]

$value =

[line 43]

Variable that contains string to be handled

This variable is used as main variable in all Strings::functions()

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor __construct [line 139]

Strings __construct(
[array
$aParams = null], [string
$sAction = null])

Construction function

This function is used when object is generated. It places variables in "$this" var and can launch function

<?php
$aParams = array("value"=>" This is a test ");
$oStrings = new Strings($aParams, "RemoveSpaces");
echo $oStrings->value;
// This is a test
?>

Tags:

since:

Version 1.0

Parameters:

array	$aParams	array containing variable names and their value ($variablename => $value)
string	$sAction	string containing action to perform on object creation

[ Top ]

method console [line 622]

string console(
string
$msg, string
$msgtype, bool
$this->directoutput)

Console function

This function is used to render errors, logs, debugs, etc. Result is stored in $this->value and returned.

<?php
$oStrings = new Strings();
$msg = "This is an error";
$msgtype = "error";
echo $oStrings->console($msg, $msgtype);
// [red colored]ERROR: This is an error[/red colored]
?>

Tags:

return:	processed text
staticvar:	array $this->msgtypes: array corresponding to the types list
since:	version 1.0

Parameters:

string	$msg	text to be processed (required)
string	$msgtype	string corresponding to message type ($this->msgtypes) (required)
bool	$this->directoutput	defines if the message needs to be stored in a var or directly echoed

[ Top ]

method IsUTF8 [line 434]

bool IsUTF8(
string
$this->value)

UTF8 detection function

This function is used to detect if encoding is UTF-8. Result is returned.

<?php
$oStrings = new Strings();
$oStrings->value = $utf8_string;
echo $oStrings->IsUTF8();
// true
?>

Tags:

return:	true if the string is in UTF8
since:	version 1.0
usedby:	Strings::ToUTF8()

Parameters:

string

$this->value

text to be processed (required)

[ Top ]

method QuoteStrip [line 528]

string QuoteStrip(
[string
$tostrip = "ALL"], string
$this->value)

Quotes stripping function

This function is used to strip " and ' which are around a string. Result is stored in $this->value and returned.

<?php
$oStrings = new Strings();
$oStrings->value = "'This is a test'";
echo $oStrings->QuoteStrip();
// This is a test
?>

Tags:

return:	processed text
since:	version 1.0

Parameters:

string	$this->value	text to be processed (required)
string	$tostrip	this var can be defined to ALL, simple or double. It defines the quotes to be removed.

[ Top ]

method RemoveAccent [line 470]

string RemoveAccent(
string
$this->value)

Accents removal function

This function is used to remove accent from a string. Result is stored in $this->value and returned.

<?php
$oStrings = new Strings();
$oStrings->value = $accents_string;
echo $oStrings->RemoveAccent();
// $nonaccent_string
?>

Tags:

return:	processed text
since:	version 1.0
uses:	Strings::ToUTF8()

Parameters:

string

$this->value

text to be processed (required)

[ Top ]

method RemoveSpaces [line 573]

string RemoveSpaces(
string
$this->value)

Spaces removal function

This function is used to remove spaces that are not needed. Result is stored in $this->value and returned.

<?php
$oStrings = new Strings();
$oStrings->value = " This is a test ");
$oStrings->RemoveSpaces();
echo $oStrings->value;
// This is a test
?>

Tags:

return:	processed text
since:	version 1.0

Parameters:

string

$this->value

text to be processed (required)

[ Top ]

method stringHasNumbers [line 698]

bool stringHasNumbers(
[
$nullable = true], string
$this->value)

Numbers detection function

This function is used check if a string includes numbers Result is returned.

<?php
$oStrings = new Strings("This is an error");
echo $oStrings->stringHasNumbers();
// 0
?>

Tags:

return:	true if string has numbers
since:	version 2.2

Parameters:

string	$this->value	text to be checked (required)
	$nullable

[ Top ]

method ToUTF8 [line 399]

string ToUTF8(
string
$this->value)

UTF8 conversion function

This function is used to format text to UTF8 encoding. Result is stored in $this->value and returned.

<?php
$oStrings = new Strings();
$oStrings->value = $iso85591_string;
echo $oStrings->ToUTF8();
// $utf8_string
?>

Tags:

return:	generated text
since:	version 1.0
usedby:	Strings::RemoveAccent()
uses:	Strings::IsUTF8()

Parameters:

string

$this->value

text to be processed (required)

[ Top ]

method ucwordsw [line 180]

string ucwordsw(
[bool
$minimize = true], string
$this->value)

Special uppercase function

This function is used to put uppercase the first char of each word except special words like 'of', 'the', 'a', etc. Result is stored in $this->value and returned

<?php
$oStrings = new Strings();
$oStrings->value = "THIS IS THE STORY OF A DOG";
echo $oStrings->ucwordsw(true);
// This Is the Story of a Dog
?>

Tags:

return:	generated text
since:	version 1.0

Parameters:

string	$this->value	text to be processed (required)
bool	$minimize	lowercases text before processing

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:30:45 +0200 by phpDocumentor 1.4.1

Class: Strings

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$api_render =

Tags:

$charset = "UTF-8"

Tags:

Tags:

$directoutput = true

Tags:

$error =

Tags:

$msgtypes = array( "debug", "error", "warning", "success" )

Tags:

$value =

Tags:

Class Methods

constructor __construct [line 139]

Tags:

Parameters:

method console [line 622]

Tags:

Parameters:

method IsUTF8 [line 434]

Tags:

Parameters:

method QuoteStrip [line 528]

Tags:

Parameters:

method RemoveAccent [line 470]

Tags:

Parameters:

method RemoveSpaces [line 573]

Tags:

Parameters:

method stringHasNumbers [line 698]

Tags:

Parameters:

method ToUTF8 [line 399]

Tags:

Parameters:

method ucwordsw [line 180]

Tags:

Parameters:

$msgtypes = array(
"debug",
"error",
"warning",
"success"
)