classes/plexportable.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program 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          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 // {{{ interface PlExportable
  23 /** PlExportable intends to enable a robust exportation of objects.
  24  *  By explicitly implementing the exportation process, PlExportable classes are
  25  *  able to be rebuilt from their exportation, even if the class has been modified
  26  *  inbetween, a case that classic php serialization badly handle.
  27  */
  28 interface PlExportable
  29 {
  30     /** Returns an associative array containing the neccessary
  31      *  datas to rebuild the instance. The result can then be serialized,
  32      *  for example thank the json_encode() function.
  33      */
  34     public function export();
  35 }
  36 // }}}
  37
  38 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
  39 ?>