\

_attributes_to_string()

_attributes_to_string(  $attributes) : string

Attributes To String

Helper function used by some of the form helpers

Parameters

Returns

_error_handler()

_error_handler(integer  $severity, string  $message, string  $filepath, integer  $line) : void

Error Handler

This is the custom error handler that is declared at the (relative) top of CodeIgniter.php. The main reason we use this is to permit PHP errors to be logged in our own log files since the user may not have access to server logs. Since this function effectively intercepts PHP errors, however, we also need to display errors based on the current error_reporting level. We do that with the use of a PHP error template.

Parameters

_exception_handler()

_exception_handler(\Exception  $exception) : void

Exception Handler

Sends uncaught exceptions to the logger and displays them only if display_errors is On so that they don't show up in production environments.

Parameters

_get_validation_object()

_get_validation_object() : mixed

Validation Object

Determines what the form validation class was instantiated as, fetches the object and returns it.

Returns

_list()

_list(  $type = 'ul',   $list = array(),   $attributes = '',   $depth) : string

Generates the list

Generates an HTML ordered list from an single or multi-dimensional array.

Parameters

Returns

_parse_form_attributes()

_parse_form_attributes(array  $attributes, array  $default) : string

Parse the form attributes

Helper function used by some of the form helpers

Parameters

Returns

_shutdown_handler()

_shutdown_handler() : void

Shutdown Handler

This is the shutdown handler that is declared at the top of CodeIgniter.php. The main reason we use this is to simulate a complete custom exception handler.

E_STRICT is purposively neglected because such events may have been caught. Duplication or none? None is preferred for now.

_stringify_attributes()

_stringify_attributes(  $attributes,   $js = FALSE) : string

Stringify attributes for use in HTML tags.

Helper function used to convert a string, array, or object of attributes to a string.

Parameters

Returns

alternator()

alternator() : string

Alternator

Allows strings to be alternated. See docs...

Returns

anchor()

anchor(  $uri = '',   $title = '',   $attributes = '') : string

Anchor Link

Creates an anchor based on the local URL.

Parameters

Returns

anchor_popup()

anchor_popup(  $uri = '',   $title = '',   $attributes = FALSE) : string

Anchor Link - Pop-up version

Creates an anchor based on the local URL. The link opens a new window based on the attributes specified.

Parameters

Returns

array_column()

array_column(array  $array, mixed  $column_key, mixed  $index_key = NULL) : array

array_column()

Parameters

Returns

ascii_to_entities()

ascii_to_entities(string  $str) : string

High ASCII to Entities

Converts high ASCII text and MS Word special characters to character entities

Parameters

Returns

auto_link()

auto_link(  $str,   $type = 'both',   $popup = FALSE) : string

Auto-linker

Automatically links URL and Email addresses. Note: There's a bit of extra code here to deal with URLs or emails that end in a period. We'll strip these off and add them after the link.

Parameters

Returns

auto_typography()

auto_typography(string  $str, boolean  $reduce_linebreaks = FALSE) : string

Auto Typography Wrapper Function

Parameters

Returns

base_url()

base_url(string  $uri = '', string  $protocol = NULL) : string

Base URL

Create a local URL based on your basepath. Segments can be passed in as a string or an array, same as site_url or a URL to a file can be passed in, e.g. to an image file.

Parameters

Returns

byte_format()

byte_format(  $num,   $precision = 1) : string

Formats a numbers as bytes, based on size, and adds the appropriate suffix

Parameters

Returns

camelize()

camelize(string  $str) : string

Camelize

Takes multiple words separated by spaces or underscores and camelizes them

Parameters

Returns

character_limiter()

character_limiter(  $str,   $n = 500,   $end_char = '…') : string

Character Limiter

Limits the string based on the character count. Preserves complete words so the character count may not be exactly as specified.

Parameters

Returns

config_item()

config_item(  $item) : mixed

Returns the specified config item

Parameters

Returns

convert_accented_characters()

convert_accented_characters(string  $str) : string

Convert Accented Foreign Characters to ASCII

Parameters

Returns

create_captcha()

create_captcha(array  $data = '', string  $img_path = '', string  $img_url = '', string  $font_path = '') : string

Create CAPTCHA

Parameters

Returns

current_url()

current_url() : string

Current URL

Returns the full URL (including segments) of the page where this function is placed

Returns

date_range()

date_range(  $unix_start = '',   $mixed = '',   $is_unix = TRUE,   $format = 'Y-m-d') : array

Date range

Returns a list of dates within a specified period.

Parameters

Returns

days_in_month()

days_in_month(  $month,   $year = '') : integer

Number of days in a month

Takes a month/year as input and returns the number of days for the given month/year. Takes leap years into consideration.

Parameters

Returns

DB()

DB(string|array<mixed,string>  $params = '', boolean  $query_builder_override = NULL) 

Initialize the database

Parameters

delete_cookie()

delete_cookie(  $name,   $domain = '',   $path = '/',   $prefix = '') : void

Delete a COOKIE

Parameters

delete_files()

delete_files(string  $path, boolean  $del_dir = FALSE, boolean  $htdocs = FALSE, integer  $_level) : boolean

Delete Files

Deletes all files contained in the supplied directory path. Files must be writable or owned by the system in order to be deleted. If the second parameter is set to TRUE, any directories contained within the supplied base directory will be nuked as well.

Parameters

Returns

directory_map()

directory_map(string  $source_dir, integer  $directory_depth, boolean  $hidden = FALSE) : array

Create a Directory Map

Reads the specified directory and builds an array representation of it. Sub-folders contained with the directory will be mapped as well.

Parameters

Returns

doctype()

doctype(  $type = 'html5') : string

Doctype

Generates a page document type declaration

Examples of valid options: html5, xhtml-11, xhtml-strict, xhtml-trans, xhtml-frame, html4-strict, html4-trans, and html4-frame. All values are saved in the doctypes config file.

Parameters

Returns

element()

element(  $item, array  $array,   $default = NULL) : mixed

Element

Lets you determine whether an array index is set and whether it has a value. If the element is empty it returns NULL (or whatever you specify as the default value.)

Parameters

Returns

depends on what the array contains

elements()

elements(  $items, array  $array,   $default = NULL) : mixed

Elements

Returns only the array items specified. Will return a default value if it is not set.

Parameters

Returns

depends on what the array contains

ellipsize()

ellipsize(  $str,   $max_length,   $position = 1,   $ellipsis = '…') : string

Ellipsize String

This function will strip tags from a string, split it at its max_length and ellipsize

Parameters

Returns

ellipsized string

encode_php_tags()

encode_php_tags(  $str) : string

Convert PHP tags to entities

Parameters

Returns

entities_to_ascii()

entities_to_ascii(  $str,   $all = TRUE) : string

Entities to ASCII

Converts character entities back to ASCII

Parameters

Returns

entity_decode()

entity_decode(  $str,   $charset = NULL) : string

HTML Entities Decode

This function is a replacement for html_entity_decode()

Parameters

Returns

force_download()

force_download(  $filename = '',   $data = '',   $set_mime = FALSE) : void

Force Download

Generates headers that force a download to happen

Parameters

form_button()

form_button(  $data = '',   $content = '',   $extra = '') : string

Form Button

Parameters

Returns

form_checkbox()

form_checkbox(  $data = '',   $value = '',   $checked = FALSE,   $extra = '') : string

Checkbox Field

Parameters

Returns

form_close()

form_close(  $extra = '') : string

Form Close Tag

Parameters

Returns

form_dropdown()

form_dropdown(mixed  $data = '', mixed  $options = array(), mixed  $selected = array(), mixed  $extra = '') : string

Drop-down Menu

Parameters

Returns

form_error()

form_error(  $field = '',   $prefix = '',   $suffix = '') : string

Form Error

Returns the error for a specific form field. This is a helper for the form validation class.

Parameters

Returns

form_fieldset()

form_fieldset(  $legend_text = '',   $attributes = array()) : string

Fieldset Tag

Used to produce

form_fieldset_close()

form_fieldset_close(  $extra = '') : string

Fieldset Close Tag

Parameters

Returns

form_hidden()

form_hidden(mixed  $name, string  $value = '', boolean  $recursing = FALSE) : string

Hidden Input Field

Generates hidden fields. You can pass a simple key/value string or an associative array with multiple values.

Parameters

Returns

form_input()

form_input(  $data = '',   $value = '',   $extra = '') : string

Text Input Field

Parameters

Returns

form_label()

form_label(  $label_text = '',   $id = '',   $attributes = array()) : string

Form Label Tag

Parameters

Returns

form_multiselect()

form_multiselect(  $name = '',   $options = array(),   $selected = array(),   $extra = '') : string

Multi-select menu

Parameters

Returns

form_open()

form_open(  $action = '',   $attributes = array(),   $hidden = array()) : string

Form Declaration

Creates the opening portion of the form.

Parameters

Returns

form_open_multipart()

form_open_multipart(  $action = '',   $attributes = array(),   $hidden = array()) : string

Form Declaration - Multipart type

Creates the opening portion of the form, but with "multipart/form-data".

Parameters

Returns

form_password()

form_password(  $data = '',   $value = '',   $extra = '') : string

Password Field

Identical to the input function but adds the "password" type

Parameters

Returns

form_radio()

form_radio(  $data = '',   $value = '',   $checked = FALSE,   $extra = '') : string

Radio Button

Parameters

Returns

form_reset()

form_reset(  $data = '',   $value = '',   $extra = '') : string

Reset Button

Parameters

Returns

form_submit()

form_submit(  $data = '',   $value = '',   $extra = '') : string

Submit Button

Parameters

Returns

form_textarea()

form_textarea(mixed  $data = '', string  $value = '', mixed  $extra = '') : string

Textarea field

Parameters

Returns

form_upload()

form_upload(  $data = '',   $extra = '') : string

Upload Field

Identical to the input function but adds the "file" type

Parameters

Returns

function_usable()

function_usable(string  $function_name) : boolean

Function usable

Executes a function_exists() check, and if the Suhosin PHP extension is loaded - checks whether the function that is checked might be disabled in there as well.

This is useful as function_exists() will return FALSE for functions disabled via the disable_functions php.ini setting, but not for suhosin.executor.func.blacklist and suhosin.executor.disable_eval. These settings will just terminate script execution if a disabled function is executed.

The above described behavior turned out to be a bug in Suhosin, but even though a fix was committed for 0.9.34 on 2012-02-12, that version is yet to be released. This function will therefore be just temporary, but would probably be kept for a few years.

Parameters

Returns

TRUE if the function exists and is safe to call, FALSE otherwise.

get_config()

get_config(array  $replace = array()) : array

Loads the main config.php file

This function lets us grab the config file even if the Config class hasn't been instantiated yet

Parameters

Returns

get_cookie()

get_cookie(  $index,   $xss_clean = FALSE) : mixed

Fetch an item from the COOKIE array

Parameters

Returns

get_dir_file_info()

get_dir_file_info(  $source_dir,   $top_level_only = TRUE,   $_recursion = FALSE) : array

Get Directory File Information

Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions

Any sub-folders contained within the specified path are read as well.

Parameters

Returns

get_file_info()

get_file_info(  $file,   $returned_values = array('name', 'server_path', 'size', 'date')) : array

Get File Info

Given a file and path, returns the name, path, size, date modified Second parameter allows you to explicitly declare what information you want returned Options are: name, server_path, size, date, readable, writable, executable, fileperms Returns FALSE if the file cannot be found.

Parameters

Returns

get_filenames()

get_filenames(  $source_dir,   $include_path = FALSE,   $_recursion = FALSE) : array

Get Filenames

Reads the specified directory and builds an array containing the filenames. Any sub-folders contained within the specified path are read as well.

Parameters

Returns

get_instance()

get_instance() : \CI_Controller

Reference to the CI_Controller method.

Returns current CI instance object

Returns

get_mime_by_extension()

get_mime_by_extension(string  $filename) : string

Get Mime by Extension

Translates a file extension into a mime type based on config/mimes.php. Returns FALSE if it can't determine the type, or open the mime config file

Note: this is NOT an accurate way of determining file mime types, and is here strictly as a convenience It should NOT be trusted, and should certainly NOT be used for security

Parameters

Returns

get_mimes()

get_mimes() : array

Returns the MIME types array from config/mimes.php

Returns

gmt_to_local()

gmt_to_local(  $time = '',   $timezone = 'UTC',   $dst = FALSE) : integer

Converts GMT time to a localized value

Takes a Unix timestamp (in GMT) as input, and returns at the local value based on the timezone and DST setting submitted

Parameters

Returns

hash_equals()

hash_equals(string  $known_string, string  $user_string) : boolean

hash_equals()

Parameters

Returns

hash_pbkdf2()

hash_pbkdf2(string  $algo, string  $password, string  $salt, integer  $iterations, integer  $length, boolean  $raw_output = FALSE) : string

hash_pbkdf2()

Parameters

Returns

heading()

heading(  $data = '',   $h = '1',   $attributes = '') : string

Heading

Generates an HTML heading tag.

Parameters

Returns

highlight_code()

highlight_code(  $str) : string

Code Highlighter

Colorizes code strings

Parameters

Returns

highlight_phrase()

highlight_phrase(string  $str, string  $phrase, string  $tag_open = '<mark>', string  $tag_close = '</mark>') : string

Phrase Highlighter

Highlights a phrase within a text string

Parameters

Returns

html_escape()

html_escape(mixed  $var, boolean  $double_encode = TRUE) : mixed

Returns HTML escaped variable.

Parameters

Returns

The escaped string or array of strings as a result.

human_to_unix()

human_to_unix(  $datestr = '') : integer

Convert "human" date to GMT

Reverses the above process

Parameters

Returns

humanize()

humanize(string  $str, string  $separator = '_') : string

Humanize

Takes multiple words separated by the separator and changes them to spaces

Parameters

Returns

img()

img(  $src = '',   $index_page = FALSE,   $attributes = '') : string

Image

Generates an element

Parameters

Returns

increment_string()

increment_string(  $str,   $separator = '_',   $first = 1) : string

Add's _1 to a string or increment the ending number to allow _2, _3, etc

Parameters

Returns

index_page()

index_page() : string

Index page

Returns the "index_page" from your config file

Returns

is_cli()

is_cli() : boolean

Is CLI?

Test to see if a request was made from the command line.

Returns

is_countable()

is_countable(string  $word) : boolean

Checks if the given word has a plural version.

Parameters

Returns

is_false()

is_false(mixed  $test) : boolean

Helper function to test boolean FALSE

Parameters

Returns

is_https()

is_https() : boolean

Is HTTPS?

Determines if the application is accessed via an encrypted (HTTPS) connection.

Returns

is_loaded()

is_loaded(  $class = '') : array

Keeps track of which libraries have been loaded. This function is called by the load_class() function above

Parameters

Returns

is_php()

is_php(  $version) : boolean

Determines if the current version of PHP is equal to or greater than the supplied value

Parameters

Returns

TRUE if the current version is $version or higher

is_really_writable()

is_really_writable(  $file) : boolean

Tests for file writability

is_writable() returns TRUE on Windows servers when you really can't write to the file, based on the read-only attribute.

Parameters

Returns

is_true()

is_true(mixed  $test) : boolean

Helper function to test boolean TRUE

Parameters

Returns

lang()

lang(string  $line, string  $for = '', array  $attributes = array()) : string

Lang

Fetches a language variable and optionally outputs a form label

Parameters

Returns

link_tag()

link_tag(  $href = '',   $rel = 'stylesheet',   $type = 'text/css',   $title = '',   $media = '',   $index_page = FALSE) : string

Link

Generates link to a CSS file

Parameters

Returns

load_class()

load_class(  $class,   $directory = 'libraries',   $param = NULL) : object

Class registry

This function acts as a singleton. If the requested class does not exist it is instantiated and set to a static variable. If it has previously been instantiated the variable is returned.

Parameters

Returns

local_to_gmt()

local_to_gmt(  $time = '') : integer

Converts a local Unix timestamp to GMT

Parameters

Returns

log_message()

log_message(  $level,   $message) : void

Error Logging Interface

We use this as a simple mechanism to access the logging class and send messages to be logged.

Parameters

mailto()

mailto(  $email,   $title = '',   $attributes = '') : string

Mailto Link

Parameters

Returns

mb_strlen()

mb_strlen(string  $str, string  $encoding = NULL) : integer

mb_strlen()

WARNING: This function WILL fall-back to strlen() if iconv is not available!

Parameters

Returns

mb_strpos()

mb_strpos(string  $haystack, string  $needle, integer  $offset, string  $encoding = NULL) : mixed

mb_strpos()

WARNING: This function WILL fall-back to strpos() if iconv is not available!

Parameters

Returns

mb_substr()

mb_substr(string  $str, integer  $start, integer  $length = NULL, string  $encoding = NULL) : string

mb_substr()

WARNING: This function WILL fall-back to substr() if iconv is not available.

Parameters

Returns

mdate()

mdate(  $datestr = '',   $time = '') : integer

Convert MySQL Style Datecodes

This function is identical to PHPs date() function, except that it allows date codes to be formatted using the MySQL style, where each code letter is preceded with a percent sign: %Y %m %d etc...

The benefit of doing dates this way is that you don't have to worry about escaping your text letters that match the date codes.

Parameters

Returns

meta()

meta(  $name = '',   $content = '',   $type = 'name',   $newline = "\n") : string

Generates meta tags from an array of key/values

Parameters

Returns

mysql_to_unix()

mysql_to_unix(  $time = '') : integer

Converts a MySQL Timestamp to Unix

Parameters

Returns

Unix timstamp

nice_date()

nice_date(  $bad_date = '',   $format = FALSE) : string

Turns many "reasonably-date-like" strings into something that is actually useful. This only works for dates after unix epoch.

Parameters

Returns

nl2br_except_pre()

nl2br_except_pre(  $str) : string

Convert newlines to HTML line breaks except within PRE tags

Parameters

Returns

now()

now(  $timezone = NULL) : integer

Get "now" time

Returns time() based on the timezone parameter or on the "time_reference" setting

Parameters

Returns

octal_permissions()

octal_permissions(integer  $perms) : string

Octal Permissions

Takes a numeric value representing a file's permissions and returns a three character string representing the file's octal permissions

Parameters

Returns

odbc_fetch_array()

odbc_fetch_array(  $result, integer  $rownumber = 1) : array

ODBC Fetch array

Emulates the native odbc_fetch_array() function when it is not available (odbc_fetch_array() requires unixODBC)

Parameters

Returns

odbc_fetch_object()

odbc_fetch_object(  $result, integer  $rownumber = 1) : object

ODBC Fetch object

Emulates the native odbc_fetch_object() function when it is not available.

Parameters

Returns

ol()

ol(  $list,   $attributes = '') : string

Ordered List

Generates an HTML ordered list from an single or multi-dimensional array.

Parameters

Returns

ordinal_format()

ordinal_format(integer  $number) : string

Returns the English ordinal numeral for a given number

Parameters

Returns

password_get_info()

password_get_info(string  $hash) : array

password_get_info()

Parameters

Returns

password_hash()

password_hash(string  $password, integer  $algo, array  $options = array()) : mixed

password_hash()

Parameters

Returns

password_needs_rehash()

password_needs_rehash(string  $hash, integer  $algo, array  $options = array()) : boolean

password_needs_rehash()

Parameters

Returns

password_verify()

password_verify(string  $password, string  $hash) : boolean

password_verify()

Parameters

Returns

plural()

plural(string  $str) : string

Plural

Takes a singular word and makes it plural

Parameters

Returns

prep_url()

prep_url(  $str = '') : string

Prep URL

Simply adds the http:// part if no scheme is included

Parameters

Returns

quotes_to_entities()

quotes_to_entities(  $str) : string

Quotes to Entities

Converts single and double quotes to entities

Parameters

Returns

random_element()

random_element(  $array) : mixed

Random Element - Takes an array as input and returns a random element

Parameters

Returns

depends on what the array contains

random_string()

random_string(  $type = 'alnum',   $len = 8) : string

Create a "Random" String

Parameters

Returns

redirect()

redirect(string  $uri = '', string  $method = 'auto', integer  $code = NULL) : void

Header Redirect

Header redirect in two flavors For very fine grained control over headers, you could use the Output Library's set_header() function.

Parameters

reduce_double_slashes()

reduce_double_slashes(  $str) : string

Reduce Double Slashes

Converts double slashes in a string to a single slash, except those found in http://

http://www.some-site.com//index.php

becomes:

http://www.some-site.com/index.php

Parameters

Returns

reduce_multiples()

reduce_multiples(  $str,   $character = ',',   $trim = FALSE) : string

Reduce Multiples

Reduces multiple instances of a particular character. Example:

Fred, Bill,, Joe, Jimmy

becomes:

Fred, Bill, Joe, Jimmy

Parameters

Returns

remove_invisible_characters()

remove_invisible_characters(  $str,   $url_encoded = TRUE) : string

Remove Invisible Characters

This prevents sandwiching null characters between ascii characters, like Java\0script.

Parameters

Returns

safe_mailto()

safe_mailto(  $email,   $title = '',   $attributes = '') : string

Encoded Mailto Link

Create a spam-protected mailto link written in Javascript

Parameters

Returns

sanitize_filename()

sanitize_filename(  $filename) : string

Sanitize Filename

Parameters

Returns

set_checkbox()

set_checkbox(  $field,   $value = '',   $default = FALSE) : string

Set Checkbox

Let's you set the selected value of a checkbox via the value in the POST array. If Form Validation is active it retrieves the info from the validation class

Parameters

Returns

set_cookie()

set_cookie(  $name,   $value = '',   $expire,   $domain = '',   $path = '/',   $prefix = '',   $secure = NULL,   $httponly = NULL) : void

Set cookie

Accepts seven parameters, or you can submit an associative array in the first parameter containing all the values.

Parameters

set_radio()

set_radio(string  $field, string  $value = '', boolean  $default = FALSE) : string

Set Radio

Let's you set the selected value of a radio field via info in the POST array. If Form Validation is active it retrieves the info from the validation class

Parameters

Returns

set_realpath()

set_realpath(  $path,   $check_existance = FALSE) : string

Set Realpath

Parameters

Returns

set_select()

set_select(  $field,   $value = '',   $default = FALSE) : string

Set Select

Let's you set the selected value of a menu via data in the POST array. If Form Validation is active it retrieves the info from the validation class

Parameters

	$field
	$value
	$default

Returns

string

set_status_header()

set_status_header(  $code = 200,   $text = '') : void

Set HTTP Status Header

Parameters

	$code
	$text

set_value()

set_value(string  $field, string  $default = '', boolean  $html_escape = TRUE) : string

Form Value

Grabs a value from the POST array for the specified field so you can re-populate an input field or textarea. If Form Validation is active it retrieves the info from the validation class

Parameters

string	$field	Field name
string	$default	Default value
boolean	$html_escape	Whether to escape HTML special characters or not

Returns

string

show_404()

show_404(  $page = '',   $log_error = TRUE) : void

404 Page Handler

This function is similar to the show_error() function above However, instead of the standard error template it displays 404 errors.

Parameters

	$page
	$log_error

show_error()

show_error(  $message,   $status_code = 500,   $heading = 'An Error Was Encountered') : void

Error Handler

This function lets us invoke the exception class and display errors using the standard error template located in application/views/errors/error_general.php This function will send the error page directly to the browser and exit.

Parameters

	$message
	$status_code
	$heading

singular()

singular(string  $str) : string

Singular

Takes a plural word and makes it singular

Parameters

string

$str

Input string

Returns

string

site_url()

site_url(string  $uri = '', string  $protocol = NULL) : string

Site URL

Create a local URL based on your basepath. Segments can be passed via the first parameter either as a string or an array.

Parameters

string	$uri
string	$protocol

Returns

string

strip_image_tags()

strip_image_tags(  $str) : string

Strip Image Tags

Parameters

$str

Returns

string

strip_quotes()

strip_quotes(  $str) : string

Strip Quotes

Removes single and double quotes from a string

Parameters

$str

Returns

string

strip_slashes()

strip_slashes(  $str) : mixed

Strip Slashes

Removes slashes contained in a string or in an array

Parameters

$str

Returns

mixed —

string or array

symbolic_permissions()

symbolic_permissions(integer  $perms) : string

Symbolic Permissions

Takes a numeric value representing a file's permissions and returns standard symbolic notation representing that value

Parameters

integer

$perms

Permissions

Returns

string

timespan()

timespan(  $seconds = 1,   $time = '',   $units = 7) : string

Timespan

Returns a span of seconds in this format: 10 days 14 hours 36 minutes 47 seconds

Parameters

	$seconds
	$time
	$units

Returns

string

timezone_menu()

timezone_menu(  $default = 'UTC',   $class = '',   $name = 'timezones',   $attributes = '') : string

Timezone Menu

Generates a drop-down menu of timezones.

Parameters

	$default
	$class
	$name
	$attributes

Returns

string

timezones()

timezones(  $tz = '') : string

Timezones

Returns an array of timezones. This is a helper function for various other ones in this library

Parameters

$tz

Returns

string

ul()

ul(  $list,   $attributes = '') : string

Unordered List

Generates an HTML unordered list from an single or multi-dimensional array.

Parameters

	$list
	$attributes

Returns

string

underscore()

underscore(string  $str) : string

Underscore

Takes multiple words separated by spaces and underscores them

Parameters

string

$str

Input string

Returns

string

unix_to_human()

unix_to_human(  $time = '',   $seconds = FALSE,   $fmt = 'us') : string

Unix to "Human"

Formats Unix timestamp to the following prototype: 2006-08-21 11:35 PM

Parameters

	$time
	$seconds
	$fmt

Returns

string

uri_string()

uri_string() : string

URL String

Returns the URI segments.

Returns

string

url_title()

url_title(string  $str, string  $separator = '-', boolean  $lowercase = FALSE) : string

Create URL Title

Takes a "title" string as input and creates a human-friendly URL string with a "separator" string as the word separator.

Parameters

string	$str	Input string
string	$separator	Word separator (usually '-' or '_')
boolean	$lowercase	Whether to transform the output string to lowercase

Returns

string

validation_errors()

validation_errors(  $prefix = '',   $suffix = '') : string

Validation Error String

Returns all the errors associated with a form submission. This is a helper function for the form validation class.

Parameters

	$prefix
	$suffix

Returns

string

word_censor()

word_censor(  $str,   $censored,   $replacement = '') : string

Word Censoring Function

Supply a string and an array of disallowed words and any matched words will be converted to #### or to the replacement word you've submitted.

Parameters

	$str
	$censored
	$replacement

Returns

string

word_limiter()

word_limiter(  $str,   $limit = 100,   $end_char = '…') : string

Word Limiter

Limits a string to X number of words.

Parameters

	$str
	$limit
	$end_char

Returns

string

word_wrap()

word_wrap(string  $str, integer  $charlim = 76) : string

Word Wrap

Wraps text at the specified character. Maintains the integrity of words. Anything placed between {unwrap}{/unwrap} will not be word wrapped, nor will URLs.

Parameters

string	$str	the text string
integer	$charlim	= 76 the number of characters to wrap at

Returns

string

write_file()

write_file(string  $path, string  $data, string  $mode = 'wb') : boolean

Write File

Writes data to the file specified in the path. Creates a new file if non-existent.

Parameters

string	$path	File path
string	$data	Data to write
string	$mode	fopen() mode (default: 'wb')

Returns

boolean

xml_convert()

xml_convert(  $str,   $protect_all = FALSE) : string

Convert Reserved XML characters to Entities

Parameters

	$str
	$protect_all

Returns

string

xss_clean()

xss_clean(  $str,   $is_image = FALSE) : string

XSS Filtering

Parameters

	$str
	$is_image

Returns

string