39 lines
1.2 KiB
PHP
39 lines
1.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Sabre\Xml;
|
|
|
|
/**
|
|
* Implementing the XmlDeserializable interface allows you to use a class as a
|
|
* deserializer for a specific element.
|
|
*
|
|
* @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
|
|
* @author Evert Pot (http://evertpot.com/)
|
|
* @license http://sabre.io/license/ Modified BSD License
|
|
*/
|
|
interface XmlDeserializable
|
|
{
|
|
/**
|
|
* The deserialize method is called during xml parsing.
|
|
*
|
|
* This method is called statically, this is because in theory this method
|
|
* may be used as a type of constructor, or factory method.
|
|
*
|
|
* Often you want to return an instance of the current class, but you are
|
|
* free to return other data as well.
|
|
*
|
|
* You are responsible for advancing the reader to the next element. Not
|
|
* doing anything will result in a never-ending loop.
|
|
*
|
|
* If you just want to skip parsing for this element altogether, you can
|
|
* just call $reader->next();
|
|
*
|
|
* $reader->parseInnerTree() will parse the entire sub-tree, and advance to
|
|
* the next element.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public static function xmlDeserialize(Reader $reader);
|
|
}
|