PHP Класс Contao\StringUtil

Usage: $short = StringUtil::substr($str, 32); $html = StringUtil::substrHtml($str, 32); $xhtml = StringUtil::toXhtml($html5);
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$arrSplitCache array Trimsplit cache

Открытые методы

Метод Описание
binToUuid ( string $data ) : string Get a UUID string from binary data
censor ( string $strString, mixed $varWords, string $strReplace = '' ) : string Censor a single word or an array of words within a string
convertEncoding ( string $str, string $to, string $from = null ) : string Convert the character encoding
decodeEntities ( string $strString, integer $strQuoteStyle = ENT_COMPAT, string $strCharset = null ) : string Decode all entities
deserialize ( mixed $varValue, boolean $blnForceArray = false ) : array | string | null Return an unserialized array or the argument
encodeEmail ( string $strString ) : string Encode all e-mail addresses within a string
extractEmail ( string $strString, string $strAllowedTags = '' ) : array Extract all e-mail addresses from a string
generateAlias ( string $strString ) : string Generate an alias from a string
highlight ( string $strString, string $strPhrase, string $strOpeningTag = '<strong>', string $strClosingTag = '</strong>' ) : string Highlight a phrase within a string
insertTagToSrc ( string $data ) : string Convert insert tags inside "src" attributes to file paths
parseSimpleTokens ( string $strString, array $arrData ) : string Parse simple tokens
resolveFlaggedUrl ( string &$url ) : stdClass Resolve a flagged URL such as assets/js/core.js|static|10184084
restoreBasicEntities ( string $strBuffer ) : string Restore basic entities
sanitizeFileName ( string $strName ) : string Sanitize a file name
specialchars ( string $strString, boolean $blnStripInsertTags = false ) : string Convert special characters to HTML entities preventing double conversions
splitCsv ( string $strString, string $strDelimiter = ',' ) : array Split a string of comma separated values
splitFriendlyEmail ( string $strEmail ) : array Split a friendly-name e-address and return name and e-mail as array
srcToInsertTag ( string $data ) : string Convert file paths inside "src" attributes to insert tags
standardize ( string $strString, boolean $blnPreserveUppercase = false ) : string Standardize a parameter (strip special characters and convert spaces)
stripInsertTags ( string $strString ) : string Remove Contao insert tags from a string
substr ( string $strString, integer $intNumberOfChars, string $strEllipsis = ' …' ) : string Shorten a string to a given number of characters
substrHtml ( string $strString, integer $intNumberOfChars ) : string Shorten a HTML string to a given number of characters
toHtml5 ( string $strString ) : string Convert a string to HTML5
toXhtml ( string $strString ) : string Convert a string to XHTML
trimsplit ( string $strPattern, string $strString ) : array Split a string into fragments, remove whitespace and return fragments as array
uuidToBin ( string $uuid ) : string Convert a UUID string to binary data
wordWrap ( string $strString, integer $strLength = 75, string $strBreak = " " ) : string Wrap words after a particular number of characers

Описание методов

binToUuid() публичный статический Метод

Get a UUID string from binary data
public static binToUuid ( string $data ) : string
$data string The binary data
Результат string The UUID string

censor() публичный статический Метод

Censor a single word or an array of words within a string
public static censor ( string $strString, mixed $varWords, string $strReplace = '' ) : string
$strString string The string to censor
$varWords mixed A string or array or words to replace
$strReplace string An optional replacement string
Результат string The cleaned string

convertEncoding() публичный статический Метод

Convert the character encoding
public static convertEncoding ( string $str, string $to, string $from = null ) : string
$str string The input string
$to string The target character set
$from string An optional source character set
Результат string The converted string

decodeEntities() публичный статический Метод

Decode all entities
public static decodeEntities ( string $strString, integer $strQuoteStyle = ENT_COMPAT, string $strCharset = null ) : string
$strString string The string to decode
$strQuoteStyle integer The quote style (defaults to ENT_COMPAT)
$strCharset string An optional charset
Результат string The decoded string

deserialize() публичный статический Метод

Return an unserialized array or the argument
public static deserialize ( mixed $varValue, boolean $blnForceArray = false ) : array | string | null
$varValue mixed The serialized string
$blnForceArray boolean True to always return an array
Результат array | string | null The array, an empty string or null

encodeEmail() публичный статический Метод

Encode all e-mail addresses within a string
public static encodeEmail ( string $strString ) : string
$strString string The string to encode
Результат string The encoded string

extractEmail() публичный статический Метод

Extract all e-mail addresses from a string
public static extractEmail ( string $strString, string $strAllowedTags = '' ) : array
$strString string The string
$strAllowedTags string A list of allowed HTML tags
Результат array The e-mail addresses

generateAlias() публичный статический Метод

Generate an alias from a string
public static generateAlias ( string $strString ) : string
$strString string The string
Результат string The alias

highlight() публичный статический Метод

Highlight a phrase within a string
public static highlight ( string $strString, string $strPhrase, string $strOpeningTag = '<strong>', string $strClosingTag = '</strong>' ) : string
$strString string The string
$strPhrase string The phrase to highlight
$strOpeningTag string The opening tag (defaults to )
$strClosingTag string The closing tag (defaults to )
Результат string The highlighted string

insertTagToSrc() публичный статический Метод

Convert insert tags inside "src" attributes to file paths
public static insertTagToSrc ( string $data ) : string
$data string The markup string
Результат string The markup with insert tags converted to file paths

parseSimpleTokens() публичный статический Метод

Parse simple tokens
public static parseSimpleTokens ( string $strString, array $arrData ) : string
$strString string The string to be parsed
$arrData array The replacement data
Результат string The converted string

resolveFlaggedUrl() публичный статический Метод

Resolve a flagged URL such as assets/js/core.js|static|10184084
public static resolveFlaggedUrl ( string &$url ) : stdClass
$url string The URL
Результат stdClass The options object

restoreBasicEntities() публичный статический Метод

Restore basic entities
public static restoreBasicEntities ( string $strBuffer ) : string
$strBuffer string The string with the tags to be replaced
Результат string The string with the original entities

sanitizeFileName() публичный статический Метод

Sanitize a file name
public static sanitizeFileName ( string $strName ) : string
$strName string The file name
Результат string The sanitized file name

specialchars() публичный статический Метод

Convert special characters to HTML entities preventing double conversions
public static specialchars ( string $strString, boolean $blnStripInsertTags = false ) : string
$strString string The input string
$blnStripInsertTags boolean True to strip insert tags
Результат string The converted string

splitCsv() публичный статический Метод

Split a string of comma separated values
public static splitCsv ( string $strString, string $strDelimiter = ',' ) : array
$strString string The string to split
$strDelimiter string An optional delimiter
Результат array The string chunks

splitFriendlyEmail() публичный статический Метод

Split a friendly-name e-address and return name and e-mail as array
public static splitFriendlyEmail ( string $strEmail ) : array
$strEmail string A friendly-name e-mail address
Результат array An array with name and e-mail address

srcToInsertTag() публичный статический Метод

Convert file paths inside "src" attributes to insert tags
public static srcToInsertTag ( string $data ) : string
$data string The markup string
Результат string The markup with file paths converted to insert tags

standardize() публичный статический Метод

Standardize a parameter (strip special characters and convert spaces)
public static standardize ( string $strString, boolean $blnPreserveUppercase = false ) : string
$strString string The input string
$blnPreserveUppercase boolean True to preserver uppercase characters
Результат string The converted string

stripInsertTags() публичный статический Метод

Remove Contao insert tags from a string
public static stripInsertTags ( string $strString ) : string
$strString string The input string
Результат string The converted string

substr() публичный статический Метод

The function preserves words, so the result might be a bit shorter or longer than the number of characters given. It strips all tags.
public static substr ( string $strString, integer $intNumberOfChars, string $strEllipsis = ' …' ) : string
$strString string The string to shorten
$intNumberOfChars integer The target number of characters
$strEllipsis string An optional ellipsis to append to the shortened string
Результат string The shortened string

substrHtml() публичный статический Метод

The function preserves words, so the result might be a bit shorter or longer than the number of characters given. It preserves allowed tags.
public static substrHtml ( string $strString, integer $intNumberOfChars ) : string
$strString string The string to shorten
$intNumberOfChars integer The target number of characters
Результат string The shortened HTML string

toHtml5() публичный статический Метод

Convert a string to HTML5
public static toHtml5 ( string $strString ) : string
$strString string The XHTML string
Результат string The HTML5 string

toXhtml() публичный статический Метод

Convert a string to XHTML
public static toXhtml ( string $strString ) : string
$strString string The HTML5 string
Результат string The XHTML string

trimsplit() публичный статический Метод

Split a string into fragments, remove whitespace and return fragments as array
public static trimsplit ( string $strPattern, string $strString ) : array
$strPattern string The split pattern
$strString string The input string
Результат array The fragments array

uuidToBin() публичный статический Метод

Convert a UUID string to binary data
public static uuidToBin ( string $uuid ) : string
$uuid string The UUID string
Результат string The binary data

wordWrap() публичный статический Метод

Wrap words after a particular number of characers
public static wordWrap ( string $strString, integer $strLength = 75, string $strBreak = " " ) : string
$strString string The string to wrap
$strLength integer The number of characters to wrap after
$strBreak string An optional break character
Результат string The wrapped string

Описание свойств

$arrSplitCache защищенное статическое свойство

Trimsplit cache
protected static array $arrSplitCache
Результат array