Quick links: Content - sections - sub sections
EN

Trace: erreurs-1.1 credits 1.2.x

Differences

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

Link to this comparison view

Next revision
Previous revision
en:tutorials:main:using-dao [2007/09/16 06:51] – created laurenten:tutorials:main:using-dao [2008/11/19 21:42] (current) laurent
Line 1: Line 1:
-====== How to use daos ====== +
- +
 Jelix proposes a relational object-mapping system named jDao, based on DAO pattern.  Jelix proposes a relational object-mapping system named jDao, based on DAO pattern. 
  
Line 8: Line 7:
 Concretely with jDao, a DAO XML file enables you to define a record and a factory, which will act on one or more tables at the same time. You thus define the mapping in it: which field of the table will go in which property of the record, as well as the type of data, the keys, on which tables the mapping is carried out, according to which joints etc. Concretely with jDao, a DAO XML file enables you to define a record and a factory, which will act on one or more tables at the same time. You thus define the mapping in it: which field of the table will go in which property of the record, as well as the type of data, the keys, on which tables the mapping is carried out, according to which joints etc.
  
-   +Starting from this file, jDao dynamically generates two classesstored in a php  file in the cache of jelix, and based respectively on jDaoRecordBase and jDaoFactoryBase. In the generated classes, all main methods and SQL requests are **statically** provided. Indeed, in contrary to other mapping systems, SQL requests are thus generated only once, and not dynamically with each page calls That allows better performances.
-Starting from this file, jDao dynamically generates two classes based respectively on jDaoRecordBase and jDaoFactoryBase (which is stored in a php  file in the cache of jelix)in which all main methods and SQL requests are **statically** provided. Indeed, in contrary to other mapping systems, SQL requests are thus generated only once, and not dynamically with each page calls That allows better performances.+
  
 In the DAO XML file, you can also define your own access methods to data, and jDao will generate the corresponding methods and requests in the DAO factory. In the DAO XML file, you can also define your own access methods to data, and jDao will generate the corresponding methods and requests in the DAO factory.
Line 17: Line 15:
  
   
-You have command to be able to create a DAO file, based on an existing table. It has this following syntax: +You have command to be able to create a DAO file, based on an existing table. It has this following syntax: 
  
    createdao //module_name// //dao_name// //table_name//    createdao //module_name// //dao_name// //table_name//
  
   
-A news table has been created before, and we will create a DAO named "news", in the "news" module. Then type: +"newstable has been created before, and we will create a DAO named "news", in the "news" module. Then type: 
  
 <code bash> <code bash>
Line 29: Line 27:
  
     
-You obtain an actu.org/modules/news/daos/news.dao.xml file. (you can of course create it by hand). +You obtain an news.org/modules/news/daos/news.dao.xml file. (you can of course create it by hand). Here is its content:
  
-Its content is what follows : 
 <code xml> <code xml>
 <?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
 <dao xmlns="http://jelix.org/ns/dao/1.0"> <dao xmlns="http://jelix.org/ns/dao/1.0">
   <datasources>   <datasources>
-    <primarytable name="news" realname="news" primarykey="id_news" />+    <primarytable name="news" realname="news" primarykey="news_id" />
   </datasources>   </datasources>
   <record>   <record>
-    <property name="id_news" fieldname="id_news" datatype="autoincrement"/> +    <property name="news_id" fieldname="news_id" datatype="autoincrement"/> 
-    <property name="sujet" fieldname="sujet" datatype="string"/> +    <property name="subject" fieldname="subject" datatype="string"/> 
-    <property name="texte" fieldname="texte" datatype="string"/>+    <property name="text" fieldname="text" datatype="string"/>
     <property name="news_date" fieldname="news_date" datatype="date"/>     <property name="news_date" fieldname="news_date" datatype="date"/>
   </record>   </record>
 </dao> </dao>
- 
 </code> </code>
  
 This is a very simple content, and of course there are other attributes and tags to enrich it and customize it. For the moment, we will leave it there. This is a very simple content, and of course there are other attributes and tags to enrich it and customize it. For the moment, we will leave it there.
- 
  
 ===== List the news ===== ===== List the news =====
  
-We will now use this DAO to retrieve the list of news. We thus will request from jDao the factory of this DAO, and call its preset method findAll. With this intention, we use jDao::get() :+We will now use this DAO to retrieve the list of news. We thus will request from jDao the factory of this DAO, and call its preset method **findAll**We use **jDao::get()** to do it:
  
 <code php> <code php>
Line 60: Line 55:
 </code> </code>
  
-As parameter of jDao::get(), we give the DAO selector (which is named "news", and is in the news module): “news~news”. It gives us the factory of this DAO. And by calling the findAll method, we retrieve all the list of records.+As parameter of jDao::get(), we give the DAO selector (which is named "news", and is in the news module): “news~news”. It gives us the factory of this DAO. And by calling the //findAll// method, we retrieve all the list of records.
  
-Actually, this is not really a list, but a jDbResultSet, which is an iterator on the results of the corresponding request.+Actually, this is not really a list, but a //jDbResultSet//, which is an iterator on the results of the corresponding request.
  
 Let's integrate it in our controller : Let's integrate it in our controller :
Line 81: Line 76:
 </code> </code>
  
-As stated ealier, the body property of jResponseHtml is a jTpl object (template engine). We give the list to it in a "$list" template var, to be able to use it in the template. The template becomes :+As stated ealier, the body property of jResponseHtml is a jTpl object (template engine). We give the list to it in a "$list" template var, to be able to use it in the template. The template becomes:
  
 <code> <code>
Line 95: Line 90:
 </code> </code>
  
-You discover here the {foreach} template tag, which +You discover here the {foreach} template tag, which is exactly like the php foreach statement.
-Vous découvrez ici le tag de template {foreach}, which is exactly like the php foreach. To display some values, you only have to put the name of the template var after a $ and between {}.+
  
-The list returned by findAll is a list of record objects, as defined in the xml file. The have then the id_news, subject, text and news_date properties.+To display some values, you only have to put the name of the template var after a $ and between {}. 
 + 
 +The list returned by findAll is a list of record objects, as defined in the xml file. The have then the news_id, subject, text and news_date properties.
  
 Display the page one more time : Display the page one more time :
  
-   http://localhost/jelix/actu.org/www/index.php .+   http://localhost/jelix/news.org/www/index.php .
  
 You should see the list of news. You should see the list of news.
  
  
- 
----- 
-   * Next : [[en:tutorials:main:news-form|Creation of a form]] 
-   * Previous : [[en:tutorials:main:database-config|CConfiguration of the database]] 
-   * [[en:tutorials:main|Back to the summary]] 

en/tutorials/main/using-dao.1189925472.txt.gz · Last modified: 2007/09/17 22:42 (external edit)

Recent changes RSS feed Creative Commons License