Class Bluewater_Helper

Overview

Controller Helper Class

Multiline description can go here and it will be picked up as written. DON'T!! but a blank line betwen the desc text and the CVS/SVN info below, unless you don't this info in your phpDocs

author: Walter Torres <walter@torres.ws>
version: $Revision: 1.0 $
PHPUnit: Not Defined
usedby: Bluewater_Config::__construct()
example: example not found

Located in /helper.php (line 59)


	
    		        
Properties Summary
static string $_class
Method Summary
void __construct (void 0)
void _loadHelper (string $_className)
string _upper_first (string $_str)
mixed __call (string $_method, array $_args)
Properties
static string $_class = '' (line 76)

Helper Class name

since: 1.0
access: private
usedby: Bluewater_Helper::_loadHelper()
usedby: Bluewater_Helper::__call()
Methods
Constructor __construct (line 92)

Class Constructor is empty on purpose

final:
access: public
void __construct (void 0)
  • void 0
_loadHelper (line 162)

Load HELP Class files

Each file corresponds to an individual Helper Method. The Class name of these "helper" files should be defined as: class Helper_{Helper_Name} Each Helper calss must have a "helper" method defined. This method does the setup or actual work.

final:
access: private
usedby: Bluewater_Helper::__call()
uses: Bluewater_Helper::_upper_first()
uses: Bluewater_Helper::$_class
uses: APP
uses: BLUEWATER
uses: BLUEWATER
uses: APP
void _loadHelper (string $_className)
  • string $_className: Name of Helper Class to utilize
_upper_first (line 217)

Helper class to capitalize first letter of sentence/word.

Simple quick function to make a sentence/word into a Sentence Case, first letter is capitalize all others are lower case. Yes, PHP has "ucfirst()", but it has a flaw; it does not effect any other letters of a given string. If any of them are uppercase, they stay uppercase. This method forces all letters to lower and then caps the first.

Yes, this should, and is, a HELPER, but this class doesn't have access to the HELPERs.

return: String that was changed
final:
access: private
usedby: Bluewater_Helper::_loadHelper()
string _upper_first (string $_str)
  • string $_str: String to change word case on
__call (line 118)

Magical PHP Method to call unknown methods within an unknown class.

return: Whatever operation Helper Class performs
author: Walter Torres <walter@torres.ws>
PHPUnit: Not Defined
since: 1.0
final:
access: public
uses: Bluewater_Helper::$_class
uses: Bluewater_Helper::_loadHelper()
mixed __call (string $_method, array $_args)
  • string $_method: Method to call
  • array $_args: An array of arguements to send to method

Documentation generated on Tue, 18 Aug 2009 02:30:17 -0500 by phpDocumentor 1.4.2