Trace:

Differences ¶

This shows you the differences between two versions of the page.

--- en:minitutorial [2006/09/14 15:54] – doubleface
+++ en:minitutorial [2006/09/18 11:26] – doubleface
@@ Line 24: / Line 24: @@
   set JELIX_APP_NAME=helloapp (windows)
 </code>
@@ Line 45: / Line 46: @@
      www/           the root of the site
+===== Creation of a module =====
+A module gathers a whole of actions. At least one is necessary in an application. Let's create our first module "hello" :
+<code bash>
+php jelix.php createmodule hello
+</code>
+Here is the directory which has been created :
+   helloapp/modules/
+              hello/                the directory of the module
+                module.xml          file describing the identity of the module
+                controllers/       the classes processing the actions
+                   default.classic.php   a default controller
+                classes/            your business classes and services
+                daos/               the object-relational mapping files
+                locales/            locales files ("properties files")
+                    en_EN/
+                    fr_FR/
+                templates/          templates of the module
+                zones/              objects processing specific zones in a page
+===== Action implementation =====
+Let's implement a default action. Open the controllers/default.classic.php file and modify the content this way :
+<code php>
+class CTDefault extends jController {
+   function index () {
+      $rep = $this->getResponse('html');
+      return $rep;
+   }
+}
+</code>
+We state here that we retrieve the jResponseHtml object (because of the HTML type as it is indicated), and we return it to indicate that its content must be returned to the browser.
+==== Response object ====
+The jResponseHtml object generates a response in HTML (a HTML page). It generates automatically the <head> part of HTML, from some of its properties. Let's define the title of the page :
+<code php>
+   $rep->title = 'Hello World !';
+</code>
+The body of the page is generated by default by a template, via an instance of the Jelix template engine, placed in the body property. The name of the template file is placed in the bodyTpl property. Here, it's the hello.tpl file.
+<code php>
+      $rep->bodyTpl = 'hello';
+</code>
+We don't put the ".tpl" part because the content of the string is actually a Jelix //selector//. A Jelix selector is a link made to be able to refer to a resource of a module.
+==== The template ====
+Create a hello.tpl file in the template directory of the module. And put in this content :
+<code xml>
+  <h2>Hello {$name} !</h2>
+  <p>Welcome in Jelix !</p>
+</code>
+"{$name}" is a template variable : it will be replaced by the value you will define, like in this example :
+<code php>
+      $rep->body->assign('name','Me');
+</code>
+==== As a summary ====
+The code of the controller must now be like this :
+<code php>
+class CTDefault extends jController {
+   function index () {
+      $rep = $this->getResponse('html');
+      $rep->title = 'Hello World !';
+      $rep->bodyTpl = 'hello';
+      $rep->body->assign('name','Me');
+      return $rep;
+   }
+}
+</code>
+===== First display =====
+We are now ready to display our page. For this, give the following URL :
+  http://localhost/jelix/helloapp/www/index.php?module=hello&action=default_index
+You will then see your html page, with the welcome message.
+The url can change regarding the configuration of your installation, especially if you have specified the document root of the site on the directory helloapp/www. You have to know that Jelix can handle the significant url to avoid all this disgusting parameters.
+===== Retrieving parameters =====
+It would be interesting to be able to indicate as parameter of the url, the name to display in the template.
+<code php>
+   $name = $this->param('name');
+   $rep->body->assign('name', $name);
+</code>
+Now type :
+    http://localhost/jelix/helloapp/www/index.php?module=hello&action=default_index&name=Robert
+-----
+   * Go back to the [[en:manual|documentation]]
+   * Continue to discover Jelix with the [[en:tutorial|main tutorial]]