Trace: • 1.1.x • jevent • goodies • 1.8 • telechargement • jtpl-standalone • 1.0.6 • creating-action
Differences ¶
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:tutorials:main:creating-action [2007/12/18 09:37] – laurent | en:tutorials:main:creating-action [2012/04/15 08:32] (current) – laurent | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ===== 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 to the type of the actual request. | ||
+ | |||
+ | 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. You will use generally this type of request for almost of your actions. " | ||
+ | |||
+ | You have also the xmlrpc type requests (used for some 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. | ||
+ | |||
+ | Here is how Jelix work: | ||
+ | |||
+ | {{http:// | ||
+ | |||
+ | - an HTTP request calls Jelix. Jelix creates an instance of a jRequest object which contains datas of the request. It then create an instance of your controller which corresponds to the asked action. | ||
+ | - A method | ||
+ | - Then the method execute business processes, and retrieves eventually some results which will be used for the response | ||
+ | - The method of the controller create an instance of a jResponse object which is setup with datas or else (initialization of templates etc..). | ||
+ | - Jelix gets this jResponse object, launch the generation of the final document (html page, pdf..) and then send the result to the browser. | ||
+ | |||
+ | |||
+ | ===== 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 modify this default action. For this, open the contollers/ | ||
+ | |||
+ | <code php> | ||
+ | class defaultCtrl extends jController { | ||
+ | |||
+ | | ||
+ | $rep = $this-> | ||
+ | |||
+ | return $rep; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | You see there are some naming conventions. Controller classes have a name, here " | ||
+ | |||
+ | |||
+ | ==== Response object ==== | ||
+ | |||
+ | In the //index()// method, we retrieve an " | ||
+ | |||
+ | 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 // | ||
+ | |||
+ | <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 defaultCtrl extends jController { | ||
+ | |||
+ | | ||
+ | $rep = $this-> | ||
+ | $rep-> | ||
+ | $rep-> | ||
+ | return $rep; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | We added an instruction to specify to the response that we use the newslist.tpl template. | ||
+ | |||
+ | A selector comprise a module name and a resource name separated by the " | ||
+ | |||
+ | ===== First display ===== | ||
+ | |||
+ | We are now ready to display the first version of our action. For this, type the following url in your browser : | ||
+ | |||
+ | http:// | ||
+ | |||
+ | 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 a colon (in jelix 1.0b3.1 and prior, it was 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 news.org/ | ||
+ | |||
+ | <code ini> | ||
+ | startModule = " | ||
+ | startAction = " | ||
+ | </ | ||
+ | |||
+ | You can then use the following url to display the " | ||
+ | |||
+ | http:// | ||