ilStr Class Reference

Multi byte sensitive string functions. More...

Collaboration diagram for ilStr:

Static Public Member Functions
static	subStr ($a_str, $a_start, $a_length=NULL)
static	strPos ($a_haystack, $a_needle, $a_offset=NULL)
static	strIPos ($a_haystack, $a_needle, $a_offset=NULL)
static	strLen ($a_string)
static	strToLower ($a_string)
static	strToUpper ($a_string)
static	strCmp ($a, $b)
	Compare two strings. More...
static	shortenText ($a_string, $a_start_pos, $a_num_bytes, $a_encoding='UTF-8')
	Shorten text to the given number of bytes. More...
static	isUtf8 ($a_str)
	Check whether string is utf-8. More...
static	strPosAll ($a_haystack, $a_needle)
	Get all positions of a string. More...
static	replaceFirsOccurence ($a_old, $a_new, $a_str)
	Replaces the first occurence of $a_old in $a_str with $a_new. More...

Detailed Description

Multi byte sensitive string functions.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

$Id$

Definition at line 13 of file class.ilStr.php.

Member Function Documentation

isUtf8()

static ilStr::isUtf8 (   $a_str )

static

Check whether string is utf-8.

Definition at line 152 of file class.ilStr.php.

Referenced by ilObjLanguage\check(), ilDataCollectionRecordListGUI\getImportFieldsFromTitles(), and ilDataCollectionRecordListGUI\importRecords().

        {
                if (function_exists("mb_detect_encoding"))
                {
                        if (mb_detect_encoding($a_str, "UTF-8", true) == "UTF-8")
                        {
                                return true;
                        }
                }
                else
                {
                        // copied from http://www.php.net/manual/en/function.mb-detect-encoding.php
                        $c=0; $b=0;
                        $bits=0;
                        $len=strlen($str);
                        for($i=0; $i<$len; $i++){
                                $c=ord($str[$i]);
                                if($c > 128){
                                        if(($c >= 254)) return false;
                                        elseif($c >= 252) $bits=6;
                                        elseif($c >= 248) $bits=5;
                                        elseif($c >= 240) $bits=4;
                                        elseif($c >= 224) $bits=3;
                                        elseif($c >= 192) $bits=2;
                                        else return false;
                                        if(($i+$bits) > $len) return false;
                                        while($bits > 1){
                                                $i++;
                                                $b=ord($str[$i]);
                                                if($b < 128 || $b > 191) return false;
                                                $bits--;
                                        }
                                }
                        }
                        return true;
                }
                return false;
        }

Here is the caller graph for this function:

replaceFirsOccurence()

static ilStr::replaceFirsOccurence (   $a_old,   $a_new,   $a_str  )

static

Replaces the first occurence of $a_old in $a_str with $a_new.

Definition at line 214 of file class.ilStr.php.

Referenced by ilPageObjectGUI\insertPageToc().

        {
                if (is_int(strpos($a_str, $a_old)))
                {
                        $a_str = substr_replace ($a_str, $a_new, strpos($a_str, $a_old), strlen($a_old));
                }
                return $a_str;
        }

Here is the caller graph for this function:

shortenText()

static ilStr::shortenText (   $a_string,   $a_start_pos,   $a_num_bytes,   $a_encoding = 'UTF-8'  )

static

Shorten text to the given number of bytes.

If the character is cutted within a character the invalid character will be shortened, too.

E.g: shortenText('€€€',4) will return '€'

Parameters

string	$a_string
int	$a_start_pos
int	$a_num_bytes
string	$a_encoding	[optional]

Returns

string

Definition at line 144 of file class.ilStr.php.

Referenced by ilDBGenerator\shortenText(), and ilPageObject\truncateHTML().

        {
                return mb_strcut($a_string, $a_start_pos, $a_num_bytes, $a_encoding);           
        }

Here is the caller graph for this function:

strCmp()

static ilStr::strCmp (   $a,   $b  )

static

Compare two strings.

Definition at line 117 of file class.ilStr.php.

References strToUpper().

Referenced by ilUtil\sort_func().

        {
                global $ilCollator;

                if (is_object($ilCollator))
                {
                        return ($ilCollator->compare(ilStr::strToUpper($a), ilStr::strToUpper($b)) > 0);
                }
                else
                {
                        return (strcoll(ilStr::strToUpper($a), ilStr::strToUpper($b)) > 0);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

strIPos()

static ilStr::strIPos (   $a_haystack,   $a_needle,   $a_offset = NULL  )

static

Definition at line 44 of file class.ilStr.php.

Referenced by ilPCParagraph\linkTermsInDom().

        {
                if (function_exists("mb_stripos"))
                {
                        return mb_stripos($a_haystack, $a_needle, $a_offset, "UTF-8");
                }
                else
                {
                        return stripos($a_haystack, $a_needle, $a_offset);
                }
        }

Here is the caller graph for this function:

strLen()

static ilStr::strLen (   $a_string )

static

Definition at line 77 of file class.ilStr.php.

Referenced by ilObjQuestionPool\_getFullPathToQpl(), ilICalWriter\addLine(), ilWikiPage\afterUpdate(), ilDataCollectionField\checkValidity(), assTextQuestion\getSolutionSubmit(), ilUtil\isPassword(), ilPCParagraph\linkTermsInDom(), ilObjForumAccess\prepareMessageForLists(), ilUtil\shortenText(), ilUtil\shortenWords(), and ilObjBibliographic\writeSourcefileEntriesToDb().

        {
                if (function_exists("mb_strlen"))
                {
                        return mb_strlen($a_string, "UTF-8");
                }
                else
                {
                        return strlen($a_string);
                }               
        }

Here is the caller graph for this function:

strPos()

static ilStr::strPos (   $a_haystack,   $a_needle,   $a_offset = NULL  )

static

Definition at line 32 of file class.ilStr.php.

Referenced by assTextQuestion\isKeywordMatching(), ilUtil\shortenText(), assOrderingHorizontal\splitAndTrimOrderElementText(), and ilMailAutoCompleteSentMailsRecipientsProvider\valid().

        {
                if (function_exists("mb_strpos"))
                {
                        return mb_strpos($a_haystack, $a_needle, $a_offset, "UTF-8");
                }
                else
                {
                        return strpos($a_haystack, $a_needle, $a_offset);
                }
        }

Here is the caller graph for this function:

strPosAll()

static ilStr::strPosAll (   $a_haystack,   $a_needle  )

static

Get all positions of a string.

Parameters

string	the string to search in
string	the string to search for

Returns

array all occurences of needle in haystack

Definition at line 199 of file class.ilStr.php.

Referenced by ilPageObjectGUI\insertPageToc().

        {
                $positions = array();
                $cpos = 0;
                while(is_int($pos = strpos($a_haystack, $a_needle, $cpos)))
                {
                        $positions[] = $pos;
                        $cpos = $pos+1;
                }
                return $positions;
        }

Here is the caller graph for this function:

strToLower()

static ilStr::strToLower (   $a_string )

static

Definition at line 89 of file class.ilStr.php.

Referenced by ilTree\getNodePathForTitlePath(), assClozeTest\getTextgapPoints(), assTextSubset\isAnswerCorrect(), assTextQuestion\isKeywordMatching(), and ilMailAutoCompleteSentMailsRecipientsProvider\valid().

        {
                if (function_exists("mb_strtolower"))
                {
                        return mb_strtolower($a_string, "UTF-8");
                }
                else
                {
                        return strtolower($a_string);
                }               
        }

Here is the caller graph for this function:

strToUpper()

static ilStr::strToUpper (   $a_string )

static

Definition at line 101 of file class.ilStr.php.

Referenced by ilUtil\sort_func(), and strCmp().

        {
                $a_string = (string) $a_string;
                if (function_exists("mb_strtoupper"))
                {
                        return mb_strtoupper($a_string, "UTF-8");
                }
                else
                {
                        return strtoupper($a_string);
                }               
        }

Here is the caller graph for this function:

subStr()

static ilStr::subStr (   $a_str,   $a_start,   $a_length = NULL  )

static

Definition at line 15 of file class.ilStr.php.

Referenced by ilObjQuestionPool\_getFullPathToQpl(), ilSCORMCertificateAdapter\addAdditionalFormElements(), ilICalWriter\addLine(), assTextQuestion\getSolutionSubmit(), ilPCParagraph\linkTermsInDom(), ilObjForumAccess\prepareMessageForLists(), ilUtil\shortenText(), ilUtil\shortenWords(), and ilObjBibliographic\writeSourcefileEntriesToDb().

        {
                if (function_exists("mb_substr"))
                {
                        // see https://bugs.php.net/bug.php?id=62703
                        if ($a_length === NULL)
                        {
                                $a_length = self::strLen($a_str);
                        }
                        return mb_substr($a_str, $a_start, $a_length, "UTF-8");
                }
                else
                {
                        return substr($a_str, $a_start, $a_length);
                }
        }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• Services/Utilities/classes/class.ilStr.php