inc/classes/interfaces/extended/class_LimitableObject.php

   1 <?php
   2 /**
   3  * This is an inface for limiting object while saving them with the
   4  * DatabaseConnection class.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0
   8  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   9  * @license             GNU GPL 3.0 or any newer version
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface LimitableObject extends FrameworkInterface {
  25         /**
  26          * Reduces the volume of a processed object.
  27          *
  28          * @param               $limitInstance          An instance to ObjectLimits which holds
  29          *                                                      attribute names that we want to include
  30          *                                                      in the processing phase. Other attributes
  31          *                                                      except $uniqueID and $realClass will be
  32          *                                                      ignored and keept out.
  33          * @return      void
  34          */
  35         function limitObject (ObjectLimits $limitInstance);
  36 }
  37
  38 // [EOF]
  39 ?>