Docs for page Functions.php

/application/helpers/Functions.php

Description

version: $Id$
copyright: Center for History and New Media, 2007-2008
filesource: Source Code for this file
license: http://www.gnu.org/licenses/gpl-3.0.txt

Functions

auto_discovery_link_tag (line 40)

Output a <link> tag for the RSS feed so the browser can auto-discover the field.

return: HTML
since: 0.9
uses: items_output_uri()

string auto_discovery_link_tag ()

common (line 53)

Includes a file from the common/ directory, passing variables into that script.

void common (string $file, [array $vars = array()], [string $dir = 'common'])

string $file: Filename
array $vars: A keyed array of variables to be extracted into the script
string $dir: Defaults to 'common'

current_action_contexts (line 217)

Get all output formats available in the current action.

return: A sorted list of contexts.

array current_action_contexts ()

flash (line 91)

Retrieve a flashed message from the controller

string flash ([boolean $wrap = true])

boolean $wrap: Whether or not to wrap the flashed message in a div with an appropriate class ('success','error','alert')

foot (line 80)

Include the footer script into the view

void foot ([array $vars = array()], [string $file = 'footer'])

string $file: Filename of footer script (defaults to 'footer')
array $vars: Keyed array of variables

head (line 68)

Include the header script into the view

see: common()

void head ([array $vars = array()], [string $file = 'header'])

string $file: Filename of header script (defaults to 'header')
array $vars: Keyed array of variables

is_odd (line 28)

Simple math for determining whether a number is odd or even

bool is_odd ( $num)

$num

loop_records (line 151)

Loops through a specific record set, setting the current record to a globally accessible scope and returning it. the current call to loop_records (i. will release the previously-returned item).

Loops through a specific record set, setting the current record to a globally accessible scope and returning it. Records are only valid for the current call to loop_records (i.e., the next call to loop_records() will release the previously-returned item).

return: The current record
see: loop_collections()
see: loop_files_for_item()
see: loop_items()
since: 0.10

mixed loop_records (string $recordType, mixed $records)

string $recordType: The type of record to loop through
mixed $records: The iterable set of records

output_format_list (line 233)

Builds an HTML list containing all available output format contexts for the current action.

return: HTML

string output_format_list ([bool $list = true], [string $delimiter = ' | '])

bool $list: True = unordered list; False = use delimiter
string $delimiter: If the first argument is false, use this as a delimiter.

settings (line 130)

Retrieve the value of a particular site setting. any option that would be retrieved with get_option().

Retrieve the value of a particular site setting. This can be used to display any option that would be retrieved with get_option(). Content for any specific option can be filtered by using a filter named 'display_setting_(option)' where (option) is the name of the option, e.g. 'display_setting_site_title'.

since: 0.9
uses: get_option()

string settings ( $name)

$name

Documentation generated on Thu, 15 Oct 2009 15:37:41 -0400 by phpDocumentor 1.4.2