Source for file IIsDBListClass.class.php

Documentation is available at IIsDBListClass.class.php

  1. <?php
  2. /**
  3.  * R.E. DBObjects
  4.  *
  5.  * @author Takács Ákos (Rimelek), programmer [at] rimelek [dot] hu
  6.  * @copyright Copyright (C) 2010, Takács Ákos
  7.  * @version 2.1
  8.  * @license http://www.gnu.org/licenses/lgpl.html
  9.  * @package REDBObjects
  10.  */
  11.  
  12. /**
  13.  * IIsDBListClass interfész
  14.  *
  15.  * Ezt az interfészt kell megvalósítania azoknak az osztályoknak, amik
  16.  * a rekordlistát szeretnék megvalósítani.
  17.  *
  18.  * @author Takács Ákos (Rimelek), programmer [at] rimelek [dot] hu
  19.  * @copyright Copyright (C) 2010, Takács Ákos
  20.  * @license http://www.gnu.org/licenses/lgpl.html
  21.  * @package REDBObjects
  22.  */
  23. interface IIsDBListClass extends Countable
  24. {
  25.     /**
  26.      * A listához új elem hozzáadása
  27.      *
  28.      * @param IIsDBClass $object 
  29.      */
  30.     function add(IIsDBClass $object);
  31.     
  32.     /**
  33.      * Lista inicializálása
  34.      *
  35.      * @param string $sql sql lekérdezés FROM utáni része ( limit záradék nélkül )
  36.      * @param int $offset Eltolás. Az eredményhalmaz elejéből ennyi sort kihagy.
  37.      * @param int $limit Egyszerre ennyi sort fog lekérdezni. Elhagyása esetén mindet.
  38.      */
  39.     function init($sql,&$offset=0,$limit=0);
  40.  
  41.     /**
  42.      * Egy tábla rekordjainak törlése
  43.      *
  44.      * @param string $keyName Melyik elsődleges kulcs mező szerint töröljön.
  45.      *                              Amelyik táblába tartozik a mező, annak egy rekordját fogja törölni
  46.      * @param string $keyValue Az elsődleges kulcs mező értéke.
  47.      * @return int Törölt rekordok száma
  48.      */
  49.     function delete($keyName,$keyValue);
  50.  
  51.     /**
  52.      * Egyszerre minimum hány oldal szükséges a lista összes elemének megjelenítésére
  53.      * adott limit mellett
  54.      *
  55.      * @return int 
  56.      */
  57.     function countPages();
  58.  
  59.     /**
  60.      * Összesen hány rekordra illeszkedik a lista ( lekérdezés )
  61.      *
  62.      * @return int 
  63.      */
  64.     function countRecords();
  65. }
  66. ?>

Documentation generated on Fri, 02 Apr 2010 17:34:17 +0200 by phpDocumentor 1.4.1