Docs For Class P4A

P4A

Description

THE APPLICATION.

Stands for the currently running istance of the application.

author: Fabrizio Balliano <fabrizio.balliano@crealabs.it>
author: Andrea Giardina <andrea.giardina@crealabs.it>
copyright: CreaLabs SNC

Located in /p4a/objects/p4a.php (line 42)

P4A_Object
   |
   --P4A

Class Constant Summary

BROWSER_GECKO = 'gecko'

BROWSER_HANDHELD = 'handheld'

BROWSER_IE = 'ie'

BROWSER_LINUX = 'linux'

BROWSER_MAC = 'mac'

BROWSER_OPERA = 'opera'

BROWSER_SAFARI = 'safari'

BROWSER_WINDOWS = 'windows'

Variable Summary

P4A_Mask $active_mask

P4A_Object $active_object

string $browser

string $browser_os

P4A_I18N $i18n

P4A_Collection $masks

array $masks_history

array $messages

array $objects

array $timer

string $title

integer $_action_history_id

array $_css

array $_javascript

boolean $_redesign_whole_mask

array $_to_redesign

Method Summary

static void singleton ([ $class_name = "p4a"])

P4A __construct ()

P4A addCss (string $uri, [string $media = "screen"])

P4A addJavascript (string $uri)

void close ()

void closePopup ([boolean $destroy = false])

array detectClient ()

P4A dropCss (string $uri, [string $media = "screen"])

P4A dropJavascript (string $uri)

void dumpTimer ()

void executeExternalCommands ()

integer getActionHistoryId ()

string getBrowser ()

string getBrowserOS ()

void getCss ()

string getFocusedObjectId ()

array getJavascript ()

string getJavascriptInitializations ()

array getMessages ()

P4A_Object getObject (string $object_id)

P4A_Mask getPrevMask ()

array getRenderedMessages ()

string getTitle ()

string getVersion ()

boolean inAjaxCall ()

void initTimer ()

boolean isGecko ()

boolean isHandheld ()

boolean isInternetExplorer ()

boolean isOpera ()

boolean isPopupOpened ()

boolean isSafari ()

void main ()

boolean maskExists (string $mask_name)

P4A message (string $text, [string $icon = null], [integer $icon_size = 32])

P4A messageError (string $message)

P4A messageInfo (string $message)

P4A messageWarning (string $message)

void openMask ( $mask_name)

void openPopup ( $mask_name)

void raiseXMLResponse ()

P4A redesign (string $id)

void restart ()

void setActiveMask (string $mask_name)

void setActiveObject (P4A_Object $object)

P4A setTitle (string $title)

void showPrevMask ([unknown_type $destroy = false])

P4A store (P4A_Object &$object)

void timer ([string $description = 'TIMER'])

void __wakeup ()

Variables

P4A_Mask $active_mask = null (line 62)

Pointer to the currently active mask

access: public

P4A_Object $active_object = null (line 56)

The currently active object.

This means that here is the pointer to the last object that has triggered an event/action.

access: public

string $browser = null (line 128)

access: private

string $browser_os = self::BROWSER_LINUX (line 133)

access: private

P4A_I18N $i18n = null (line 79)

access: public

P4A_Collection $masks = null (line 74)

Opened masks are stored here

access: public

array $masks_history = array() (line 68)

History of opened masks

access: private

array $messages = array() (line 123)

access: private

array $objects = array() (line 48)

All P4A objects are stored here

access: public

array $timer = array() (line 90)

Timers container

access: private

string $title = null (line 84)

access: private

integer $_action_history_id = 0 (line 108)

Counter to avoid browser's back/forward

access: private

array $_css = array() (line 96)

CSS container

access: private

array $_javascript = array() (line 102)

javascript container

access: private

boolean $_redesign_whole_mask = false (line 118)

access: private

array $_to_redesign = array() (line 113)

access: private

Inherited Variables

Inherited from P4A_Object

P4A_Object::$_helpers
P4A_Object::$_id
P4A_Object::$_map_actions
P4A_Object::$_name
P4A_Object::$_objects
P4A_Object::$_parent_id

Methods

static singleton (line 292)

access: public

void singleton ([ $class_name = "p4a"])

$class_name

Constructor __construct (line 145)

access: public

P4A __construct ()

Redefinition of:

P4A_Object::__construct()

addCss (line 790)

Include a CSS file

access: public

P4A addCss (string $uri, [string $media = "screen"])

string $uri
string $media

addJavascript (line 826)

Includes a javascript file

access: public

P4A addJavascript (string $uri)

string $uri

close (line 321)

Destroys P4A

access: public

void close ()

closePopup (line 688)

Alias for showPrevMask()

access: public

void closePopup ([boolean $destroy = false])

boolean $destroy: completely destroy the mask object?

detectClient (line 186)

access: private

array detectClient ()

dropCss (line 805)

Drops inclusion of a CSS file

access: public

P4A dropCss (string $uri, [string $media = "screen"])

string $uri
string $media

dropJavascript (line 837)

Drops inclusion of a javascript file

access: public

P4A dropJavascript (string $uri)

string $uri

dumpTimer (line 359)

Prints out all timer values

access: public

void dumpTimer ()

executeExternalCommands (line 369)

Never call this method if you don't know what you're doing

access: public

void executeExternalCommands ()

getActionHistoryId (line 884)

Action history ID is used to avoid browser's back/forward

access: public

integer getActionHistoryId ()

getBrowser (line 262)

access: public

string getBrowser ()

getBrowserOS (line 270)

access: public

string getBrowserOS ()

getCss (line 816)

access: public

void getCss ()

getFocusedObjectId (line 911)

deprecated:
access: public

string getFocusedObjectId ()

getJavascript (line 848)

access: public

array getJavascript ()

getJavascriptInitializations (line 857)

Returns the Javascript code neede for P4A initialization

access: public

string getJavascriptInitializations ()

getMessages (line 972)

Returns all the messages and clean the queue

access: public

array getMessages ()

getObject (line 756)

access: public

P4A_Object getObject (string $object_id)

string $object_id

getPrevMask (line 715)

Gets an instance of the previous mask

access: public

P4A_Mask getPrevMask ()

getRenderedMessages (line 983)

Returns HTML rendered system messages and clean the queue

access: public

array getRenderedMessages ()

getTitle (line 779)

Returns the title for the application

access: public

string getTitle ()

getVersion (line 902)

access: public

string getVersion ()

inAjaxCall (line 287)

access: public

boolean inAjaxCall ()

initTimer (line 336)

access: public

void initTimer ()

isGecko (line 230)

access: public

boolean isGecko ()

isHandheld (line 238)

access: public

boolean isHandheld ()

isInternetExplorer (line 222)

access: public

boolean isInternetExplorer ()

isOpera (line 246)

access: public

boolean isOpera ()

isPopupOpened (line 279)

deprecated:
access: public

boolean isPopupOpened ()

isSafari (line 254)

access: public

boolean isSafari ()

main (line 474)

access: public

void main ()

maskExists (line 728)

access: public

boolean maskExists (string $mask_name)

string $mask_name

message (line 926)

Outputs a system message to user

access: public

P4A message (string $text, [string $icon = null], [integer $icon_size = 32])

string $text
string $icon
integer $icon_size

messageError (line 950)

Prints out an error message (with an error icon).

It's a wrapper for P4A::message()

access: public

P4A messageError (string $message)

string $message

messageInfo (line 962)

Prints out an info message (with an info icon).

It's a wrapper for P4A::message()

access: public

P4A messageInfo (string $message)

string $message

messageWarning (line 938)

Prints out a warning message (with a warning icon).

It's a wrapper for P4A::message()

access: public

P4A messageWarning (string $message)

string $message

openMask (line 640)

access: public

void openMask ( $mask_name)

$mask_name

openPopup (line 670)

access: public

void openPopup ( $mask_name)

$mask_name

raiseXMLResponse (line 564)

Never call this method if you don't know what you're doing

access: public

void raiseXMLResponse ()

redesign (line 893)

access: public

P4A redesign (string $id)

string $id: the id of the object to be redesigned

restart (line 330)

Calls close() and then restart the application

see: P4A::close()
access: public

void restart ()

setActiveMask (line 625)

Sets the desidered mask as active.

access: private

void setActiveMask (string $mask_name)

string $mask_name

setActiveObject (line 634)

Sets the desidered object as active.

access: private

void setActiveObject (P4A_Object $object)

P4A_Object $object

setTitle (line 769)

Sets the title for the application

access: public

P4A setTitle (string $title)

string $title

showPrevMask (line 696)

access: public

void showPrevMask ([unknown_type $destroy = false])

unknown_type $destroy: completely destroy the current mask object?

store (line 741)

Adds an object to the objects collection

access: public

P4A store (P4A_Object &$object)

P4A_Object &$object

timer (line 348)

Takes a time snapshot with a given description

access: public

void timer ([string $description = 'TIMER'])

string $description

__wakeup (line 1001)

access: public

void __wakeup ()

Inherited Methods

Inherited From P4A_Object

P4A_Object::__construct()
P4A_Object::actionHandler()
P4A_Object::build()
P4A_Object::destroy()
P4A_Object::dropImplement()
P4A_Object::dropMethod()
P4A_Object::errorHandler()
P4A_Object::getId()
P4A_Object::getName()
P4A_Object::getObjectType()
P4A_Object::getParentID()
P4A_Object::implement()
P4A_Object::intercept()
P4A_Object::isActionTriggered()
P4A_Object::setName()
P4A_Object::setParentID()
P4A_Object::void()
P4A_Object::_loadHelper()
P4A_Object::__call()

Class Constants

BROWSER_GECKO = 'gecko' (line 135)

BROWSER_HANDHELD = 'handheld' (line 136)

BROWSER_IE = 'ie' (line 137)

BROWSER_LINUX = 'linux' (line 141)

BROWSER_MAC = 'mac' (line 142)

BROWSER_OPERA = 'opera' (line 138)

BROWSER_SAFARI = 'safari' (line 139)

BROWSER_WINDOWS = 'windows' (line 143)

Documentation generated on Tue, 02 Sep 2008 10:04:04 +0200 by phpDocumentor 1.4.2