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

Source for file Object.php

Documentation is available at Object.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 Main
  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. /**
  34.  * A basic object/model inside ForwardFW, which can autoload its data fields.
  35.  *
  36.  * @category   Object
  37.  * @package    ForwardFW
  38.  * @subpackage Main
  39.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  40.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  41.  * @link       http://forwardfw.sourceforge.net
  42.  */
  43. class ForwardFW_Object
  44. {
  45.     /*
  46.      * ID value
  47.      *
  48.      * @var mixed
  49.      */
  50.     protected $ID = 0;
  51.  
  52.     /**
  53.      * Name of the field in data array, which holds the ID
  54.      *
  55.      * @var string 
  56.      */
  57.     protected $strIdFieldName = 'ID';
  58.  
  59.     /**
  60.      * Constructur
  61.      *
  62.      * @param strinf $_strIdFieldName Name of the ID field in data
  63.      *
  64.      * @return new instance
  65.      */
  66.     function __construct($_strIdFieldName = 'ID')
  67.     {
  68.         $this->strIdFieldName = $_strIdFieldName;
  69.     }
  70.  
  71.     /**
  72.      * Loads the model data out of an array as data set
  73.      *
  74.      * @param array &$arRow The array with data to read out
  75.      *
  76.      * @return void 
  77.      */
  78.     function loadByArray(&$arRow)
  79.     {
  80.         $this->ID = $arRow[$this->strIdFieldName];
  81.     }
  82.  
  83.     /**
  84.      * Saves the model data into an array as data set
  85.      *
  86.      * @param array &$arRow The array into which the data will be written
  87.      *
  88.      * @return void 
  89.      */
  90.     function saveToArray(&$arRow)
  91.     {
  92.         $arRow[$this->strIdFieldName] = $this->ID;
  93.     }
  94. }
  95. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:44 +0100 by phpDocumentor 1.4.3