php-incomplete-class.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 26e26a95fdc3aac9b464068953ea3105dee00f14 Maintainer: mumumu Status: ready -->
<reference xml:id="class.php-incomplete-class" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>__PHP_Incomplete_Class クラス</title>
 <titleabbrev>__PHP_Incomplete_Class</titleabbrev>

 <partintro>

  <section xml:id="php-incomplete-class.intro">
   &reftitle.intro;
   <para>
    未定義のクラスや、
    <function>unserialize</function> の <parameter>options</parameter>
    配列の <literal>allowed_classes</literal> のリストに入っていなかったクラスを
    アンシリアライズしようとした場合に、
    <function>unserialize</function> が生成します。
   </para>

   <para>
    PHP 7.2.0 より前のバージョンでは、
    <classname>__PHP_Incomplete_Class</classname>
    に対して <function>is_object</function>
    を呼び出すと &false; を返していました。
    PHP 7.2.0 以降では &true; を返します。
   </para>
  </section>

  <section xml:id="php-incomplete-class.synopsis">
   &reftitle.classsynopsis;

   <classsynopsis class="class">
    <ooclass>
     <classname>__PHP_Incomplete_Class</classname>
    </ooclass>
   </classsynopsis>

   <para>
    このクラスはデフォルトのプロパティやメソッドを持っていません。
    <function>unserialize</function> がこのクラスを生成した場合、
    アンシリアライズされたプロパティやオブジェクトの値について、
    アンシリアライズされたクラス名を含む
    <literal>__PHP_Incomplete_Class_Name</literal> プロパティを持ちます。
   </para>
  </section>

  <section xml:id="php-incomplete-class.examples" role="examples">
   &reftitle.examples;
   <example xml:id="php-incomplete-class.basic-example">
    <title><function>unserialize</function> によって生成されるクラス</title>
    <programlisting role="php">
<![CDATA[
<?php

class MyClass
{
    public string $property = "myValue";
}

$myObject = new MyClass;

$foo = serialize($myObject);

// unserializes all objects into __PHP_Incomplete_Class objects
$disallowed = unserialize($foo, ["allowed_classes" => false]);

var_dump($disallowed);

// unserializes all objects into __PHP_Incomplete_Class objects except those of MyClass2 and MyClass3
$disallowed2 = unserialize($foo, ["allowed_classes" => ["MyClass2", "MyClass3"]]);

var_dump($disallowed2);

// unserializes undefined class into __PHP_Incomplete_Class object
$undefinedClass = unserialize('O:16:"MyUndefinedClass":0:{}');

var_dump($undefinedClass);
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[

object(__PHP_Incomplete_Class)#2 (2) {
  ["__PHP_Incomplete_Class_Name"]=>
  string(7) "MyClass"
  ["property"]=>
  string(7) "myValue"
}
object(__PHP_Incomplete_Class)#3 (2) {
  ["__PHP_Incomplete_Class_Name"]=>
  string(7) "MyClass"
  ["property"]=>
  string(7) "myValue"
}
object(__PHP_Incomplete_Class)#4 (1) {
  ["__PHP_Incomplete_Class_Name"]=>
  string(16) "MyUndefinedClass"
}

]]>
    </screen>
   </example>
  </section>

 </partintro>

</reference>
<!-- 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
-->