b2evolution

Multilingual multiuser multiblog engine

Home About Demo Download Hosting Extend Docs Support
b2evolution Technical Documentation (0.9.x) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Source for file _class_dataobjectlist.php

Documentation is available at _class_dataobjectlist.php

  1. <?php
  2. /**
  3.  * Data Object List Base Class
  4.  * 
  5.  * "data objects by fplanque" :P
  6.  *
  7.  * b2evolution - {@link http://b2evolution.net/}
  8.  * Released under GNU GPL License - {@link http://b2evolution.net/about/license.html}
  9.  * @copyright (c)2003-2005 by Francois PLANQUE - {@link http://fplanque.net/}
  10.  *
  11.  * @package evocore
  12.  */
  13. if( !defined('DB_USER') ) die( 'Please, do not access this page directly.' );
  14.  
  15. /**
  16.  * Data Object List Base Class
  17.  *
  18.  * This is typically an abstract class, useful only when derived.
  19.  *
  20.  * @package evocore
  21.  * @version beta
  22.  * @abstract
  23.  */
  24. class DataObjectList
  25. {
  26.     /**#@+
  27.      * @access private
  28.      */
  29.     var    $dbtablename;
  30.     var $dbprefix;
  31.     var $dbIDname;
  32.     var $posts_per_page = 15;            
  33.     /** 
  34.      * SQL query string
  35.      */
  36.     var $request;
  37.     /**
  38.      * DB Result set (array)
  39.      */
  40.     var $result;
  41.     /**
  42.      * Number of rows in result set. Typically equal to $posts_per_page, once loaded.
  43.      */
  44.     var $result_num_rows = 0;
  45.     /**
  46.      * Object array
  47.      */
  48.     var $Obj = array();
  49.     /**
  50.      * Current object idx in array:
  51.      */
  52.     var $current_idx = 0;
  53.     /**#@-*/
  54.  
  55.     /** 
  56.      * Constructor
  57.      *
  58.      * {@internal DataObjectList::DataObjectList(-) }}
  59.      *
  60.      * @param string Name of table in database
  61.      * @param string Prefix of fields in the table
  62.      * @param string Name of the ID field (including prefix)
  63.      */
  64.     function DataObjectList( $tablename, $prefix = '', $dbIDname = 'ID' )
  65.     {
  66.         $this->dbtablename = $tablename;
  67.         $this->dbprefix = $prefix;
  68.         $this->dbIDname = $dbIDname;
  69.     }    
  70.  
  71.     /**
  72.      * Get nummber of rows available for display
  73.      *
  74.      * {@internal DataObjectList::get_num_rows(-) }}
  75.      *
  76.      * @return integer 
  77.      */
  78.     function get_num_rows()
  79.     {
  80.         return $this->result_num_rows;
  81.     }
  82.  
  83.     /** 
  84.      * Get next comment in list
  85.      *
  86.      * {@internal CommentList::get_next(-) }}
  87.      */
  88.     function get_next()
  89.     {
  90.         if( $this->current_idx >= $this->result_num_rows )
  91.         {    // No more comment in list
  92.             return false;
  93.         }
  94.         return  $this->Obj[$this->current_idx++];
  95.     }
  96.  
  97.     /**
  98.      * Rewind resultset
  99.      *
  100.      * {@internal DataObjectList::restart(-) }}
  101.      */
  102.     function restart()
  103.     {
  104.         $this->current_idx = 0;
  105.     }
  106.     
  107.     
  108.     /**
  109.      * Template function: display message if list is empty
  110.      *
  111.      * {@internal DataObjectList::display_if_empty(-) }}
  112.      *
  113.      * @param string String to display if list is empty
  114.    * @return true if empty
  115.      */
  116.     function display_if_empty( $message = '' )
  117.     {
  118.         if( empty($message) ) 
  119.         {    // Default message:
  120.             $message = T_('Sorry, there is nothing to display...');
  121.         }
  122.  
  123.         if( $this->result_num_rows == 0 )
  124.         {
  125.             echo $message;
  126.       return true;
  127.         }
  128.     return false;
  129.     }
  130.     
  131. }
  132. ?>
evocore

Packages

main
admin
conf
evocore
evoskins
htsrv
install
plugins
xmlsrv

Documentation generated on Tue, 20 May 2008 01:52:53 +0200 by phpDocumentor 1.4.2