Class STPHPApplication

STPHPObject
   |
   --STPHPApplication

Classes extended from STPHPApplication:

Located in File: Program_Root/stphpapplication.php


The class that represents an application


Class Variable Summary
$author
The author of the application
Default Value: -><-
$copyright
The copyright of the application
Default Value: -><-
$language
The language of the application
Default Value: -><-
$locale
The localization object
Default Value: -><-
$localeBasePath
The localization base path
Default Value: -><-
$localeDefaultLanguage
The localization default language
Default Value: -><-
$localeKeyLanguage
The localization key language
Default Value: -><-
$localizationActive
The status of the localization support
Default Value: -><-
$sess_id
The sessions id of the application
Default Value: -><-
$theme
The theme of the application
Default Value: -><-
$title
The title of the application
Default Value: -><-
$version
The version of the application
Default Value: -><-
$wndMain
The pointer to the main window
Default Value: -><-

Inherited Class Variable Summary
Inherited From Class STPHPObject
Variable Default Value Description
$name -><- The name of the object

Inherited Method Summary
Inherited From Class STPHPObject
Function Description
constructor STPHPObject ( [$name = ] ) Creates the object
dtor ( ) Destructor
errorLog ( $message ) Print an error to the log system
getName ( ) Returns the name of the object

Method Summary
STPHPApplication constructor STPHPApplication ( $name )
Creates the object
void activateLocalization ( )
Activate the localization support
void deactivateLocalization ( )
Deactivate the localization support
void dtor ( )
Destructor
string getAuthor ( )
Gets the author of the application
string getCopyright ( )
Gets the copyright of the application
string getLanguage ( )
Gets the language of the application
string getLocaleKeyLanguage ( )
Gets the language of the keys localization file
string getLocaleText ( $text )
Return a translated string
void getSessionVariable ( $variable )
Sets a variable in the session
string getTheme ( )
Gets the theme of the application
string getTitle ( )
Gets the title of the application
string getVersion ( )
Gets the version of the application
void init ( [$compress = TRUE] )
Starts the application
bool localizationIsActive ( )
Returns if the localization support is active
void setAuthor ( $value )
Sets the author of the application
void setCopyright ( $value )
Sets the copyright of the application
void setLanguage ( $value )
Sets the language of the application
void setLocaleBasePath ( $localeBasePath )
Sets the base path for the localization files
void setLocaleDefaultLanguage ( $localeDefaultLanguage )
Sets the default language for the application
void setLocaleKeyLanguage ( $localeKeyLanguage )
Sets the language of the keys localization files
void setSessionVariable ( $variable, $value )
Sets a variable in the session
void setTheme ( $value )
Sets the theme of the application
void setTitle ( $value )
Sets the title of the application
void setVersion ( $value )
Sets the version of the application
void setWndMain ( &$window )
Sets the main window of the application
Variable Detail

$author

Data type: string
The author of the application


$copyright

Data type: string
The copyright of the application


$language

Data type: string
The language of the application


$locale

Data type: STPHPLocale
The localization object


$localeBasePath

Data type: string
The localization base path


$localeDefaultLanguage

Data type: string
The localization default language


$localeKeyLanguage

Data type: string
The localization key language


$localizationActive

Data type: bool
The status of the localization support


$sess_id

Data type: string
The sessions id of the application


$theme

Data type: string
The theme of the application


$title

Data type: string
The title of the application


$version

Data type: string
The version of the application


$wndMain

Data type: STPHPWindow
The pointer to the main window



Method Detail

constructor STPHPApplication

STPHPApplication constructor STPHPApplication ( $name )

Creates the object

Function Parameters:
- string $name:
Function Info:
Access - public

activateLocalization

void activateLocalization ( )

Activate the localization support

Function Parameters:
Function Info:
Access - public

deactivateLocalization

void deactivateLocalization ( )

Deactivate the localization support

Function Parameters:
Function Info:
Access - public

dtor

void dtor ( )

Overrides: STPHPObject::dtor()

Destructor
Destroys all the resources associated with the object
Function Parameters:
Function Info:
Access - public

getAuthor

string getAuthor ( )

Gets the author of the application

Function Parameters:
Function Info:
Return - The author
Access - public

getCopyright

string getCopyright ( )

Gets the copyright of the application

Function Parameters:
Function Info:
Return - The copyright
Access - public

getLanguage

string getLanguage ( )

Gets the language of the application

Function Parameters:
Function Info:
Return - The language
Access - public

getLocaleKeyLanguage

string getLocaleKeyLanguage ( )

Gets the language of the keys localization file

Function Parameters:
Function Info:
Return - The key language
Access - public

getLocaleText

string getLocaleText ( $text )

Return a translated string

Function Parameters:
- string $text: The text to translate
Function Info:
Return - The translated value
Access - public

getSessionVariable

void getSessionVariable ( $variable )

Sets a variable in the session

Function Parameters:
- string $variable: The variable name to set
- string $value: The variable value to set
Function Info:
Access - public

getTheme

string getTheme ( )

Gets the theme of the application

Function Parameters:
Function Info:
Return - The theme
Access - public

getTitle

string getTitle ( )

Gets the title of the application

Function Parameters:
Function Info:
Return - The title
Access - public

getVersion

string getVersion ( )

Gets the version of the application

Function Parameters:
Function Info:
Return - The version
Access - public

init

void init ( [$compress = TRUE] )

Starts the application

Function Parameters:
- bool $compress: TRUE if the output must be compressed (new line and tab characters removed)
Function Info:
Access - public

localizationIsActive

bool localizationIsActive ( )

Returns if the localization support is active

Function Parameters:
Function Info:
Access - public

setAuthor

void setAuthor ( $value )

Sets the author of the application

Function Parameters:
- string $value: The author
Function Info:
Access - public

setCopyright

void setCopyright ( $value )

Sets the copyright of the application

Function Parameters:
- string $value: The copyright
Function Info:
Access - public

setLanguage

void setLanguage ( $value )

Sets the language of the application

Function Parameters:
- string $value: The language
Function Info:
Access - public

setLocaleBasePath

void setLocaleBasePath ( $localeBasePath )

Sets the base path for the localization files

Function Parameters:
- string $localeBasePath: The base path
Function Info:
Access - public

setLocaleDefaultLanguage

void setLocaleDefaultLanguage ( $localeDefaultLanguage )

Sets the default language for the application

Function Parameters:
- string $localeDefaultLanguage: The default language
Function Info:
Access - public

setLocaleKeyLanguage

void setLocaleKeyLanguage ( $localeKeyLanguage )

Sets the language of the keys localization files

Function Parameters:
- string $value: The theme
Function Info:
Access - public

setSessionVariable

void setSessionVariable ( $variable, $value )

Sets a variable in the session

Function Parameters:
- string $variable: The variable name to set
- string $value: The variable value to set
Function Info:
Access - public

setTheme

void setTheme ( $value )

Sets the theme of the application

Function Parameters:
- string $value: The theme
Function Info:
Access - public

setTitle

void setTitle ( $value )

Sets the title of the application

Function Parameters:
- string $value: The title
Function Info:
Access - public

setVersion

void setVersion ( $value )

Sets the version of the application

Function Parameters:
- string $value: The version
Function Info:
Access - public

setWndMain

void setWndMain ( &$window )

Sets the main window of the application

Function Parameters:
- STPHPWindow &$window: The pointer to the main window
Function Info:
Access - public