ilStr Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilStr:

Static Public Member Functions
static	subStr (string $a_str, int $a_start, ?int $a_length=null)
static	strPos (string $a_haystack, string $a_needle, ?int $a_offset=null)
static	strIPos (string $a_haystack, string $a_needle, ?int $a_offset=null)
static	strLen (string $a_string)
static	strToLower (string $a_string)
static	strToUpper (string $a_string)
static	strCmp (string $a, string $b)
static	shortenText (string $a_string, int $a_start_pos, int $a_num_bytes, string $a_encoding='UTF-8')
	Shorten text to the given number of bytes. More...
static	isUtf8 (string $a_str)
	Check whether string is utf-8. More...
static	convertUpperCamelCaseToUnderscoreCase (string $value)
	Convert a value given in camel case conversion to underscore case conversion (e.g. More...
static	shortenTextExtended (string $a_str, int $a_len, bool $a_dots=false, bool $a_next_blank=false, bool $a_keep_extension=false)
static	shortenWords (string $a_str, int $a_len=30, bool $a_dots=true)
	Ensure that the maximum word lenght within a text is not longer than $a_len. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Deprecated:

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

Member Function Documentation

convertUpperCamelCaseToUnderscoreCase()

static ilStr::convertUpperCamelCaseToUnderscoreCase ( string  $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 171 of file class.ilStr.php.

Referenced by ilAbstractBuddySystemRelationStateButtonRenderer\__construct(), ilMailSearchObjectGUI\cancel(), ilContactUserActionProvider\collectActionsForTargetUser(), ilAbstractBuddySystemRelationStateButtonRenderer\renderStateButton(), and ilAbstractBuddySystemRelationStateButtonRenderer\renderTargetState().

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

Here is the caller graph for this function:

isUtf8()

static ilStr::isUtf8 ( string  $a_str )

static

Check whether string is utf-8.

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

References Vendor\Package\$b, $c, and $i.

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

                                                : bool
    {
        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:

shortenText()

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

static

Shorten text to the given number of bytes.

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

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

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

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

     : string {
        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:

shortenTextExtended()

static ilStr::shortenTextExtended ( string  $a_str, int  $a_len, bool  $a_dots = false, bool  $a_next_blank = false, bool  $a_keep_extension = false  )

static

Deprecated:

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

References strLen(), strPos(), and subStr().

Referenced by ilObjSystemFolder\_getHeaderTitleDescription(), ilObject\_writeDescription(), ilExcel\addSheet(), ilStudyProgrammeDashboardViewGUI\buildItem(), ilObjSystemFolder\delete(), ilObjWikiGUI\editImportantPagesObject(), ilTree\fetchNodeData(), ilLDAPRoleMappingTableGUI\fillRow(), ilNewsForContextTableGUI\fillRow(), ilAssignmentsTableGUI\fillRow(), ilAdminSubItemsTableGUI\fillRow(), ilPresentationListTableGUI\fillRow(), ilTermListTableGUI\fillRow(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilPasteIntoMultipleItemsExplorer\formatObject(), ilExplorer\formatObject(), SurveyMatrixQuestionEvaluation\getChart(), ilContainer\getCompleteDescriptions(), ilObjLinkResourceListGUI\getDescription(), ilPDSelectedItemsBlockSelectedItemsProvider\getItems(), ilDashboardRecommendedContentGUI\getListItemGroups(), ilPDSelectedItemsBlockMembershipsProvider\getObjectsByMembership(), ilMailNotification\getObjectTitle(), ilCalendarEntry\getPresentationTitle(), ilLMPresentationGUI\ilLocator(), ilObjWikiGUI\initSettingsForm(), ilSCORMExplorer\insertObject(), ilWikiPageTemplateGUI\listTemplates(), ilChartDataSpider\parseGlobalOptions(), ilLMNavigationRendererGUI\render(), ILIAS\Repository\Provider\RepositoryMainBarProvider\renderLastVisited(), ilMembershipCronNotifications\run(), ilObject\setDescription(), ilObject\setTitle(), and ilGlossaryDefinition\shortenShortText().

     : string {
        if (ilStr::strLen($a_str) > $a_len) {
            /*
             * When adding dots, the dots have to be included in the length such
             * that the total length of the resulting string does not exceed
             * the given maximum length (see BT 33865).
             */
            if ($a_dots) {
                $a_len--;
            }
            if ($a_next_blank) {
                $len = ilStr::strPos($a_str, " ", $a_len);
            } else {
                $len = $a_len;
            }
            // BEGIN WebDAV
            //             - Shorten names in the middle, before the filename extension
            //             Workaround for Windows WebDAV Client:
            //             Use the unicode ellipsis symbol for shortening instead of
            //             three full stop characters.
            $p = false;
            if ($a_keep_extension) {
                $p = strrpos($a_str, '.');    // this messes up normal shortening, see bug #6190
            }
            if ($p === false || $p == 0 || strlen($a_str) - $p > $a_len) {
                $a_str = ilStr::subStr($a_str, 0, $len);
                if ($a_dots) {
                    $a_str .= "\xe2\x80\xa6"; // UTF-8 encoding for Unicode ellipsis character.
                }
            } else {
                if ($a_dots) {
                    $a_str = ilStr::subStr($a_str, 0, $len - (strlen($a_str) - $p + 1)) . "\xe2\x80\xa6" . substr(
                        $a_str,
                        $p
                    );
                } else {
                    $a_str = ilStr::subStr($a_str, 0, $len - (strlen($a_str) - $p + 1)) . substr($a_str, $p);
                }
            }
        }

        return $a_str;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

shortenWords()

static ilStr::shortenWords ( string  $a_str, int  $a_len = 30, bool  $a_dots = true  )

static

Ensure that the maximum word lenght within a text is not longer than $a_len.

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

References $i, strLen(), and subStr().

Referenced by ilNewsForContextBlockGUI\getInfoForData(), and ilCalendarEntry\getPresentationTitle().

                                                                                            : string
    {
        $str_arr = explode(" ", $a_str);

        for ($i = 0; $i < count($str_arr); $i++) {
            if (ilStr::strLen($str_arr[$i]) > $a_len) {
                $str_arr[$i] = ilStr::subStr($str_arr[$i], 0, $a_len);
                if ($a_dots) {
                    $str_arr[$i] .= "...";
                }
            }
        }

        return implode(" ", $str_arr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

strCmp()

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

static

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

References strToUpper().

Referenced by ilArrayUtil\sort_func().

                                                       : int
    {
        return strcoll(ilStr::strToUpper($a), ilStr::strToUpper($b));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

strIPos()

static ilStr::strIPos ( string  $a_haystack, string  $a_needle, ?int  $a_offset = null  )

static

Returns

false|int

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

Referenced by ilCronManagerTableFilterMediator\filteredJobs(), ilMathJax\insertLatexImages(), ilDidacticTemplateSettingsTableFilter\isFiltered(), and ilPCParagraph\linkTermsInDom().

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

Here is the caller graph for this function:

strLen()

static ilStr::strLen ( string  $a_string )

static

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

Referenced by ilMailValueObject\__construct(), ilObjQuestionPool\_getFullPathToQpl(), ilICalWriter\addLine(), ilWikiPage\afterUpdate(), ilMail\checkMail(), SurveyTextQuestion\checkUserInput(), ilMailValueObjectJsonService\convertFromJson(), assTextQuestion\countLetters(), ilForumMailEventNotificationSender\createMailValueObjectsWithAttachments(), ilForumMailEventNotificationSender\createMailValueObjectWithoutAttachments(), ilMail\delegateExternalEmails(), ilUserAutoComplete\getList(), ilObjWikiGUI\gotoPageObject(), ilMathJax\insertLatexImages(), ilSecuritySettingsChecker\isPassword(), ilPCParagraph\linkTermsInDom(), ilMailSearchGUI\lookupRecipientAsync(), ilMailFormGUI\lookupRecipientAsync(), ilBiblFileReaderBase\parseContentToEntries(), ilObjForumAccess\prepareMessageForLists(), ilCronJobResult\setMessage(), ilAssQuestionSkillAssignmentRegistry\setStringifiedImports(), ilMailNotification\setSubject(), shortenTextExtended(), shortenWords(), ILIAS\Refinery\String\Transformation\LevenshteinTransformation\stringToCharacterArray(), and ilExcCriteriaText\validate().

                                                   : int
    {
        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 ( string  $a_haystack, string  $a_needle, ?int  $a_offset = null  )

static

Returns

false|int|true

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

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

strToLower()

static ilStr::strToLower ( string  $a_string )

static

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

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

                                                       : string
    {
        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 ( string  $a_string )

static

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

Referenced by ilUserDefinedFieldsPlaceholderDescription\__construct(), ilObjectCustomUserFieldsPlaceholderValues\__construct(), ilUserDefinedFieldsPlaceholderValues\__construct(), ilObjectCustomUserFieldsPlaceholderValues\getPlaceholderValuesForPreview(), ilUserDefinedFieldsPlaceholderValues\getPlaceholderValuesForPreview(), ilObjectCustomUserFieldsPlaceholderDescription\initPlaceholders(), and strCmp().

                                                       : 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 ( string  $a_str, int  $a_start, ?int  $a_length = null  )

static

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

Referenced by ilMailSearchObjectMembershipsTableGUI\__construct(), ilObjQuestionPool\_getFullPathToQpl(), ilICalWriter\addLine(), ilLMObject\clipboardCopy(), ilCertificateSettingsScormFormRepository\createForm(), ilObjStyleSheet\createFromXMLFile(), ilForumAuthorInformation\getUserImagePath(), ilUserAvatarResolver\init(), ilForumAuthorInformation\init(), ilMathJax\insertLatexImages(), ilPCParagraph\linkTermsInDom(), ilChatroomViewGUI\lostConnection(), ilBiblFileReaderBase\parseContentToEntries(), ilObjForumAccess\prepareMessageForLists(), ilCronManagerImpl\runJob(), ilPageObject\saveStyleUsage(), SurveyTextQuestion\saveUserInput(), ilSurveyParticipantsGUI\sendCodesMailObject(), ilAssQuestionSkillAssignmentRegistry\setStringifiedImports(), ilMailNotification\setSubject(), shortenTextExtended(), shortenWords(), ILIAS\Refinery\String\Transformation\LevenshteinTransformation\stringToCharacterArray(), and ilObject\update().

                                                                                     : string
    {
        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