Creating a first simple action

Wiki: Sitemap - Recent Changes - Back link

A little bit of theory
Implementing an action
First display

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. “classic” request provides its parameters in the URL or the body of HTTP request (POST method).

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:

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 in the controller is executed. It retrieves request parameters in order to know which process to run.
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///controller_name//.//request_type//.php.

In general, there is an index() method for the default action.

Let's modify this default action. For this, open the contollers/default.classic.php. You should have this content:

class defaultCtrl extends jController {
 
   function index () {
      $rep = $this->getResponse('html');
 
      return $rep;
   }
}

You see there are some naming conventions. Controller classes have a name, here “default”, followed by a “Ctrl” suffix. The name is also indicated in the action parameter, and as a prefix in the file name.

Response object ¶

In the index() method, we retrieve an “html” response into the $rep variable. Since we specified that the response is the HTML type, you actually get a jResponseHtml 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 <head> part of HTML, from some of its properties. For example, let's specify the title of the page :

   $rep->title = 'Last news';

And the browser will receive :

<head>
   <title>Last news</title>
</head>

All the body of the page, i.e the content of the html tag <body>, must be generated by yourself, eventually through the Jelix template engine : jTpl. jResponseHtml instantiates by default a template engine, in the body property. The name of the template file is placed in the bodyTpl property.

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 it :

  <h2>Lastest news</h2>
  <p>Section available soon.</p>

As we said earlier, the content of the template will be the content of the <body> tag. That's why you don't have to give the <html>, <head>, … tag. Only the content of the <body> tag.

Using the template in the action ¶

Let's see what we now have in the controller :

class defaultCtrl extends jController {
 
   function index () {
      $rep = $this->getResponse('html');
      $rep->title = 'Last news';
      $rep->bodyTpl = 'newslist';
      return $rep;
   }
}

We added an instruction to specify to the response that we use the newslist.tpl template. There is no need to type the “.tpl” suffix of the file name, because it is actually a Jelix selector. A selector is a string, allowing to easily indicate a resource of the project, independently of its physical place.

A selector comprise a module name and a resource name separated by the “~” character, like this: “module_name~resource_name”. The “module_name~” part is not mandatory when this is the current module. The resource name is not obligatorily a file name, even if, most of the time, it is a file name. The object which uses the selector (jTpl here) knows how to retrieve the file corresponding to the selector. You will see that the selectors are very often used and allow a certain flexibility and independence from physical paths.

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/jelix/news.org/www/index.php?module=news&action=default:index

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/var/config/index/config.ini.php and specify it :

startModule = "news"
startAction = "default:index"

You can then use the following url to display the “homepage”:

http://localhost/jelix/news.org/www/index.php

en/tutorials/main/creating-action.txt · Last modified: 2012/04/15 08:32 by laurent

Chapter: Creating a first simple action

Table of Contents