Trace:
Differences ¶
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:tutorial:creating-action [2006/11/08 11:05] – (old revision restored) 127.0.0.1 | en:tutorial:creating-action [2007/09/17 22:42] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Creating an action ====== | + | This page has been moved to [[en:tutorials:main:creating-action|tutorials/main/creating-action]] |
- | + | ||
- | + | ||
- | ===== A little bit of theory ===== | + | |
- | + | ||
- | An action is a fundamental element of the framework. Every display, every form processing, every web service call is an action. | + | |
- | + | ||
- | An action is called through a request which has a defined type and generates a specific response, in a specific format, which can be linked | + | |
- | + | ||
- | There are several types of requests, notably the type which is named “classic” in Jelix , for which an action can provide a response in an unspecified format: HTML, XML etc. It is for this type of request that you will generally define actions. In general, this type of request provides its parameters in the URL or the body of HTTP request (POST method). | + | |
- | + | ||
- | You also have the xmlrpc type requests (used in web services). In XML-RPC, the input data are not URL parameters, but are stored in a XML content. As XML-RPC protocol wants it, an action defined for this type of request must obligatorily provide a response to XML-RPC format. | + | |
- | + | ||
- | Knowing the type of request processed and the action, Jelix knows the type of the answer to be generated, and thus controls more or less the response generation. Thus, even the error case (an exception or other) occurring during the processing of the action, the exit format will always be the awaited one. A client who calls a web service with xmlrpc, will thus have no matter what happens, a response in the xmlrpc format. That brings a certain robustness to the application. | + | |
- | + | ||
- | + | ||
- | ===== Implementing an action ===== | + | |
- | + | ||
- | The actions are implemented in so-called controllers. Controllers are classes containing methods for each action. Controllers are placed in files : | + | |
- | controllers/// | + | |
- | + | ||
- | In general, there is an index() method for the default action. | + | |
- | + | ||
- | Let's modifiy this default action. For this, open the contollers/ | + | |
- | + | ||
- | <code php> | + | |
- | class CTDefault extends jController { | + | |
- | + | ||
- | | + | |
- | $rep = $this-> | + | |
- | + | ||
- | return $rep; | + | |
- | } | + | |
- | } | + | |
- | </ | + | |
- | + | ||
- | You see there are some naming conventions. Controller classes have a CT prefix, followed by the name of the controller (here: " | + | |
- | + | ||
- | There is an index() method, which retrieves the " | + | |
- | + | ||
- | + | ||
- | + | ||
- | ==== Response object ==== | + | |
- | + | ||
- | In the $rep variable, you get an object extending the jResponse class. Since we specified, that the response is the HTML type, you actually get a jResponse Html object (extending jResponse). You will see later that there are other types of responses, and that you can produce your own response objects. | + | |
- | + | ||
- | The jResponseHtml object handles the generation of a HTML response (ie an HTML page). It generates automatically the < | + | |
- | + | ||
- | <code php> | + | |
- | | + | |
- | </ | + | |
- | + | ||
- | And the browser will receive : | + | |
- | + | ||
- | <code xml> | + | |
- | < | + | |
- | < | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | All the body of the page, i.e the content of the html tag < | + | |
- | Before beginning to code, let's see the content of the template | + | |
- | + | ||
- | + | ||
- | + | ||
- | ==== The template ==== | + | |
- | + | ||
- | Create a newslist.tpl file in the templates directory of the module. And place this content inside | + | |
- | + | ||
- | <code xml> | + | |
- | < | + | |
- | < | + | |
- | </ | + | |
- | + | ||
- | As we said earlier, the content of the template will be the content of the < | + | |
- | + | ||
- | + | ||
- | + | ||
- | ==== Using the template in the action | + | |
- | + | ||
- | Let's see what we now have in the controller : | + | |
- | + | ||
- | <code php> | + | |
- | class CTDefault extends jController { | + | |
- | + | ||
- | | + | |
- | $rep = $this-> | + | |
- | $rep-> | + | |
- | $rep-> | + | |
- | return $rep; | + | |
- | } | + | |
- | } | + | |
- | </ | + | |
- | + | ||
- | We the added an instruction to specify to the response that we use the newslist.tpl template. | + | |
- | + | ||
- | A [[en: | + | |
- | + | ||
- | + | ||
- | + | ||
- | ===== First display ===== | + | |
- | + | ||
- | We are now ready to display the first version of our action. For this, type the following url in your browser : | + | |
- | + | ||
- | http://localhost/ | + | |
- | + | ||
- | You will then see the content of the template we created on the screen. | + | |
- | + | ||
- | The action parameter is the name of the action to be executed. It is made from to parts, separated by an underscore (_). The first part is the name of the controller, the second part is the name of the method to be executed. | + | |
- | + | ||
- | We can specify that this action will be the default action of the application. For this, open the configuration file actu.org/ | + | |
- | + | ||
- | <code ini> | + | |
- | defaultModule = " | + | |
- | defaultAction = " | + | |
- | </ | + | |
- | + | ||
- | You can then use the following url : | + | |
- | + | ||
- | http:// | + | |
- | + | ||
- | To display our first page. | + | |
- | + | ||
- | + | ||
- | ---- | + | |
- | * Next : [[en: | + | |
- | * Previous : [[en: | + | |
- | * [[en: | + |