ZF Class Reference

Public Member Functions
	bootstrap ()
	bootstrap() More...
	run ()
	run() More...

Static Public Member Functions
static	main ()

Protected Member Functions
	_detectMode ()
	_detectMode() More...
	_detectHomeDirectory ($mustExist=true, $returnMessages=true)
	_detectHomeDirectory() - detect the home directory in a variety of different places More...
	_detectStorageDirectory ($mustExist=true, $returnMessages=true)
	_detectStorageDirectory() - Detect where the storage directory is from a variaty of possiblities More...
	_detectConfigFile ($mustExist=true, $returnMessages=true)
	_detectConfigFile() - Detect config file location from a variety of possibilities More...
	_setupPHPRuntime ()
	_setupPHPRuntime() - parse the config file if it exists for php ini values to set More...
	_setupToolRuntime ()
	_setupToolRuntime() - setup the tools include_path and load the proper framwork parts that enable Zend_Tool to work. More...
	_tryClientLoad ()
	_tryClientLoad() - Attempt to load the Zend_Tool_Framework_Client_Console to enable the tool to run. More...
	_runError ()
	_runError() - Output the error screen that tells the user that the tool was not setup in a sane way More...
	_runInfo ()
	_runInfo() - this command will produce information about the setup of this script and Zend_Tool More...
	_runSetup ()
	_runSetup() - parse the request to see which setup command to run More...
	_runSetupStorageDirectory ()
	_runSetupStorageDirectory() - if the storage directory does not exist, create it More...
	_runSetupConfigFile ()
	_runSetupConfigFile() More...
	_runSetupMoreInfo ()
	_runSetupMoreInfo() - return more information about what can be setup, and what is setup More...
	_runTool ()
	_runTool() - This is where the magic happens, dispatch Zend_Tool More...
	_logMessage ($message, $storeMessage=true)
	_logMessage() - Internal method used to log setup and information messages. More...

Protected Attributes
	$_clientLoaded = false
	$_mode = 'runTool'
	$_messages = array()
	$_homeDirectory = null
	$_storageDirectory = null
	$_configFile = null

Detailed Description

Definition at line 32 of file zf.php.

Member Function Documentation

ZF::_detectConfigFile (   $mustExist = true,   $returnMessages = true  )

protected

_detectConfigFile() - Detect config file location from a variety of possibilities

Parameters

bool	$mustExist	Should the returned value already exist in the file system
bool	$returnMessages	Should it log messages for output later

Returns

string

Definition at line 235 of file zf.php.

ZF::_detectHomeDirectory (   $mustExist = true,   $returnMessages = true  )

protected

_detectHomeDirectory() - detect the home directory in a variety of different places

Parameters

bool	$mustExist	Should the returned value already exist in the file system
bool	$returnMessages	Should it log messages for output later

Returns

string

Definition at line 141 of file zf.php.

ZF::_detectMode ( )

protected

_detectMode()

Returns

ZF

Definition at line 106 of file zf.php.

ZF::_detectStorageDirectory (   $mustExist = true,   $returnMessages = true  )

protected

_detectStorageDirectory() - Detect where the storage directory is from a variaty of possiblities

Parameters

bool	$mustExist	Should the returned value already exist in the file system
bool	$returnMessages	Should it log messages for output later

Returns

string

Definition at line 199 of file zf.php.

ZF::_logMessage (   $message,   $storeMessage = true  )

protected

_logMessage() - Internal method used to log setup and information messages.

Parameters

string	$message
bool	$storeMessage

Returns

void

Definition at line 587 of file zf.php.

ZF::_runError ( )

protected

_runError() - Output the error screen that tells the user that the tool was not setup in a sane way

Returns

void

Definition at line 379 of file zf.php.

ZF::_runInfo ( )

protected

_runInfo() - this command will produce information about the setup of this script and Zend_Tool

Returns

void

Definition at line 414 of file zf.php.

ZF::_runSetup ( )

protected

_runSetup() - parse the request to see which setup command to run

Returns

void

Definition at line 435 of file zf.php.

ZF::_runSetupConfigFile ( )

protected

_runSetupConfigFile()

Returns

void

Definition at line 477 of file zf.php.

ZF::_runSetupMoreInfo ( )

protected

_runSetupMoreInfo() - return more information about what can be setup, and what is setup

Returns

void

Definition at line 508 of file zf.php.

ZF::_runSetupStorageDirectory ( )

protected

_runSetupStorageDirectory() - if the storage directory does not exist, create it

Returns

void

Definition at line 457 of file zf.php.

ZF::_runTool ( )

protected

_runTool() - This is where the magic happens, dispatch Zend_Tool

Returns

void

Definition at line 562 of file zf.php.

ZF::_setupPHPRuntime ( )

protected

_setupPHPRuntime() - parse the config file if it exists for php ini values to set

Returns

void

Definition at line 280 of file zf.php.

ZF::_setupToolRuntime ( )

protected

_setupToolRuntime() - setup the tools include_path and load the proper framwork parts that enable Zend_Tool to work.

Returns

void

Definition at line 312 of file zf.php.

ZF::_tryClientLoad ( )

protected

_tryClientLoad() - Attempt to load the Zend_Tool_Framework_Client_Console to enable the tool to run.

This method will return false if its not loaded to allow the consumer to alter the environment in such a way that it can be called again to try loading the proper file/class.

Returns

bool if the client is actuall loaded or not

Definition at line 357 of file zf.php.

ZF::bootstrap

(

)

bootstrap()

Returns

ZF

Definition at line 59 of file zf.php.

static ZF::main ( )

static

Definition at line 47 of file zf.php.

ZF::run

(

)

run()

Returns

ZF

Definition at line 77 of file zf.php.

Member Data Documentation

ZF::$_clientLoaded = false

protected

Definition at line 35 of file zf.php.

ZF::$_configFile = null

protected

Definition at line 45 of file zf.php.

ZF::$_homeDirectory = null

protected

Definition at line 41 of file zf.php.

ZF::$_messages = array()

protected

Definition at line 39 of file zf.php.

ZF::$_mode = 'runTool'

protected

Definition at line 37 of file zf.php.

ZF::$_storageDirectory = null

protected

Definition at line 43 of file zf.php.

---

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

• /home/doug/src/hypertable/examples/php/microblog/htdocs/bin/zf.php