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	strrPos ($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...
static	convertUpperCamelCaseToUnderscoreCase ($value)
	Convert a value given in camel case conversion to underscore case conversion (e.g. More...
static	getBytesForString ($a_str)
	Return string as byte array Note: Use this for debugging purposes only. More...
static	normalizeUtf8String ($a_str)
	Normalize UTF8 string. 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

convertUpperCamelCaseToUnderscoreCase()

static ilStr::convertUpperCamelCaseToUnderscoreCase (   $value )

static

Convert a value given in camel case conversion to underscore case conversion (e.g.

MyClass to my_class)

Parameters

string

$value

Value in lower camel case conversion

Returns

string The value in underscore case conversion

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

Referenced by ilAbstractBuddySystemRelationStateButtonRenderer\__construct(), ilContactUserActionProvider\collectActionsForTargetUser(), ilAbstractBuddySystemRelationStateButtonRenderer\renderStateButton(), ilAbstractBuddySystemRelationStateButtonRenderer\renderTargetState(), ilMailSearchGroupsGUI\showMembers(), and ilMailSearchCoursesGUI\showMembers().

    {
        return strtolower(preg_replace(
            array('#(?<=(?:[A-Z]))([A-Z]+)([A-Z][A-z])#', '#(?<=(?:[a-z0-9]))([A-Z])#'),
            array('\1_\2', '_\1'),
            $value
        ));
    }

Here is the caller graph for this function:

getBytesForString()

static ilStr::getBytesForString (   $a_str )

static

Return string as byte array Note: Use this for debugging purposes only.

If strlen is overwritten by mb_ functions (PHP config) this will return not all characters

Parameters

string

$a_str

string

Returns

array array of bytes

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

References $i.

Referenced by ilObjFile\createProperties().

    {
        $bytes = array();
        for ($i = 0; $i < strlen($a_str); $i++) {
            $bytes[] = ord($a_str[$i]);
        }
        return $bytes;
    }

Here is the caller graph for this function:

isUtf8()

static ilStr::isUtf8 (   $a_str )

static

Check whether string is utf-8.

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

References $c, and $i.

Referenced by ilObjLanguage\check(), ilDclTextFieldModel\checkTitlesForImport(), and ilDclBaseFieldModel\checkTitlesForImport().

    {
        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($a_str);
            for ($i = 0; $i < $len; $i++) {
                $c = ord($a_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($a_str[$i]);
                        if ($b < 128 || $b > 191) {
                            return false;
                        }
                        $bits--;
                    }
                }
            }
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

normalizeUtf8String()

static ilStr::normalizeUtf8String (   $a_str )

static

Normalize UTF8 string.

Parameters

string

$a_str

string

Returns

string

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

References UtfNormal\toNFC().

Referenced by ilFileWizardInputGUI\checkInput(), ilDragDropFileInputGUI\checkInput(), and ilFileInputGUI\checkInput().

    {
        include_once("./include/Unicode/UtfNormal.php");
        return UtfNormal::toNFC($a_str);
    }

Here is the call graph for this function:

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 219 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 138 of file class.ilStr.php.

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

    {
        if (function_exists("mb_strcut")) {
            return mb_strcut($a_string, $a_start_pos, $a_num_bytes, $a_encoding);
        }
        return substr($a_string, $a_start_pos, $a_num_bytes);
    }

Here is the caller graph for this function:

strCmp()

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

static

Compare two strings.

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

References $DIC, and strToUpper().

Referenced by ilUtil\sort_func().

    {
        global $DIC;

        $ilCollator = null;
        if (isset($DIC["ilCollator"])) {
            $ilCollator = $DIC["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 48 of file class.ilStr.php.

Referenced by ilMathJax\insertLatexImages(), and 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 78 of file class.ilStr.php.

Referenced by ilObjQuestionPool\_getFullPathToQpl(), ilICalWriter\addLine(), ilWikiPage\afterUpdate(), SurveyTextQuestion\checkUserInput(), assTextQuestion\countLetters(), ilMail\distributeMail(), ilObjWikiGUI\gotoPageObject(), ilMathJax\insertLatexImages(), ilUtil\isPassword(), ilPCParagraph\linkTermsInDom(), ilMailSearchGUI\lookupRecipientAsync(), ilMailFormGUI\lookupRecipientAsync(), ilObjForumAccess\prepareMessageForLists(), ilBiblFileReaderBase\setPathToFile(), ilUserAutoComplete\setResultField(), ilAssQuestionSkillAssignmentRegistry\setStringifiedImports(), ilUtil\shortenText(), ilUtil\shortenWords(), and ilExcCriteriaText\validate().

    {
        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 30 of file class.ilStr.php.

Referenced by ilMathJax\insertLatexImages(), assTextQuestion\isKeywordMatching(), ilPCParagraph\linkTermsInDom(), 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 205 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:

strrPos()

static ilStr::strrPos (   $a_haystack,   $a_needle,   $a_offset = null  )

static

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

Referenced by ilPCParagraph\linkTermsInDom().

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

Here is the caller graph for this function:

strToLower()

static ilStr::strToLower (   $a_string )

static

Definition at line 87 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 96 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(), ilCertificateSettingsScormFormRepository\createForm(), ilObjUser\getPersonalPicturePath(), ilForumAuthorInformation\getUserImagePath(), ilForumAuthorInformation\init(), ilMathJax\insertLatexImages(), ilPCParagraph\linkTermsInDom(), ilChatroomViewGUI\lostConnection(), ilObjForumAccess\prepareMessageForLists(), SurveyTextQuestion\saveUserInput(), ilBiblFileReaderBase\setPathToFile(), ilAssQuestionSkillAssignmentRegistry\setStringifiedImports(), ilUtil\shortenText(), and ilUtil\shortenWords().

    {
        if (function_exists("mb_substr")) {
            // bug in PHP < 5.4.12: null is not supported as length (if encoding given)
            // https://github.com/php/php-src/pull/133
            if ($a_length === null) {
                $a_length = mb_strlen($a_str, "UTF-8");
            }
            
            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