Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
mBaseApplication Class Reference
Inheritance diagram for mBaseApplication:
mApplication mModularApplication Application

Public Member Functions

 __construct ()
 run ()
 getName ()
 getVersion ()
 getAuthors ()
 getCopyright ()

Protected Member Functions

 onInitialize ()
 onDestroy ()
 onExecute ()
 onException ($e)

Protected Attributes

 $app_name = ''
 $app_version = '1.0'
 $app_authors = array()
 $app_copyright = ''

Constructor & Destructor Documentation

Object Constructor


Member Function Documentation

getAuthors ( ) [final]

Returns the names of the authors of the application public

Returns:
array An array of author names
getCopyright ( ) [final]

Returns the copyright notice of the application public

Returns:
string
getName ( ) [final]

Returns the name of the application public

Returns:
string
getVersion ( ) [final]

Returns the version of the application public

Returns:
string
onDestroy ( ) [protected]

This method must be implemented in the derivated class This method is called last (after the onExecute() method) No exception should be thrown within this method, its only goal is to possibly free some resources protected

Reimplemented in mApplication, and mModularApplication.

onException ( e) [protected]

This method must be implemented in the derivated class This method is called whenever an exceptions occurs in onInitialize or onExecute Please note that the onDestroy() method will still be called afterwards. protected

Reimplemented in Application, and mModularApplication.

onExecute ( ) [abstract, protected]

This method must be implemented in the derivated class Main logic of the application. Throws an application from within this method to exit the application protected

onInitialize ( ) [protected]

This method must be implemented in the derivated class It is called first (prior to the onExecute() method) Throw an Exception from this method to immediatelly stop the application (in which case onDestroy() will be gracefuly called) protected

Reimplemented in Application, mApplication, and mModularApplication.

run ( ) [final]

Core method of the application. public


Field Documentation

$app_authors = array() [protected]
$app_copyright = '' [protected]
$app_name = '' [protected]
$app_version = '1.0' [protected]

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