Class Application

(line 86)

Description

Object
   |
   --Persistent
      |
      --Component
         |
         --Application

Located in File: /forms.inc.php

A class to reference all the forms created on your application.

The Application class holds a reference to all the forms created in your application because the Owner for them is always the global Application object. This class is also used to switch the language for the whole application by using the Language property.

This class is also responsible for session management, if you include a restore_session=1 in your request, the object, when created, will destroy the existing session and will create a new one, so your application will start fresh.



Properties

Summary:
Language Sets the application language, so all forms in the application will share this setting.

Defined in class Component

Name Specifies the name for the component. The name is used as an identifier and should be unique.
Tag A versatile property of every Component that can be used in any way you want
ComponentCount Indicates the number of components owned by the component.
Components Lists all the components owned by this component.
ControlState A flag to know the state of the control, csLoading, csDesigning
DataFieldValue This property returns the value of the datafield if any.
NamePath Specifies the path to uniquely identify a component, qualified by the owner when required.
Owner Indicates the component that is responsible for streaming and freeing this component.

Defined in class Persistent

NamePath Used to serialize/unserialize. It returns the full path to identify this component.
Owner Owner of the component.

property Language (line 114)

string Language

Sets the application language, so all forms in the application will share this setting.

If you want to change the Language property for all your forms at once, you can use this property, as forms take this setting into account when switching language.

This property is of string type and you can set it to anything you want, provided your language files share the same value and your locale resources also share that setting.

  1.  <?php
  2.  global $application;
  3.  $application->Language="English";
  4.  //Now, your forms must have a unit.English.xml.php resource file with your translated strings
  5.  //and also a locale/English/messages.mo to be used for runtime strings
  6.  ?>

Info


property Name

Specifies the name for the component. The name is used as an identifier and should be unique.
This property is implemented in Component::Name

property Tag

A versatile property of every Component that can be used in any way you want
This property is implemented in Component::Tag

property ComponentCount

Indicates the number of components owned by the component.
This property is implemented in Component::ComponentCount

property Components

Lists all the components owned by this component.
This property is implemented in Component::Components

property ControlState

A flag to know the state of the control, csLoading, csDesigning
This property is implemented in Component::ControlState

property DataFieldValue

This property returns the value of the datafield if any.
This property is implemented in Component::DataFieldValue

property NamePath

Specifies the path to uniquely identify a component, qualified by the owner when required.
This property is implemented in Component::NamePath

property Owner

Indicates the component that is responsible for streaming and freeing this component.
This property is implemented in Component::Owner

property NamePath

Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePath

property Owner

Owner of the component.
This property is implemented in Persistent::Owner

Methods

Summary:
__construct Component constructor [Overrides Component::__construct()]
autoDetectLanguage Performs an auto detection of the language used by the user browser and set the Language property accordingly.

Defined in class Component

dumpChildrenJavascript Dumps the javascript code for all the children
dumpFormItems Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
dumpHeaderCode Dumps header code required
dumpJavascript Dumps the javascript code needed by this component
hasValidDataField Returns true if a valid data field is attached to the component
init Initializes a component
loaded Initializes the component after the form file has been read into memory.
loadedChildren Calls childrens loaded
preinit Method called before init()
serializeChildren Serializes all children
unserializeChildren Unserializes all children by calling unserialize for all the components

Defined in class Persistent

serialize Stores this object into the session.
unserialize This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Defined in class Object

__construct Constructs an object and initializes its data before the object is first used.
className Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
classParent Returns the type of the immediate ancestor of a class.

Constructor __construct (line 117)

Application __construct( [ $aowner = null])

Overrides : Component::__construct() Component constructor


Method autoDetectLanguage (line 178)

void autoDetectLanguage( )

Performs an auto detection of the language used by the user browser and set the Language property accordingly.

This method performs a detection operation trying to guess which language is used by the user depending on the browser headers and information is sent.

Can be used to accomodate automatically your application to the right language the user want to get without prompting for it.

Valid languages can be found on language/php_language_detection.php on the function called languages() and you can get such list as an array calling that function in your software

  1.  <?php
  2.       function Button1Click($sender$params)
  3.       {
  4.        global $application;
  5.  
  6.        $application->autoDetectLanguage();
  7.        echo $application->Language;
  8.        //This echoes in the browser "Spanish (Traditional Sort)"
  9.       }
  10.  ?>

Info

  • see - languages

Events

Summary:

[none]

Javascript Events

Summary:

[none]

Documentation generated on Fri, 26 Dec 2008 11:45:15 +0100 by phpDocumentor 1.4.0a2