From 6ea993425cc0982ecef765d4bfc6b75b7206416d Mon Sep 17 00:00:00 2001 From: xue <> Date: Wed, 28 Dec 2005 13:11:07 +0000 Subject: --- .../protected/pages/Configurations/AppConfig.page | 14 ++--- .../protected/pages/Configurations/PageConfig.page | 6 +- .../protected/pages/Configurations/Templates1.page | 12 ++-- .../protected/pages/Configurations/Templates2.page | 8 +-- .../protected/pages/Configurations/Templates3.page | 8 +-- .../protected/pages/Controls/Overview.page | 2 +- .../protected/pages/Fundamentals/Applications.page | 28 ++++----- .../protected/pages/Fundamentals/Components.page | 71 +++++++++++++++++++--- .../protected/pages/Fundamentals/Controls.page | 14 ++--- .../protected/pages/Fundamentals/Modules.page | 14 ++--- .../protected/pages/Fundamentals/Pages.page | 4 +- .../protected/pages/Fundamentals/Services.page | 12 ++-- .../protected/pages/Samples/HelloWorld.page | 2 +- 13 files changed, 125 insertions(+), 70 deletions(-) (limited to 'demos/quickstart/protected/pages') diff --git a/demos/quickstart/protected/pages/Configurations/AppConfig.page b/demos/quickstart/protected/pages/Configurations/AppConfig.page index dc4675f1..101e449c 100644 --- a/demos/quickstart/protected/pages/Configurations/AppConfig.page +++ b/demos/quickstart/protected/pages/Configurations/AppConfig.page @@ -5,7 +5,7 @@ Application configurations are used to specify the global behavior of an application. They include specification of path aliases, namespace usages, module and service configurations, and parameters.
-Configuration for an application is stored in an XML file named application.xml
, which should be located under the application base path. Its format is shown in the following,
+Configuration for an application is stored in an XML file named application.xml, which should be located under the application base path. Its format is shown in the following,
<application PropertyName="PropertyValue" ...>
<paths>
@@ -24,17 +24,17 @@ Configuration for an application is stored in an XML file named applicatio
</application>
<application>
corresponds to the TApplication
instance. The PropertyName="PropertyValue"
pairs specify the initial values for the properties of TApplication
.<paths>
element contains the definition of path aliases and the PHP inclusion paths for the application. Each path alias is specified via an <alias>
whose path
attribute takes an absolute path or a path relative to the directory containing the application configuration file. The <using>
element specifies a particular path (in terms of namespace) to be appended to the PHP include paths when the application runs. PRADO defines two default aliases: System
and Application
. The former refers to the PRADO framework root directory, and the latter refers to the directory containing the application configuration file.<modules>
element contains the configurations for a list of modules. Each module is specified by a <module>
element. Each module is uniquely identified by the id
attribute and is of type class
. The PropertyName="PropertyValue"
pairs specify the initial values for the properties of the module.<services>
element is similar to the <modules>
element. It mainly specifies the services provided by the application.<parameters>
element contains a list of application-level parameters that are accessible from anywhere in the application. You may specify component-typed parameters like specifying modules, or you may specify string-typed parameters which take a simpler format as follows,
+<parameter id="ParameterID">ParameterValue</parameter>
THttpRequest
, THttpResponse
, etc. It will also provide the TPageService
as a default service. Configuration and usage of these modules and services are covered in individual sections of this tutorial. Note, if your application takes default settings for these modules and service, you do not need to provide an application configuration. However, if these modules or services are not sufficient, or you want to change their behavior by configuring their property values, you will need an application configuration.
+By default without explicit configuration, a PRADO application when running will load a few core modules, such as THttpRequest, THttpResponse, etc. It will also provide the TPageService as a default service. Configuration and usage of these modules and services are covered in individual sections of this tutorial. Note, if your application takes default settings for these modules and service, you do not need to provide an application configuration. However, if these modules or services are not sufficient, or you want to change their behavior by configuring their property values, you will need an application configuration.
\ No newline at end of file
diff --git a/demos/quickstart/protected/pages/Configurations/PageConfig.page b/demos/quickstart/protected/pages/Configurations/PageConfig.page
index e6a6afaf..a7d0ef8e 100644
--- a/demos/quickstart/protected/pages/Configurations/PageConfig.page
+++ b/demos/quickstart/protected/pages/Configurations/PageConfig.page
@@ -2,10 +2,10 @@
-Page configurations are mainly used by TPageService
to modify or append the application configuration. As the name indicates, a page configuration is associated with a directory storing some page files. It is stored as an XML file named config.xml
.
+Page configurations are mainly used by TPageService to modify or append the application configuration. As the name indicates, a page configuration is associated with a directory storing some page files. It is stored as an XML file named config.xml.
-When a user requests a page stored under <BasePath>/dir1/dir2
, the TPageService
will try to parse and load config.xml
files under <BasePath>/dir1
and <BasePath>/dir1/dir2
. Paths, modules, and parameters specified in these configuration files will be appended or merged into the existing application configuration.
+When a user requests a page stored under <BasePath>/dir1/dir2, the TPageService will try to parse and load config.xml files under <BasePath>/dir1 and <BasePath>/dir1/dir2. Paths, modules, and parameters specified in these configuration files will be appended or merged into the existing application configuration.
The format of a page configuration file is as follows,
@@ -30,7 +30,7 @@ The format of a page configuration file is as follows,
</parameters>
</configuration>
-The <paths>
, <modules>
and <parameters>
are similar to those in an application configuration. The <authorization>
specifies the authorization rules that apply to the current page directory and all its subdirectories. It will be explained in more detail in future sections. The <pages>
element specifies the initial values for the properties of pages. Each <page>
element specifies the initial property values for a particular page identified by the id
<pages> element apply to all pages in the current directory and all its subdirectories.
+The <paths>, <modules> and <parameters> are similar to those in an application configuration. The <authorization> specifies the authorization rules that apply to the current page directory and all its subdirectories. It will be explained in more detail in future sections. The <pages> element specifies the initial values for the properties of pages. Each <page> element specifies the initial property values for a particular page identified by the id<pages> element apply to all pages in the current directory and all its subdirectories.
-Templates are used to specify the presentational layout of controls. A template can contain static text, components, or controls that contribute to the ultimate presentation of the associated control. By default, an instance of TTemplateControl
or its subclass may automatically load a template from a file whose name is the same as the control class name. For page templates, the file name suffix must be .page
; for other regular template controls, the suffix is .tpl
.
+Templates are used to specify the presentational layout of controls. A template can contain static text, components, or controls that contribute to the ultimate presentation of the associated control. By default, an instance of TTemplateControl or its subclass may automatically load a template from a file whose name is the same as the control class name. For page templates, the file name suffix must be .page; for other regular template controls, the suffix is .tpl.
The template format is like HTML, with a few PRADO-specifc tags, including component tags, template control tags, comment tags, dynamic content tags, and dynamic property tags. .
@@ -18,10 +18,10 @@ The format of a component tag is as follows, body content </com:ComponentType> -ComponentType
can be either the class name or the dotted type name (e.g. System.Web.UI.TControl
) of the component. PropertyName
and EventName
are both case-insensitive. PropertyName
can be a property or subproperty name (e.g. Font.Name
). Note, PropertyValue
will be HTML-decoded when assigned to the corresponding property. Content enclosed between the opening and closing component tag are normally treated the body of the component.
+ComponentType can be either the class name or the dotted type name (e.g. System.Web.UI.TControl) of the component. PropertyName and EventName are both case-insensitive. PropertyName can be a property or subproperty name (e.g. Font.Name). Note, PropertyValue will be HTML-decoded when assigned to the corresponding property. Content enclosed between the opening and closing component tag are normally treated the body of the component.
-It is required that component tags nest properly with each other and an opening component tag be paired with a closing tag, similar to that in XML. The following shows a component tag specifying the Text
property and Click
event of a button control,
+It is required that component tags nest properly with each other and an opening component tag be paired with a closing tag, similar to that in XML. The following shows a component tag specifying the Text property and Click event of a button control,
<com:TButton Text="Register" Click="registerUser" />@@ -33,7 +33,7 @@ To deal conveniently with properties taking take big trunk of initial data, the PropertyValue </prop:PropertyName> -It is equivalent to
...PropertyName="PropertyValue"...
in a component tag. Property initialization tags must be directly enclosed between the corresponding opening and closing component tag.
+It is equivalent to ...PropertyName="PropertyValue"... in a component tag. Property initialization tags must be directly enclosed between the corresponding opening and closing component tag.
@@ -42,10 +42,10 @@ A template control tag is used to configure the initial property values of the c
<%@ PropertyName="PropertyValue" ... %>-Like in component tags,
PropertyName
is case-insensitive and can be a property or subproperty name.
+Like in component tags, PropertyName is case-insensitive and can be a property or subproperty name.
-Initial values specified via the template control tag are assigned to the corresponding properties when the template control is being constructed. Therefore, you may override these property values in a later stage, such as the Init
stage of the control.
+Initial values specified via the template control tag are assigned to the corresponding properties when the template control is being constructed. Therefore, you may override these property values in a later stage, such as the Init stage of the control.
Template control tag is optional in a template. Each template can contain at most one template control tag. You can place the template control tag anywhere in the template. It is recommended that you place it at the beginning of the template for better visibility. diff --git a/demos/quickstart/protected/pages/Configurations/Templates2.page b/demos/quickstart/protected/pages/Configurations/Templates2.page index b7eaaf7a..c4528a0b 100644 --- a/demos/quickstart/protected/pages/Configurations/Templates2.page +++ b/demos/quickstart/protected/pages/Configurations/Templates2.page @@ -14,7 +14,7 @@ An expression tag represents a PHP expression that is evaluated when the templat
<%= PhpExpression %>-Inernally, an expression tag is represented by a
TExpression
control. Therefore, in the expression $this
refers to the TExpression
control. For example, the following expression tag will display the current page title at the place,
+Inernally, an expression tag is represented by a TExpression control. Therefore, in the expression $this refers to the TExpression control. For example, the following expression tag will display the current page title at the place,
<%= $this->Page->Title %>@@ -23,7 +23,7 @@ Inernally, an expression tag is represented by a
TExpression
contro
-Statement tags are similar to expression tags, except that statement tags contain PHP statements rather than expressions. The output of the PHP statements (using for example echo
or print
in PHP) are displayed at the place where the statement tag resides in the template. Inernally, a statement tag is represented by a TStatements
control. Therefore, in the statements $this
refers to the TStatements
control. The format of statement tags is as follows,
+Statement tags are similar to expression tags, except that statement tags contain PHP statements rather than expressions. The output of the PHP statements (using for example echo or print in PHP) are displayed at the place where the statement tag resides in the template. Inernally, a statement tag is represented by a TStatements control. Therefore, in the statements $this refers to the TStatements control. The format of statement tags is as follows,
<%% PHP Statements @@ -43,7 +43,7 @@ echo strftime("%A %e %B %Y",time());-where you may encloseDatabind Tags
-Databind tags are similar to expression tags, except that the expressions are evaluated only when a
dataBind()
call is invoked on the controls representing the databind tags. Internally, aTLiteral
control is used to represent a databind tag and$this
in the expression would refer to the control. The format of databind tags is as follows, +Databind tags are similar to expression tags, except that the expressions are evaluated only when a dataBind() call is invoked on the controls representing the databind tags. Internally, a TLiteral control is used to represent a databind tag and $this in the expression would refer to the control. The format of databind tags is as follows,<%# PhpExpression %>@@ -69,7 +69,7 @@ The format of asset tags is as follows,<%~ LocalFileName %>-whereLocalFileName
refers to a file path that is relative to the directory containing the current template file. The file path can be a single file or a directory. If the latter, the content in the whole directory will be made accessible by end-users. +where LocalFileName refers to a file path that is relative to the directory containing the current template file. The file path can be a single file or a directory. If the latter, the content in the whole directory will be made accessible by end-users.BE VERY CAUTIOUS when you are using asset tags as it may expose to end-users files that you probably do not want them to see. diff --git a/demos/quickstart/protected/pages/Configurations/Templates3.page b/demos/quickstart/protected/pages/Configurations/Templates3.page index 328687fb..7ab55281 100644 --- a/demos/quickstart/protected/pages/Configurations/Templates3.page +++ b/demos/quickstart/protected/pages/Configurations/Templates3.page @@ -10,7 +10,7 @@ Dynamic property tags are very similar to dynamic content tags, except that they body content </com:ComponentType>
DynamicPropertyTag
within single or double quotes for better readability.
+where you may enclose DynamicPropertyTag within single or double quotes for better readability.
We now introduce the available types of dynamic property tags that may be used in the above. Like dynamic content tags, we have expression tags, databind tags, parameter tags and asset tags. (Note, there is no statement tag here.) @@ -23,7 +23,7 @@ An expression tag represents a PHP expression that is evaluated when the templat
<%= PhpExpression %>-In the expression,
$this
refers to the component specified by the component tag. The following example specifies a TLabel
control whose Text
property is initialized as the current page title when the TLabel
control is being constructed,
+In the expression, $this refers to the component specified by the component tag. The following example specifies a TLabel control whose Text property is initialized as the current page title when the TLabel control is being constructed,
<com:TLabel Text=<%= $this->Page->Title %> />@@ -35,7 +35,7 @@ Note, unlike dynamic content tags, the expressions tags for component properties
-Databind tags are similar to expression tags, except that the expressions are evaluated only when a dataBind()
call is invoked on the controls represented by the component tags. In the expression, $this
refers to the control itself. Databind tags do not apply to all components. They can only be used for controls.
+Databind tags are similar to expression tags, except that the expressions are evaluated only when a dataBind() call is invoked on the controls represented by the component tags. In the expression, $this refers to the control itself. Databind tags do not apply to all components. They can only be used for controls.
The format of databind tags is as follows, @@ -64,7 +64,7 @@ The format of asset tags is as follows,
<%~ LocalFileName %>-where
LocalFileName
refers to a file path that is relative to the directory containing the current template file. The file path can be a single file or a directory. If the latter, the content in the whole directory will be made accessible by end-users.
+where LocalFileName refers to a file path that is relative to the directory containing the current template file. The file path can be a single file or a directory. If the latter, the content in the whole directory will be made accessible by end-users.
BE VERY CAUTIOUS when you are using asset tags as it may expose to end-users files that you probably do not want them to see.
diff --git a/demos/quickstart/protected/pages/Controls/Overview.page b/demos/quickstart/protected/pages/Controls/Overview.page
index 7c3fbea6..da16d170 100644
--- a/demos/quickstart/protected/pages/Controls/Overview.page
+++ b/demos/quickstart/protected/pages/Controls/Overview.page
@@ -1,7 +1,7 @@
-A control is an instance of class
Control classes constitute one of the major part of PRADO framework. Nearly every generic HTML element can find its representation in terms of a PRADO control. Mastering these controls becomes extremely important to effectively and efficiently compose applications using PRADO.
diff --git a/demos/quickstart/protected/pages/Fundamentals/Applications.page b/demos/quickstart/protected/pages/Fundamentals/Applications.page
index c64a9ea4..8ea9a1f7 100644
--- a/demos/quickstart/protected/pages/Fundamentals/Applications.page
+++ b/demos/quickstart/protected/pages/Fundamentals/Applications.page
@@ -2,7 +2,7 @@
-An application is an instance of
Applications are configured via application configurations. They are usually created entry scripts like the following,
@@ -11,7 +11,7 @@ require_once('/path/to/prado.php');
$application = new TApplication;
$application->run();
-where the method Controls Overview
TControl
or its subclass. A control is a component defined in addition with user interface. The base class TControl
defines the parent-child relationship among controls which reflects the containment relationship among user interface elements.
+A control is an instance of class TControl or its subclass. A control is a component defined in addition with user interface. The base class TControl defines the parent-child relationship among controls which reflects the containment relationship among user interface elements.
Applications
TApplication
or its derived class. It manages modules that provide different functionalities and are loaded when needed. It provides services to end-users. It is the central place to store various parameters used in an application. In a PRADO application, the application instance is the only object that is globally accessible via Prado::getApplication()
function call.
+An application is an instance of TApplication or its derived class. It manages modules that provide different functionalities and are loaded when needed. It provides services to end-users. It is the central place to store various parameters used in an application. In a PRADO application, the application instance is the only object that is globally accessible via Prado::getApplication() function call.
run()
starts the application to handle user requests.
+where the method run() starts the application to handle user requests.
Directory Organization
@@ -19,32 +19,32 @@ where the method run()
starts the application to handle user reques
A minimal PRADO application contains two files: an entry file and a page template file. They must be organized as follows,
-
wwwroot
- Web document root or sub-directory.index.php
- entry script of the PRADO application.assets
- directory storing published private files. See assets section.protected
- application base path storing application data and private script files. This directory should be configured inaccessible to Web-inaccessible, or it may be located outside of Web directories.runtime
- application runtime storage path. This directory is used by PRADO to store application runtime information, such as application state, cached data, etc.pages
- base path storing all PRADO pages. See services section.Home.page
- default page returned when users do not explicitly specify the page requested. This is a page template file. The file name without suffix is the page name. The page class is TPage
. If there is also a class file Home.php
, the page class becomes Home
.
-A product PRADO application usually needs more files. It may include an application configuration file named application.xml
under the application base path protected
. The pages may be organized in directories, some of which may contain page configuration files named config.xml
. Fore more details, please see configurations section.
+A product PRADO application usually needs more files. It may include an application configuration file named application.xml under the application base path protected. The pages may be organized in directories, some of which may contain page configuration files named config.xml. Fore more details, please see configurations section.
Deploying a PRADO application mainly involves copying directories. For example, to deploy the above minimal application to another server, follow the following steps,
wwwroot
to a Web-accessible directory on the new server.index.php
so that it includes correctly the prado.php
file.assets
and runtime
directories and make sure both directories are writable by the Web server process.
-Like page lifecycles, an application also has lifecycles. Application modules can register for the lifecycle events. When the application reaches a particular lifecycle and raises the corresponding event, the registered module methods are invoked automatically. Modules included in the PRADO release, such as TAuthManager
, are using this way to accomplish their goals.
+Like page lifecycles, an application also has lifecycles. Application modules can register for the lifecycle events. When the application reaches a particular lifecycle and raises the corresponding event, the registered module methods are invoked automatically. Modules included in the PRADO release, such as TAuthManager, are using this way to accomplish their goals.
The application lifecycles can be depicted as follows,
diff --git a/demos/quickstart/protected/pages/Fundamentals/Components.page b/demos/quickstart/protected/pages/Fundamentals/Components.page
index b49c16e5..20888fba 100644
--- a/demos/quickstart/protected/pages/Fundamentals/Components.page
+++ b/demos/quickstart/protected/pages/Fundamentals/Components.page
@@ -1,12 +1,12 @@
-A component is an instance of
-A component property can be viewed as a public variable describing a specific aspect of the component, such as the background color, the font size, etc. A property is defined by the existence of a getter and/or a setter method in the component class. For example, in Components
TComponent
or its child class. The base class TComponent
implements the mechanism of component properties and events.
+A component is an instance of TComponent or its child class. The base class TComponent implements the mechanism of component properties and events.
Component Properties
TControl
, we have
+A component property can be viewed as a public variable describing a specific aspect of the component, such as the background color, the font size, etc. A property is defined by the existence of a getter and/or a setter method in the component class. For example, in TControl, we define its ID property using the following getter and setter methods,
class TControl extends TComponent {
public function getID() {
@@ -17,18 +17,47 @@ class TControl extends TComponent {
}
}
-This defines a property named ID
. Reading the property (e.g. echo $component->ID;
) is equivalent to invoking the getter method (e.g. echo $component->getID();
); and writing the property (e.g. $component->ID='Button';
) is equivalent to invoking the setter method (e.g. $component->setID('Button');
).
+
+To get or set the ID property, do as follows, just like working with a variable, +
+$id = $component->ID; +$component->ID = $id; ++This is equivalent to the following, +
+$id = $component->getID(); +$component->setID( $id ); +
A property is read-only if it has a getter method but no setter method. Since PHP method names are case-insensitive, property names are also case-insensitive. A component class inherits all its ancestor classes' properties.
++A subproperty is a property of some object-typed property. For example, TWebControl has a Font property which is of TFont type. Then the Name property of Font is referred to as a subproperty (with respect to TWebControl). +
++To get or set the Name subproperty, use the following method, +
+$name = $component->getSubProperty('Font.Name'); +$component->setSubProperty('Font.Name', $name); ++This is equivalent to the following, +
+$name = $component->getFont()->getName(); +$component->getFont()->setName( $name ); ++ + +
Component events are special properties that take method names as their values. Attaching (setting) a method to an event will hook up the method to the places at which the event is raised. Therefore, the behavior of a component can be modified in a way that may not be foreseen during the development of the component.
-A component event is defined by the existence of an on
-method. For example, in TButton
, we have
+A component event is defined by the existence of an on-method. For example, in TButton, we have
class TButton extends TWebControl { public function onClick($param) { @@ -36,14 +65,40 @@ class TButton extends TWebControl { } }-This defines an event named
Click
, and a handler can be attached to the event using one of the following ways,
+This defines an event named Click, and a handler can be attached to the event using one of the following ways,
$button->Click=$callback; $button->Click->add($callback); $button->Click[]=$callback; $button->attachEventHandler('Click',$callback);-where
$callback
refers to a valid PHP callback (e.g. a function name, a class method array($object,'method')
, etc.)
+where $callback refers to a valid PHP callback (e.g. a function name, a class method array($object,'method'), etc.)
+
+
++A namespace refers to a logical grouping of some class names so that they can be differentiated from other class names even if their names are the same. Since PHP does not support namespace intrinsically, you cannot create instances of two classes who have the same name but with different definitions. To differentiate from user defined classes, all PRADO classes are prefixed with a letter 'T' (meaning 'Type'). Users are advised not to name their classes like this. Instead, they may prefix their class names with any other letter(s). +
++A namespace in PRADO is considered as a directory containing one or several class files. A class may be specified without ambiguity using such a namespace followed by the class name. Each namespace in PRADO is specified in the following format, +
+PathAlias.Dir1.Dir2 ++where PathAlias is an alias of some directory, while Dir1 and Dir2 are subdirectories under that directory. A class named MyClass defined under Dir2 may now be fully qualified as PathAlias.Dir1.Dir2.MyClass. + +
+To use a namespace in code, do as follows, +
+Prado::using('PathAlias.Dir1.Dir2.*'); ++which appends the directory referred to by PathAlias.Dir1.Dir2 into PHP include path so that classes defined under that directory may be instantiated without the namespace prefix. You may also include an individual class definition by +
+Prado::using('PathAlias.Dir1.Dir2.MyClass'); ++which will include the class file if MyClass is not defined. + +
+For more details about defining path aliases, see application configuration section.
ComponentType
refers to a class name or a dot-connected type name (e.g. System.Web.UI.TControl
). The second approach is introduced to compensate for the lack of namespace support in PHP.
+where ComponentType refers to a class name or a type name in namespace format (e.g. System.Web.UI.TControl). The second approach is introduced to compensate for the lack of namespace support in PHP.
-Static component instantiation is about creating components via configurations. The actual creation work is done by the PRADO framework. For example, in an application configuration, one can configure a module to be loaded when the application runs. The module is thus a static component created by the framework. Static component instantiation is more commonly used in templates. Every component tag in a template specifies a component that will be automatically created by the framework when the template is loaded. For example, in a page template, the following tag will lead to the creation of a TButton
component on the page,
+Static component instantiation is about creating components via configurations. The actual creation work is done by the PRADO framework. For example, in an application configuration, one can configure a module to be loaded when the application runs. The module is thus a static component created by the framework. Static component instantiation is more commonly used in templates. Every component tag in a template specifies a component that will be automatically created by the framework when the template is loaded. For example, in a page template, the following tag will lead to the creation of a TButton component on the page,
<com:TButton Text="Register" />diff --git a/demos/quickstart/protected/pages/Fundamentals/Controls.page b/demos/quickstart/protected/pages/Fundamentals/Controls.page index 6c45acf1..cc0b3eda 100644 --- a/demos/quickstart/protected/pages/Fundamentals/Controls.page +++ b/demos/quickstart/protected/pages/Fundamentals/Controls.page @@ -1,7 +1,7 @@
-A control is an instance of class TControl
or its subclass. A control is a component defined in addition with user interface. The base class TControl
defines the parent-child relationship among controls which reflects the containment relationship among user interface elements.
+A control is an instance of class TControl or its subclass. A control is a component defined in addition with user interface. The base class TControl defines the parent-child relationship among controls which reflects the containment relationship among user interface elements.
Controls
refers to the child control collection of the parent.
+where the property Controls refers to the child control collection of the parent.
-Each control has an ID
property that can be uniquely identify itself among its sibling controls. In addition, each control has a UniqueID
and a ClientID
which can be used to globally identify the control in the tree that the control resides in. UniqueID
and ClientID
are very similar. The former is used by the framework to determine the location of the corresponding control in the tree, while the latter is mainly used on the client side as HTML tag IDs. In general, you should not rely on the explicit format of UniqueID
or ClientID
.
+Each control has an ID property that can be uniquely identify itself among its sibling controls. In addition, each control has a UniqueID and a ClientID which can be used to globally identify the control in the tree that the control resides in. UniqueID and ClientID are very similar. The former is used by the framework to determine the location of the corresponding control in the tree, while the latter is mainly used on the client side as HTML tag IDs. In general, you should not rely on the explicit format of UniqueID or ClientID.
-Each control has a naming container which is a control creating a unique namespace for differentiating between controls with the same ID
. For example, a TRepeater
control creates multiple items each having child controls with the same ID
s. To differentiate these child controls, each item serves as a naming container. Therefore, a child control may be uniquely identified using its naming container's ID
together with its own ID
. As you may already have understood, UniqueID
and ClientID
rely on the naming containers.
+Each control has a naming container which is a control creating a unique namespace for differentiating between controls with the same ID. For example, a TRepeater control creates multiple items each having child controls with the same IDs. To differentiate these child controls, each item serves as a naming container. Therefore, a child control may be uniquely identified using its naming container's ID together with its own ID. As you may already have understood, UniqueID and ClientID rely on the naming containers.
-A control can serve as a naming container if it implements the INamingContainer
interface.
+A control can serve as a naming container if it implements the INamingContainer interface.
-Viewstate and controlstate are implemented in TControl
. They are commonly used to define various properties of controls. To save and retrieve values from viewstate or controlstate, use following methods,
+Viewstate and controlstate are implemented in TControl. They are commonly used to define various properties of controls. To save and retrieve values from viewstate or controlstate, use following methods,
$this->getViewState('Name',$defaultValue); $this->setViewState('Name',$value,$defaultValue); $this->getControlState('Name',$defaultValue); $this->setControlState('Name',$value,$defaultValue);-where
$this
refers to the control instance, Name
refers to a key identifying the persistent value, $defaultValue
is optional. When retrieving values from viewstate or controlstate, if the corresponding key does not exist, the default value will be returned.
+where $this refers to the control instance, Name refers to a key identifying the persistent value, $defaultValue is optional. When retrieving values from viewstate or controlstate, if the corresponding key does not exist, the default value will be returned.
-A module is an instance of a class implementing the IModule
interface. A module is commonly designed to provide specific functionality that may be plugged into a PRADO application and shared by all components in the application.
+A module is an instance of a class implementing the IModule interface. A module is commonly designed to provide specific functionality that may be plugged into a PRADO application and shared by all components in the application.
PRADO uses configurations to specify whether to load a module, load what kind of modules, and how to initialize the loaded modules. Developers may replace the core modules with their own implementations via application configuration, or they may write new modules to provide additional functionalities. For example, a module may be developed to provide common database logic for one or several pages. For more details, please see the configurations. @@ -14,34 +14,34 @@ There are three core modules that are loaded by default whenever an application
-Request module represents provides storage and access scheme for user request sent via HTTP. User request data comes from several sources, including URL, post data, session data, cookie data, etc. These data can all be accessed via the request module. By default, PRADO uses THttpRequest
as request module. The request module can be accessed via the Request
property of application and controls.
+Request module represents provides storage and access scheme for user request sent via HTTP. User request data comes from several sources, including URL, post data, session data, cookie data, etc. These data can all be accessed via the request module. By default, PRADO uses THttpRequest as request module. The request module can be accessed via the Request property of application and controls.
-Response module implements the mechanism for sending output to client users. Response module may be configured to control how output are cached on the client side. It may also be used to send cookies back to the client side. By default, PRADO uses THttpResponse
as response module. The response module can be accessed via the Response
property of application and controls.
+Response module implements the mechanism for sending output to client users. Response module may be configured to control how output are cached on the client side. It may also be used to send cookies back to the client side. By default, PRADO uses THttpResponse as response module. The response module can be accessed via the Response property of application and controls.
-Session module encapsulates the functionalities related with user session handling. Session module is automatically loaded when an application uses session. By default, PRADO uses THttpSession
as session module, which is a simple wrapper of the session functions provided by PHP. The session module can be accessed via the Session
property of application and controls.
+Session module encapsulates the functionalities related with user session handling. Session module is automatically loaded when an application uses session. By default, PRADO uses THttpSession as session module, which is a simple wrapper of the session functions provided by PHP. The session module can be accessed via the Session property of application and controls.
-Error handler module is used to capture and process all error conditions in an application. PRADO uses TErrorHandler
as error handler module. It captures all PHP warnings, notices and exceptions, and displays in an appropriate form to end-users. The error handler module can be accessed via the ErrorHandler
property of the application instance.
+Error handler module is used to capture and process all error conditions in an application. PRADO uses TErrorHandler as error handler module. It captures all PHP warnings, notices and exceptions, and displays in an appropriate form to end-users. The error handler module can be accessed via the ErrorHandler property of the application instance.
-PRADO is released with a few more modules besides the core ones. They include caching modules (TSqliteCache
and TMemCache
), user management module (TUserManager
), authentication and authorization module (TAuthManager
), etc.
+PRADO is released with a few more modules besides the core ones. They include caching modules (TSqliteCache and TMemCache), user management module (TUserManager), authentication and authorization module (TAuthManager), etc.
-When TPageService
is requested, it also loads modules specific for page service, including asset manager (TAssetManager
), template manager (TTemplateManager
), theme/skin manager (TThemeManager
), and page state persister (TPageStatePersister
).
+When TPageService is requested, it also loads modules specific for page service, including asset manager (TAssetManager), template manager (TTemplateManager), theme/skin manager (TThemeManager), and page state persister (TPageStatePersister).
Custom modules and core modules are all configurable via configurations. diff --git a/demos/quickstart/protected/pages/Fundamentals/Pages.page b/demos/quickstart/protected/pages/Fundamentals/Pages.page index 02662558..8dfb5caa 100644 --- a/demos/quickstart/protected/pages/Fundamentals/Pages.page +++ b/demos/quickstart/protected/pages/Fundamentals/Pages.page @@ -5,12 +5,12 @@ Pages are top-most controls that have no parent. The presentation of pages are directly displayed to end-users. Users access pages by sending page service requests.
-Each page must have a template file. The file name suffix must be .page
. The file name (without suffix) is the page name. PRADO will try to locate a page class file under the directory containing the page template file. Such a page class file must have the same file name (suffixed with .php
) as the template file. If the class file is not found, the page will take class TPage
.
+Each page must have a template file. The file name suffix must be .page. The file name (without suffix) is the page name. PRADO will try to locate a page class file under the directory containing the page template file. Such a page class file must have the same file name (suffixed with .php) as the template file. If the class file is not found, the page will take class TPage.
-A form submission is called postback if the submission is made to the page containing the form. Postback can be considered an event happened on the client side, raised by the user. PRADO will try to identify which control on the server side is responsible for a postback event. If one is determined, for example, a TButton
, we call it the postback event sender which will translate the postback event into some specific server-side event (e.g. Click
and Command
events for TButton
).
+A form submission is called postback if the submission is made to the page containing the form. Postback can be considered an event happened on the client side, raised by the user. PRADO will try to identify which control on the server side is responsible for a postback event. If one is determined, for example, a TButton, we call it the postback event sender which will translate the postback event into some specific server-side event (e.g. Click and Command events for TButton).
-A service is an instance of a class implementing the IService
interface. Each kind of service processes a specific type of user requests. For example, the page service responds to users' requests for PRADO pages.
+A service is an instance of a class implementing the IService interface. Each kind of service processes a specific type of user requests. For example, the page service responds to users' requests for PRADO pages.
-A service is uniquely identified by its ID
property. By default when THttpRequest
is used as the request module, GET variable names are used to identify which service a user is requesting. If a GET variable name is equal to some service ID
, the request is considered for that service, and the value of the GET variable is passed as the service parameter. For page service, the name of the GET variable must be page
. For example, the following URL requests for the Fundamentals.Services
page,
+A service is uniquely identified by its ID property. By default when THttpRequest is used as the request module, GET variable names are used to identify which service a user is requesting. If a GET variable name is equal to some service ID, the request is considered for that service, and the value of the GET variable is passed as the service parameter. For page service, the name of the GET variable must be page. For example, the following URL requests for the Fundamentals.Services page,
http://hostname/index.php?page=Fundamentals.Services@@ -16,19 +16,19 @@ Developers may implement additional services for their applications. To make a s
-PRADO implements TPageService
to process users' page requests. Pages are stored under a directory specified by the BasePath
property of the page service. The property defaults to pages
directory under the application base path. You may change this default by configuring the service in the application configuration.
+PRADO implements TPageService to process users' page requests. Pages are stored under a directory specified by the BasePath property of the page service. The property defaults to pages directory under the application base path. You may change this default by configuring the service in the application configuration.
-Pages may be organized into subdirectories under the BasePath
. In each directory, there may be a page configuration file named config.xml
, which contains configurations effective only when a page under that directory or a sub-directory is requested. For more details, see the page configuration section.
+Pages may be organized into subdirectories under the BasePath. In each directory, there may be a page configuration file named config.xml, which contains configurations effective only when a page under that directory or a sub-directory is requested. For more details, see the page configuration section.
-Service parameter for the page service refers to the page being requested. A parameter like Fundamentals.Services
refers to the Services
page under the <BasePath>/Fundamentals
directory. If such a parameter is absent in a request, a default page named Home
is assumed. Using THttpRequest
as the request module (default), the following URLs will request for Home
, About
and Register
pages, respectively,
+Service parameter for the page service refers to the page being requested. A parameter like Fundamentals.Services refers to the Services page under the <BasePath>/Fundamentals directory. If such a parameter is absent in a request, a default page named Home is assumed. Using THttpRequest as the request module (default), the following URLs will request for Home, About and Register pages, respectively,
http://hostname/index.php http://hostname/index.php?page=About http://hostname/index.php?page=Users.Register-where the first example takes advantage of the fact that the page service is the default service and
Home
is the default page.
+where the first example takes advantage of the fact that the page service is the default service and Home is the default page.
-The code that a developer needs to write is merely the following event handler function, where $sender
refers to the button object.
+The code that a developer needs to write is merely the following event handler function, where $sender refers to the button object.
public function buttonClicked($sender,$param) -- cgit v1.2.3