Source for file dumpable.php

Documentation is available at dumpable.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  Data
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * An interface to define if an object is dumpable.
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  Data
  17.  * @since       12.3
  18.  */
  19. interface JDataDumpable
  20. {
  21.     /**
  22.      * Dumps the object properties into a stdClass object, recursively if appropriate.
  23.      *
  24.      * @param   integer           $depth   The maximum depth of recursion.
  25.      *                                      For example, a depth of 0 will return a stdClass with all the properties in native
  26.      *                                      form. A depth of 1 will recurse into the first level of properties only.
  27.      * @param   SplObjectStorage  $dumped  An array of already serialized objects that is used to avoid infinite loops.
  28.      *
  29.      * @return  stdClass  The data properties as a simple PHP stdClass object.
  30.      *
  31.      * @since   12.3
  32.      */
  33.     public function dump($depth = 3, SplObjectStorage $dumped = null);
  34. }

Documentation generated on Tue, 19 Nov 2013 15:01:45 +0100 by phpDocumentor 1.4.3