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