Docs For Class Tool

Description

Tool is a static wrapper for utility classes

Tools are loosely coupled utility functions that can be called statically. You should put any function that does not fit into an object model into a tool and bundle them in task-dependant Tool classes.

Tools are never instanciated directly. You register a tool class in the static Toolbox object and use a single tool function by calling the employ() method of the Toolbox object.

see: Toolbox

Located in /tool.php (line 23)

PHOOL
   |
   --Tool

Direct descendents

Class	Description
Iconvtool	The Validation Tool is a Collection of loose validation functions
Validation	The Validation Tool is a Collection of loose validation functions

Variable Summary

mixed $signature

Method Summary

Tool Tool ()

void loadfile (string $file, [array $context = array( )])

void setup ()

void signature ()

void __call ( $name, $args)

Variables

mixed $signature (line 28)

Tool function signature array

access: protected

Inherited Variables

Inherited from PHOOL

PHOOL::$debug
PHOOL::$errorlabels
PHOOL::$errorlevels
PHOOL::$errors
PHOOL::$exists
PHOOL::$logdir
PHOOL::$loglevel
PHOOL::$objname

Methods

Constructor Tool (line 33)

Construct a utility object

Tool Tool ()

loadfile (line 72)

Load an external library into a tool object

void loadfile (string $file, [array $context = array( )])

string $file: path to api file
array $context: variable context to be imported on api include

setup (line 60)

Optional tool setup function

void setup ()

signature (line 42)

Create tool function signature and return

void signature ()

__call (line 97)

Dynamic callback for ext api loader

void __call ( $name, $args)

$name
$args

Inherited Methods

Inherited From PHOOL

PHOOL::PHOOL()
PHOOL::debug()
PHOOL::error()
PHOOL::get_errors()
PHOOL::handle_error()
PHOOL::has_error()
PHOOL::log_error()
PHOOL::set_debug()
PHOOL::set_logdir()
PHOOL::set_loglevel()

Class Constants

Inherited Constants

Inherited from PHOOL

PHOOL::ERROR
PHOOL::UNKNOWN
PHOOL::USER
PHOOL::WARNING