joomla_test/libraries/joomla/data/dumpable.php
2020-01-02 22:20:31 +07:00

35 lines
1.1 KiB
PHP

<?php
/**
* @package Joomla.Platform
* @subpackage Data
*
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* An interface to define if an object is dumpable.
*
* @package Joomla.Platform
* @subpackage Data
* @since 12.3
*/
interface JDataDumpable
{
/**
* Dumps the object properties into a stdClass object, recursively if appropriate.
*
* @param integer $depth The maximum depth of recursion.
* For example, a depth of 0 will return a stdClass with all the properties in native
* form. A depth of 1 will recurse into the first level of properties only.
* @param SplObjectStorage $dumped An array of already serialized objects that is used to avoid infinite loops.
*
* @return stdClass The data properties as a simple PHP stdClass object.
*
* @since 12.3
*/
public function dump($depth = 3, SplObjectStorage $dumped = null);
}