Helló, világ! komponens készítése 3. rész

A JoomlaWiki wikiből

Az első két fejezetben bemutattuk hogyan kell elkészíteni egy MVC komponenst. Egy nézetünk volt, amely megjelenítette a modell adatait (amelyet a 2. fejezetben hoztunk létre). Ebben a részben a modellel fogunk foglalkozni. A modellbe ágyazott statikus szöveg helyett a modell az adatbázisból fogja venni az adatokat.

Ez a leírás bemutatja, hogyan kell használni a JDatabase osztályt az adatok adatbázisból való átadásához.

Tartalomjegyzék

Az adatok átadása

A modellünknek jelenleg egy metóedusa van: getGreeting(). Ez a metódus nagyon egyszerű - mindösszesen a statikusan beágyazott szöveget adja vissza.

A dolgok még érdekesebbé tételéhez az üdvözlést az adatbázisból fogjuk betölteni. Később bemutatjuk majd, hogyan készítsünk egy SQL fájlt és adjuk hozzá a megfelelő kódot az XML fájlhoz, tehát hogy az adatbázis tábla, valamint a mintaadatok a komponens telepítésével együtt jöjjenek létre. Most viszont csak egyszerűen lecseréljük a return parancsot néhány sornyi kóddal, amely az üdvözlést az adatbázisból adja át.

Az első lépés az adatbázis objektum referenciájának létrehozása. Mivel a Joomla! a működéséhez az adatbázist használja, ezért az adatbázis kapcsolat már létezik, tehát nem kell a sajátunkat létrehozni. A meglévő adatbázis referenciájának létrehozásához használjuk a következő kódot: 

  1. $db =& JFactory::getDBO();

A JFactory egy statikus osztály, amelyet arra használunk, hogy hozzáférjünk a különböző rendszer objektumokhoz. További infomáció az API dokumentációban található erről az osztályról.

A metódus neve (getDBO) a 'get DataBase Object' szavak rövidítése, könnyű és fontos megjegyezni.

Most hogy már rendelkezünk az adatbázis objektum referenciájával, megkaphatjuk az adatainkat. Ezt két lépésben végezzük:

  • Eltároljuk az SQL kérésünket az adatbázis objektumában
  • Betöltjük a kérés által visszaadott adatokat

Az új getGreeting() metódusunk tehát így néz ki: 

  1. function getGreeting()
  2. {
  3.    $db =& JFactory::getDBO();
  4.  
  5.    $query = 'SELECT greeting FROM #__hello';
  6.    $db->setQuery( $query );
  7.    $greeting = $db->loadResult();
  8.  
  9.    return $greeting;
  10. }

A 'hello' az adatbázis táblának a neve, amelyet később hozunk létre, a 'greeting' pedig a mező neve, amely az üdvözlést tartalmazza.

A $db->loadResult() metódus végrehajtja az eltárolt kérést és visszaadja a kimenet első sorának első mezőjét. Bővebb információért nézzük meg a JDatabase API referenciáját a további JDatabase metódusokért.

A telepítő SQL fájl elkészítése

A Joomla! telepítője rendelkezik azzal a képességgel, hogy kéréseket hajt végre a komponenens telepítése során. Az összes ilyen kérés egy egyszerű szöveges fájlban található, melynek az admin könyvtárban kell lennie.

Három kérés lesz a mi telepítő fájlunkban: az első eldobja a táblát ha már létezik, a második létrehozza a táblát a megfelelő mezőkkel, a harmadik pedig beilleszti az adatokat.

Tehát a mi kéréseink: 

  1. DROP TABLE IF EXISTS `#__hello`;
  2.  
  3. CREATE TABLE `#__hello` (
  4.   `id` int(11) NOT NULL AUTO_INCREMENT,
  5.   `greeting` varchar(25) NOT NULL,
  6.   PRIMARY KEY  (`id`)
  7. ) ENGINE=MyISAM AUTO_INCREMENT=0 DEFAULT CHARSET=utf8;
  8.  
  9. INSERT INTO `#__hello` (`greeting`) VALUES ('Hello, World!'),
  10. ('Bonjour, Monde!'),
  11. ('Ciao, Mondo!');

A tábla előtagját elég furának találhatjuk. A Joomla! lecseréli ezt az előtagot a telepített rendszer által használt előtaggal. A legtöbb telepítés esetén ez a tábla a jos_hello nevet kapja. Ezzel lehetőségünk van több Joomlát telepíteni ugyanannak az adatbázisnak a használatával, valamint megelőzi a más alkalmazásokkal való összeütközést, amelyek ugyanazt a táblenevet használják (pl. két alkalmazás lehet ugyanabban az adatbázisban, de mindkettőnek lehet egy 'users' táblája).

Két mezőt hoztunk létre az adatbázisunkban. Az első mező az id, amely egy elsődleges kulcs. Egy tábla elsődleges kulcsa az a mező, amely egyértelműen beazonosítja a rekordot. Ezt gyakran használják sorok megtalálására. A másik mező a greeting. Ez az a mező, amely tárolja az üdvözléseket és amelynek az értéke a fent használt kéréssel átadódik.

Egy install.utf.sql nevű fájlba mentjük el a kéréseinket.

Az eltávolító SQL fájl elkészítése

Habár azt gondolhatjuk, hogy az emberek soha sem fogják eltávolítani a komponensünket, fontos, hogy ha mégis megteszik, ne hagyjunk magunk után semmit. A Joomla! elvégzi a fájlok és könyvtárak törlését, amelyek a telepítés során jöttek létre, de az adatbázis eltávolításához maunálisan kell elhelyezni a kódot. Mivel csak egy táblát készítettünk, egy kérésre lesz szükségünk: 

  1. DROP TABLE IF EXISTS `#__hello`;

Ezt a kérést egy uninstall.utf.sql nevű fájlba mentjük.

A telepítő fájl frissítése

Néhány dolgot meg kell változtatnunk a telepítő fájlban. Először hozzá kell adnunk a két új fájlunkat a telepítendő fájlok listájához. Az SQL telepítő fájlnak az admin könyvtárban kell lennie. Másodszor, meg kell mondanunk a telepítőnek, hogy hajtsa végre a kéréseket telepítésnél és eltávolításnál.

Az új fájlunk így néz ki: 

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!DOCTYPE install SYSTEM "http://www.joomla.org/xml/dtd/1.5/component-install.dtd">
  3. <install type="component" version="1.5.0">
  4.    <name>Hello</name>
  5.    <!-- The following elements are optional and free of formatting conttraints -->
  6.    <creationDate>2007 02 22</creationDate>
  7.    <author>John Doe</author>
  8.    <authorEmail>john.doe@example.org</authorEmail>
  9.    <authorUrl>http://www.example.org</authorUrl>
  10.    <copyright>Copyright Info</copyright>
  11.    <license>License Info</license>
  12.    <!--  The version string is recorded in the components table -->
  13.    <version>Component Version String</version>
  14.    <!-- The description is optional and defaults to the name -->
  15.    <description>Description of the component ...</description> 
  16.    <!-- Site Main File Copy Section -->
  17.    <files folder="site">
  18.       <filename>index.html</filename>
  19.       <filename>hello.php</filename>
  20.       <filename>controller.php</filename>
  21.       <filename>views/index.html</filename>
  22.       <filename>views/hello/index.html</filename>
  23.       <filename>views/hello/view.html.php</filename>
  24.       <filename>views/hello/tmpl/index.html</filename>
  25.       <filename>views/hello/tmpl/default.php</filename>
  26.       <filename>models/hello.php</filename>
  27.       <filename>models/index.html</filename>
  28.    </files>
  29.  
  30.    <install>
  31.       <sql>
  32.          <file charset="utf8" driver="mysql">install.sql</file>
  33.       </sql>
  34.    </install>
  35.    <uninstall>
  36.       <sql>
  37.          <file charset="utf8" driver="mysql">uninstall.sql</file>
  38.       </sql>
  39.    </uninstall>
  40.  
  41.    <administration>
  42.       <!-- Administration Menu Section -->
  43.       <menu>Hello World!</menu>
  44.       <!-- Administration Main File Copy Section -->
  45.       <!-- Note the folder attribute: This attribute describes the folder
  46.          to copy FROM in the package to install therefore files copied
  47.          in this section are copied from /admin/ in the package -->
  48.       <files folder="admin">
  49.          <filename>index.html</filename>
  50.          <filename>admin.hello.php</filename>
  51.          <filename>install.sql</filename>
  52.          <filename>uninstall.sql</filename>
  53.       </files>      
  54.    </administration>
  55. </install>

Észrevehetjük, hogy a <file> tagnak két attributúma létezik: charset és driver. A charset a használni kívánt karakterkódolás. Az egyetlen érvényes karakterkódolás az utf8. Ha nem utf8 adatbázishoz kívánunk telepítő fájlt készíteni, akkor hagyjuk figyelmen kívül ezt az attribútumot.

A driver attribútum azt határozza meg, hogy milyen adatbázishoz készült a kérés. Jelenleg ez csak mysql lehet, de a Joomla! későbbi verzióban további adatbázisok is választhatók lesznek.

Összegzés

Most már van egy komponensünk, amely kihasználja mind a Joomla! MVC keretrendszer, mind pedig a JDatabase osztály előnyeit. Most már képesek vagyunk egy MVC komponens megírására, amely kapcsolatban áll az adatbázissal és a telepítőt használja adatbázis táblák létrehozására és felöltésére.

A leírásban szereplő com_hello komponens letöltése.

A cikk forrása: Joomla! Documentation

A lap eredeti címe: „http://wiki.joomla.org.hu/Hell%C3%B3%2C_vil%C3%A1g%21_komponens_k%C3%A9sz%C3%ADt%C3%A9se_3._r%C3%A9sz”