Layer: Core · Source: lib/core/Util.php:21 (lines 21–2543)

class Util

Util.php

util.php is a library of helper functions for common tasks such as formatting bytes as a string or displaying a date in terms of how long ago it was in human readable terms (E.g. 4 minutes ago). The library is entirely contained within a single file and hosts no dependencies. The library is designed to avoid any possible conflicts.

No parent, interface or trait. This is a root type.

private static function initLanguageMap($language = '')

lines 253–280 (28)

Initializes the character map.

Part of the URLify.php Project <https://github.com/jbroadway/urlify/>

Returns: (none declared)

public static function array_get(&$var, $default = null)

lines 294–297 (4)

Access an array index, retrieving the value stored there if it

exists or a default if it does not. This function allows you to concisely access an index which may or may not exist without raising a warning.

Returns: (none declared) — mixed

public static function var_dump($var, $return = false, $expandLevel = 1)

lines 308–340 (33)

Display a variable's contents using nice HTML formatting and will

properly display the value of booleans as true or false

Returns: (none declared) — string

public static function var_dump_plain($var, $expLevel, $depth = 0, $done = array())

lines 351–500 (150)

Display a variable's contents using nice HTML formatting (Without

the <pre> tag) and will properly display the values of variables like booleans and resources. Supports collapsable arrays and objects as well.

Returns: (none declared) — string

public static function slugify($string, $separator = '-', $css_mode = false)

lines 516–541 (26)

Converts any accent characters to their equivalent normal characters

and converts any other non-alphanumeric characters to dashes, then converts any sequence of two or more dashes to a single dash. This function generates slugs safe for use as URLs, and if you pass true as the second parameter, it will create strings safe for use as CSS classes or IDs.

Returns: (none declared) — string

public static function seems_utf8($string)

lines 554–565 (12)

Checks to see if a string is utf8 encoded.

NOTE: This function checks for 5-Byte sequences, UTF8

    has Bytes Sequences with a maximum length of 4.

Written by Tony Ferrara <http://blog.ircmaxwell.com>

Returns: (none declared) — boolean

protected static function seemsUtf8Regex($string)

lines 573–592 (20)

A non-Mbstring UTF-8 checker.

Returns: (none declared) — bool

public static function size_format($bytes, $decimals = 0)

lines 601–620 (20)

Nice formatting for computer sizes (Bytes).

Returns: (none declared) — string

public static function maybe_serialize($data)

lines 628–635 (8)

Serialize data, if needed.

Returns: (none declared) — mixed

public static function maybe_unserialize($data)

lines 643–684 (42)

Unserialize value only if it is serialized.

Returns: (none declared) — mixed

public static function is_serialized($data)

lines 695–721 (27)

Check value to find if it was serialized.

If $data is not an string, then returned value will always be false. Serialized data is always a string.

Returns: (none declared) — boolean

public static function fix_broken_serialization($brokenSerializedData)

lines 735–743 (9)

Unserializes partially-corrupted arrays that occur sometimes. Addresses

specifically the `unserialize(): Error at offset xxx of yyy bytes` error.

NOTE: This error can *frequently* occur with mismatched character sets and higher-than-ASCII characters.

Contributed by Theodore R. Smith of PHP Experts, Inc. <http://www.phpexperts.pro/>

Returns: (none declared) — string

public static function is_https()

lines 750–753 (4)

Checks to see if the page is being server over SSL or not

Takes no parameters.

Returns: (none declared) — boolean

public static function add_query_arg($newKey, $newValue = null, $uri = null)

lines 763–822 (60)

Add or remove query arguments to the URL.

Returns: (none declared) — string

public static function remove_query_arg($keys, $uri = null)

lines 831–838 (8)

Removes an item or list from the query string.

Returns: (none declared) — string

public static function http_build_url($url, $parts = array(), $flags = self::HTTP_URL_REPLACE, &$new_url = array())

lines 858–971 (114)

Build a URL.

The parts of the second URL will be merged into the first according to the flags argument.

Returns: (none declared) — string

public static function str_to_bool($string, $default = false)

lines 983–995 (13)

Converts many english words that equate to true or false to boolean.

Supports 'y', 'n', 'yes', 'no' and a few other variations.

Returns: (none declared) — boolean

public static function starts_with($string, $starts_with)

lines 1004–1007 (4)

Check if a string starts with the given string.

Returns: (none declared) — boolean

public static function ends_with($string, $ends_with)

lines 1016–1019 (4)

Check if a string ends with the given string.

Returns: (none declared) — boolean

public static function str_contains($haystack, $needle)

lines 1028–1031 (4)

Check if a string contains another string.

Returns: (none declared) — boolean

public static function str_icontains($haystack, $needle)

lines 1041–1044 (4)

Check if a string contains another string. This version is case

insensitive.

Returns: (none declared) — boolean

public static function get_file_ext($filename)

lines 1052–1055 (4)

Return the file extension of the given filename.

Returns: (none declared) — string

public static function rmdir($dir, $traverseSymlinks = false)

lines 1067–1109 (43)

Removes a directory (and its contents) recursively.

Contributed by Askar (ARACOOL) <https://github.com/ARACOOOL>

Returns: (none declared) — bool

Throws: \RuntimeException

public static function htmlentities($string, $preserve_encoded_entities = false)

lines 1117–1133 (17)

Convert entities, while preserving already-encoded entities.

Returns: (none declared) — string

public static function htmlspecialchars($string, $preserve_encoded_entities = false)

lines 1142–1159 (18)

Convert >, <, ', ” and & to html entities, but preserves entities that

are already encoded.

Returns: (none declared) — string

public static function downcode($text, $language = '')

lines 1172–1200 (29)

Transliterates characters to their ASCII equivalents.

Part of the URLify.php Project <https://github.com/jbroadway/urlify/>

Returns: (none declared) — string Filtered string with replaced “nice” characters

public static function remove_accents($string, $language = '')

lines 1212–1219 (8)

Converts all accent characters to ASCII characters.

If there are no accent characters, then the string given is just returned.

Returns: (none declared) — string Filtered string with replaced “nice” characters

public static function strip_space($string)

lines 1227–1230 (4)

Strip all witespaces from the given string.

Returns: (none declared) — string

public static function sanitize_string($string)

lines 1242–1250 (9)

Sanitize a string by performing the following operation :

\- Remove accents \- Lower the string \- Remove punctuation characters \- Strip whitespaces

Returns: (none declared) — string

public static function zero_pad($number, $length)

lines 1259–1262 (4)

Pads a given string with zeroes on the left.

Returns: (none declared) — string

public static function human_time_diff($from, $to = '', $as_text = false, $suffix = ' ago')

lines 1273–1319 (47)

Converts a unix timestamp to a relative time string, such as “3 days ago”

or “2 weeks ago”.

Returns: (none declared) — string

public static function number_to_word($number)

lines 1330–1384 (55)

Converts a number into the text equivalent. For example, 456 becomes four

hundred and fifty-six.

Part of the IntToWords Project.

Returns: (none declared) — string

protected static function numberToWordConvertGroup($index)

lines 1386–1416 (31)

Returns: (none declared)

protected static function numberToWordThreeDigits($digit1, $digit2, $digit3)

lines 1418–1440 (23)

Returns: (none declared)

protected static function numberToWordTwoDigits($digit1, $digit2)

lines 1442–1508 (67)

Returns: (none declared)

protected static function numberToWordConvertDigit($digit)

lines 1515–1541 (27)

Returns: (none declared) — string

Throws: \LogicException

public static function utf8_headers($content_type = 'text/html')

lines 1549–1560 (12)

Transmit UTF-8 content headers if the headers haven't already been sent.

Returns: (none declared) — boolean

public static function force_download($filename, $content = false)

lines 1574–1610 (37)

Transmit headers that force a browser to display the download file

dialog. Cross browser compatible. Only fires if headers have not already been sent.

Returns: (none declared) — boolean

public static function nocache_headers()

lines 1621–1635 (15)

Sets the headers to prevent caching for the different browsers.

Different browsers support different nocache headers, so several headers must be sent so that all of them get the point that no caching should occur

Takes no parameters.

Returns: (none declared) — boolean

public static function random_string($length = 16, $human_friendly = true, $include_symbols = false, $no_duplicate_chars = false)

lines 1659–1709 (51)

Generates a string of random characters.

Returns: (none declared) — string

Throws: LengthException

public static function secure_random_string($length = 16)

lines 1721–1736 (16)

Generate secure random string of given length

If 'openssl_random_pseudo_bytes' is not available then generate random string using default function

Part of the Laravel Project <https://github.com/laravel/laravel>

Returns: (none declared) — bool

public static function match_string($pattern, $string, $caseSensitive = true)

lines 1747–1763 (17)

Check if a given string matches a given pattern.

Contributed by Abhimanyu Sharma <https://github.com/abhimanyusharma003>

Returns: (none declared) — bool

public static function validate_email($possible_email)

lines 1771–1774 (4)

Validate an email address.

Returns: (none declared) — bool

public static function get_gravatar($email, $size = 32)

lines 1783–1794 (12)

Return the URL to a user's gravatar.

Returns: (none declared) — string

public static function linkify($text)

lines 1804–1821 (18)

Turns all of the links in a string into HTML links.

Part of the LinkifyURL Project <https://github.com/jmrware/LinkifyURL>

Returns: (none declared) — string

protected static function linkifyRegex($text)

lines 1831–1877 (47)

Callback for the preg_replace in the linkify() method.

Part of the LinkifyURL Project <https://github.com/jmrware/LinkifyURL>

Returns: (none declared) — string

protected static function linkifyCallback($matches)

lines 1887–1894 (8)

Callback for the preg_replace in the linkify() method.

Part of the LinkifyURL Project <https://github.com/jmrware/LinkifyURL>

Returns: (none declared) — string

public static function get_current_url()

lines 1901–1952 (52)

Return the current URL.

Takes no parameters.

Returns: (none declared) — string

public static function get_client_ip($trust_proxy_headers = false)

lines 1964–1979 (16)

Returns the IP address of the client.

Returns: (none declared) — string

public static function safe_truncate($string, $length, $append = '...')

lines 1990–2004 (15)

Truncate a string to a specified length without cutting a word off.

Returns: (none declared) — string

public static function limit_characters($string, $limit = 100, $append = '...')

lines 2015–2022 (8)

Truncate the string to given length of charactes.

Returns: (none declared) — string

public static function limit_words($string, $limit = 100, $append = '...')

lines 2032–2041 (10)

Truncate the string to given length of words.

Returns: (none declared) — string

public static function ordinal($number, $locale)

lines 2049–2057 (9)

Returns the ordinal version of a number (appends th, st, nd, rd).

Returns: (none declared) — string

public static function full_permissions($file, $perms = null)

lines 2067–2124 (58)

Returns the file permissions as a nice string, like -rw-r–r– or false

if the file is not found.

Returns: (none declared) — string

public static function array_first(array $array)

lines 2132–2135 (4)

Returns the first element in an array.

Returns: (none declared) — mixed

public static function array_last(array $array)

lines 2143–2146 (4)

Returns the last element in an array.

Returns: (none declared) — mixed

public static function array_first_key(array $array)

lines 2154–2159 (6)

Returns the first key in an array.

Returns: (none declared) — int&#124;string

public static function array_last_key(array $array)

lines 2167–2172 (6)

Returns the last key in an array.

Returns: (none declared) — int&#124;string

public static function array_flatten(array $array, $preserve_keys = true)

lines 2185–2198 (14)

Flatten a multi-dimensional array into a one dimensional array.

Contributed by Theodore R. Smith of PHP Experts, Inc. <http://www.phpexperts.pro/>

Returns: (none declared) — array

public static function array_pluck(array $array, $field, $preserve_keys = true, $remove_nomatches = true)

lines 2214–2243 (30)

Accepts an array, and returns an array of values from that array as

specified by $field. For example, if the array is full of objects and you call util::array_pluck($array, 'name'), the function will return an array of values from $array[]→name.

Returns: (none declared) — array

public static function array_search_deep(array $array, $search, $field = false)

lines 2256–2289 (34)

Searches for a given value in an array of arrays, objects and scalar

values. You can optionally specify a field of the nested arrays and objects to search in.

Returns: (none declared) — boolean&#124;scalar False on failure or the array key on success

public static function array_map_deep(array $array, $callback, $on_nonscalar = false)

lines 2304–2316 (13)

Returns an array containing all the elements of arr1 after applying

the callback function to each one.

Returns: (none declared) — array

public static function array_clean(array $array)

lines 2318–2321 (4)

Returns: (none declared)

protected static function mbInternalEncoding($encoding = null)

lines 2330–2339 (10)

Wrapper to prevent errors if the user doesn't have the mbstring

extension installed.

Returns: (none declared) — string

public static function set_writable($filename, $writable = true)

lines 2349–2391 (43)

Set the writable bit on a file to the minimum value that allows the user

running PHP to write to it.

Returns: (none declared) — boolean

public static function set_readable($filename, $readable = true)

lines 2401–2443 (43)

Set the readable bit on a file to the minimum value that allows the user

running PHP to read to it.

Returns: (none declared) — boolean

public static function set_executable($filename, $executable = true)

lines 2453–2495 (43)

Set the executable bit on a file to the minimum value that allows the

user running PHP to read to it.

Returns: (none declared) — boolean

public static function directory_size($dir)

lines 2503–2512 (10)

Returns size of a given directory in bytes.

Returns: (none declared) — integer

public static function get_user_directory()

lines 2519–2526 (8)

Returns a home directory of current user.

Takes no parameters.

Returns: (none declared) — string

public static function directory_contents($dir)

lines 2534–2542 (9)

Returns all paths inside a directory.

Returns: (none declared) — array

This page is generated from source by 'tools/gendoc'. Edits will be overwritten.