Docs For Class P4A

Description

THE APPLICATION.

Stands for the currently running istance of the application.

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

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

P4A_Object
   |
   --P4A

Variable Summary

object object $active_mask

object object $active_object

array $browser_identification

boolean $handheld

i18n $i18n

boolean $internet_explorer

array $libraries

object object $masks

object object $masks_history

array $objects

array $timer

string $title

integer $_action_history_id

mixed $_ajax_enabled

array $_css

mixed $_do_refresh

mixed $_in_ajax_call

array $_javascript

mixed $_popup

mixed $_redesign_popup

mixed $_to_redesign

Method Summary

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

void addJavascript (string $uri)

void close ()

void closePopup ([ $destroy = FALSE])

void detectClient ()

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

void dropJavascript (string $uri)

void dumpTimer ()

integer getActionHistoryId ()

void getFocusedObjectId ()

void &getObject ( $object_id)

void &getPrevMask ()

string getTitle ()

string getVersion ()

boolean inAjaxCall ()

void initTimer ()

void isAjaxEnabled ()

void isHandheld ()

void isInternetExplorer ()

boolean isPopupOpened ()

void main ()

void maskExists (string $mask_name)

void &openMask ( $mask_name)

void openPopup ( $mask_name)

void p4a ()

void raiseXMLResponse ()

void redesign ( $id)

void restart ()

void setActiveMask (string $mask_name)

void setActiveObject (object object &$object)

void setTitle (string $title)

void showPrevMask ()

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

void store (object object &$object)

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

Variables

object object $active_mask = NULL (line 69)

Pointer to the currently active mask.

access: public

object object $active_object = NULL (line 62)

The currently active object.

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

access: public

array $browser_identification = array() (line 148)

Find wich browser is the user using

access: public

boolean $handheld = false (line 134)

Is the browser a handheld?

access: private

i18n $i18n = array() (line 91)

I18n objects and methods.

see: P4A_I18N
access: public

boolean $internet_explorer = false (line 141)

Is the browser Internet Explorer?

access: private

array $libraries = array() (line 106)

Loaded libraries registry.

A library is a file in P4A_APPLICATION_LIBRARIES_DIR wich is included every time.

access: private

object object $masks = null (line 83)

Opened masks are stored here.

access: public

object object $masks_history = array() (line 76)

History of opened masks

access: public

array $objects = array() (line 53)

All P4A objects are stored here.

access: public

array $timer = array() (line 113)

Timers container.

access: private

string $title = NULL (line 98)

Application's title.

access: private

integer $_action_history_id = 0 (line 155)

Counter to avoid browser's back/forward

access: private

mixed $_ajax_enabled = P4A_AJAX_ENABLED (line 159)

array $_css = array() (line 120)

CSS container.

access: private

mixed $_do_refresh = false (line 164)

mixed $_in_ajax_call = false (line 160)

array $_javascript = array() (line 127)

javascript container.

access: private

mixed $_popup = null (line 162)

mixed $_redesign_popup = false (line 158)

mixed $_to_redesign = array() (line 157)

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

addCss (line 765)

Include CSS

access: public

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

string $uri: The URI of CSS.
string $media: The CSS media.

addJavascript (line 794)

Include a javascript file

access: public

void addJavascript (string $uri)

string $uri: The URI of file.

close (line 301)

Destroys P4A data.

access: public

void close ()

closePopup (line 654)

Closes the popup mask.

access: public

void closePopup ([ $destroy = FALSE])

$destroy

detectClient (line 228)

void detectClient ()

dropCss (line 779)

Drop inclusion of CSS file

access: public

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

string $uri: The URI of CSS.
string $media: The CSS media.

dropJavascript (line 804)

Drop inclusion of javascript file

access: public

void dropJavascript (string $uri)

string $uri: The URI of CSS.

dumpTimer (line 344)

Prints out all timer values.

access: public

void dumpTimer ()

getActionHistoryId (line 816)

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

access: public

integer getActionHistoryId ()

getFocusedObjectId (line 836)

void getFocusedObjectId ()

getObject (line 729)

void &getObject ( $object_id)

$object_id

getPrevMask (line 689)

Gets an instance of the previous mask

access: public

void &getPrevMask ()

getTitle (line 754)

Returns the title for the application.

access: public

string getTitle ()

getVersion (line 831)

Gets P4A version

return: p4a version
access: public

string getVersion ()

inAjaxCall (line 277)

was the current action called thru ajax?

access: public

boolean inAjaxCall ()

initTimer (line 319)

Inits the timer.

access: public

void initTimer ()

isAjaxEnabled (line 257)

void isAjaxEnabled ()

isHandheld (line 248)

void isHandheld ()

isInternetExplorer (line 243)

void isInternetExplorer ()

isPopupOpened (line 267)

Tells you if there's a popup opened

access: public

boolean isPopupOpened ()

main (line 355)

Executes the main cicle.

access: public

void main ()

maskExists (line 704)

Checks if the desidered mask is in the masks collection.

access: private

void maskExists (string $mask_name)

string $mask_name: The mask's name.

openMask (line 601)

Opens a mask ed sets it active.

access: public

void &openMask ( $mask_name)

$mask_name

openPopup (line 635)

Opens a mask in popup.

access: public

void openPopup ( $mask_name)

$mask_name

p4a (line 170)

Class constructor.

access: private

void p4a ()

raiseXMLResponse (line 504)

void raiseXMLResponse ()

redesign (line 821)

void redesign ( $id)

$id

restart (line 309)

Calls close() and then restart the application.

void restart ()

setActiveMask (line 579)

Sets the desidered mask as active.

access: private

void setActiveMask (string $mask_name)

string $mask_name: The name of the mask.

setActiveObject (line 591)

Sets the desidered object as active.

see: P4A::$active_object
access: private

void setActiveObject (object object &$object)

object object &$object: The object

setTitle (line 744)

Sets the title for the application.

access: public

void setTitle (string $title)

string $title: Mask title.

showPrevMask (line 671)

Sets the previous mask the active mask

access: public

void showPrevMask ()

singleton (line 282)

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

$class_name

store (line 718)

Adds an object to the objects collection.

access: private

void store (object object &$object)

object object &$object: The object.

timer (line 332)

Takes a time snapshot with a given description.

access: public

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

string $description: The description

Inherited Methods

Inherited From P4A_Object

P4A_Object::actionHandler()
P4A_Object::build()
P4A_Object::destroy()
P4A_Object::dropIntercept()
P4A_Object::errorHandler()
P4A_Object::getId()
P4A_Object::getName()
P4A_Object::getObjectType()
P4A_Object::getParentID()
P4A_Object::implementMethod()
P4A_Object::intercept()
P4A_Object::isActionTriggered()
P4A_Object::p4a_object()
P4A_Object::setName()
P4A_Object::setParentID()
P4A_Object::void()
P4A_Object::_loadHelper()
P4A_Object::__call()