php-doc-en/language/predefined/serializable.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.serializable" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The Serializable interface</title>
 <titleabbrev>Serializable</titleabbrev>

 <partintro>

<!-- {{{ Serializable intro -->
  <section xml:id="serializable.intro">
   &reftitle.intro;
   <para>
    Interface for customized serializing.
   </para>

   <para>
    Classes that implement this interface no longer support
    <link linkend="object.sleep">__sleep()</link> and
    <link linkend="object.wakeup">__wakeup()</link>. The method serialize is
    called whenever an instance needs to be serialized. This does not invoke __destruct()
    or have any other side effect unless programmed inside the method. When the data is
    unserialized the class is known and the appropriate unserialize() method is called as
    a constructor instead of calling __construct(). If you need to execute the standard
    constructor you may do so in the method.
   </para>
   
   <warning>
    <para>
     As of PHP 8.1.0, a class which implements <interfacename>Serializable</interfacename> without also implementing <link linkend="object.serialize">__serialize()</link> and <link linkend="object.unserialize">__unserialize()</link> will generate a deprecation warning.
    </para>
   </warning>
  </section>
<!-- }}} -->

  <section xml:id="serializable.synopsis">
   &reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>Serializable</classname>
    </ooclass>

    <classsynopsisinfo>
     <oointerface>
      <interfacename>Serializable</interfacename>
     </oointerface>
    </classsynopsisinfo>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.serializable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

  <section xml:id="serializable.examples">
   <example xml:id="serializable.example.basic"><!-- {{{ -->
    <title>Basic usage</title>
    <programlisting role="php">
<![CDATA[
<?php
class obj implements Serializable {
    private $data;
    public function __construct() {
        $this->data = "My private data";
    }
    public function serialize() {
        return serialize($this->data);
    }
    public function unserialize($data) {
        $this->data = unserialize($data);
    }
    public function getData() {
        return $this->data;
    }
}

$obj = new obj;
$ser = serialize($obj);

var_dump($ser);

$newobj = unserialize($ser);

var_dump($newobj->getData());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
string(38) "C:3:"obj":23:{s:15:"My private data";}"
string(15) "My private data"
]]>
    </screen>
   </example><!-- }}} -->
  </section>


 </partintro>

 &language.predefined.serializable.serialize;
 &language.predefined.serializable.unserialize;

</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->