ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW

Source for file Sql.php

Documentation is available at Sql.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Object
  23.  * @package    ForwardFW
  24.  * @subpackage List
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009-2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.1
  31.  */
  32.  
  33. require_once 'ForwardFW/Controller/DataLoader.php';
  34. require_once 'ForwardFW/List.php';
  35. require_once 'ForwardFW/Object/Sql.php';
  36.  
  37. /**
  38.  * A list of models that can load themself from DB.
  39.  *
  40.  * @category   Object
  41.  * @package    ForwardFW
  42.  * @subpackage List
  43.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  44.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  45.  * @link       http://forwardfw.sourceforge.net
  46.  */
  47. class ForwardFW_List_Sql extends ForwardFW_List
  48. {
  49.     /**
  50.      * Name of the table, which is mostly a prefix and the object name
  51.      * in lowercase.
  52.      *
  53.      * @var string 
  54.      */
  55.     protected $strTableName = '';
  56.  
  57.     /**
  58.      * Prefix for the table name
  59.      *
  60.      * @access private
  61.      * @var string 
  62.      */
  63.     protected $strTablePrefix = '';
  64.  
  65.     /**
  66.      * Name of the connection which should be used for this object to load/save.
  67.      *
  68.      * @access private
  69.      * @var string 
  70.      */
  71.     protected $strDBConnection = '';
  72.  
  73.     /**
  74.      * constructor
  75.      *
  76.      * @param string $_strTablePrefix  Prefix der Tabellennamen im Projekt.
  77.      * @param string $_strDBConnection Name of the DB connection to use.
  78.      *
  79.      * @return new instance
  80.      */
  81.     function __construct($_strTablePrefix = '', $_strDBConnection = 'default')
  82.     {
  83.         parent::__construct();
  84.  
  85.         $this->strTablePrefix  = $_strTablePrefix;
  86.         $this->strDBConnection = $_strDBConnection;
  87.  
  88.         $this->strTableName = ForwardFW_Object_Sql::resolveTableName(
  89.             $this->strTablePrefix, $this->strObjectName
  90.         );
  91.     }
  92.  
  93.     /**
  94.      * Loads all data from given table.
  95.      *
  96.      * @return boolean True if object was loadable otherwise false.
  97.      */
  98.     function loadAll()
  99.     {
  100.         return $this->loadByWhereClause('');
  101.     }
  102.  
  103.     /**
  104.      * Loads all data from given table by given where clause.
  105.      *
  106.      * @param string $strWhereClause Where clause for the select.
  107.      * @param string $strGroupBy     Group by clause for the select.
  108.      * @param string $strOrderBy     Order by clause for the select.
  109.      * @param string $strLimit       Limit clause for the select.
  110.      *
  111.      * @return boolean True if object was loadable otherwise false.
  112.      */
  113.     function loadByWhereClause(
  114.         $strWhereClause, $strGroupBy = '', $strOrderBy = '', $strLimit = ''
  115.     ) {
  116.         $objDataLoader = ForwardFW_Controller_DataLoader::getInstance(
  117.             $this->strApplicationName
  118.         );
  119.         $arResult = $objDataLoader->loadFromDB(
  120.             $this->strDBConnection,
  121.             '*',
  122.             $this->strTableName,
  123.             $strWhereClause,
  124.             $strGroupBy,
  125.             $strOrderBy,
  126.             $strLimit
  127.         );
  128.         if ($arResult !== false) {
  129.             $this->loadByArray($arResult);
  130.             return true;
  131.         }
  132.         return false;
  133.     }
  134. }
  135. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:46 +0100 by phpDocumentor 1.4.3