Helper Class Reference

Inheritance diagram for Helper:

Object AjaxHelper CacheHelper FormHelper HtmlHelper JavascriptHelper NumberHelper TextHelper TimeHelper

List of all members.


Public Member Functions

 afterRender ()
 assign ($keyName, $values)
 loadConfig ()
 output ($str, $return=false)
 readConfigFile ($fileName)

Public Attributes

 $tags

Detailed Description

Definition at line 37 of file helper.php.


Member Function Documentation

Helper::afterRender (  ) 

After render callback. Overridden in subclasses.

Returns:
void

Reimplemented in AjaxHelper, and JavascriptHelper.

Definition at line 164 of file helper.php.

Helper::assign ( keyName,
values 
)

Assigns values to tag templates.

Finds a tag template by $keyName, and replaces $values's keys with $values's keys.

Parameters:
string $keyName Name of the key in the tag array.
array $values Values to be inserted into tag.
Returns:
string Tag with inserted values.

Definition at line 115 of file helper.php.

Helper::loadConfig (  ) 

Parses custom config/tags.ini.php and merges with $this->tags.

Returns:
html tags used by helpers

Definition at line 80 of file helper.php.

References $tags, and readConfigFile().

Helper::output ( str,
return = false 
)

Decides whether to output or return a string.

Based on AUTO_OUTPUT and $return's value, this method decides whether to output a string, or return it.

Parameters:
string $str String to be output or returned.
boolean $return Whether this method should return a value or output it.
Returns:
mixed Either string or echos the value, depends on AUTO_OUTPUT and $return.

Definition at line 98 of file helper.php.

Referenced by HtmlHelper::charset(), TimeHelper::dayAsSql(), TimeHelper::daysAsSql(), AjaxHelper::div(), AjaxHelper::divEnd(), TimeHelper::isThisYear(), TimeHelper::isToday(), TimeHelper::isTomorrow(), TimeHelper::nice(), TimeHelper::niceShort(), TimeHelper::relativeTime(), TimeHelper::timeAgoInWords(), TimeHelper::toAtom(), TimeHelper::toRSS(), TimeHelper::toUnix(), HtmlHelper::url(), TimeHelper::wasWithinLast(), and TimeHelper::wasYesterday().

Helper::readConfigFile ( fileName  ) 

Returns an array of settings in given INI file.

Parameters:
string $fileName ini file to read
Returns:
array of lines from the $fileName

Definition at line 124 of file helper.php.

Referenced by loadConfig().


Member Data Documentation

Helper::$tags

Definition at line 44 of file helper.php.

Referenced by loadConfig().


The documentation for this class was generated from the following file: