class.ilStr.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2014 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilStr
{
    public static function subStr($a_str, $a_start, $a_length = null)
    {
        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);
        }
    }

    public static function strPos($a_haystack, $a_needle, $a_offset = null)
    {
        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);
        }
    }

    public static function strrPos($a_haystack, $a_needle, $a_offset = null)
    {
        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);
        }
    }

    public static function strIPos($a_haystack, $a_needle, $a_offset = null)
    {
        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);
        }
    }

    /*function strrPos($a_haystack, $a_needle, $a_offset = NULL)
    {
        if (function_exists("mb_strrpos"))
        {
            // only for php version 5.2.0 and above
            if( version_compare(PHP_VERSION, '5.2.0', '>=') )
            {
                return mb_strrpos($a_haystack, $a_needle, $a_offset, "UTF-8");
            }
            else
            {
                @todo: We need an implementation for php versions < 5.2.0
                return mb_strrpos($a_haystack, $a_needle, "UTF-8");
            }
        }
        else
        {
            return strrpos($a_haystack, $a_needle, $a_offset);
        }
    }*/

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

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

    public static function strToUpper($a_string)
    {
        $a_string = (string) $a_string;
        if (function_exists("mb_strtoupper")) {
            return mb_strtoupper($a_string, "UTF-8");
        } else {
            return strtoupper($a_string);
        }
    }
    
    public static function strCmp($a, $b)
    {
        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);
        }
    }
    
    public static function shortenText($a_string, $a_start_pos, $a_num_bytes, $a_encoding = 'UTF-8')
    {
        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);
    }

    public static function isUtf8($a_str)
    {
        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;
    }


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

    public static function replaceFirsOccurence($a_old, $a_new, $a_str)
    {
        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;
    }

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

    public static function getBytesForString($a_str)
    {
        $bytes = array();
        for ($i = 0; $i < strlen($a_str); $i++) {
            $bytes[] = ord($a_str[$i]);
        }
        return $bytes;
    }
    
    public static function normalizeUtf8String($a_str)
    {
        include_once("./include/Unicode/UtfNormal.php");
        return UtfNormal::toNFC($a_str);
    }
}