1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>The __PHP_Incomplete_Class class</title>
<titleabbrev>__PHP_Incomplete_Class</titleabbrev>
<partintro>
<section xml:id="php-incomplete-class.intro">
&reftitle.intro;
<para>
Created by <function>unserialize</function>
when trying to unserialize an undefined class
or a class that is not listed in the <literal>allowed_classes</literal>
of <function>unserialize</function>'s <parameter>options</parameter> array.
</para>
<para>
Prior to PHP 7.2.0, using <function>is_object</function> on the
<classname>__PHP_Incomplete_Class</classname> class would return &false;.
As of PHP 7.2.0, &true; will be returned.
</para>
</section>
<section xml:id="php-incomplete-class.synopsis">
&reftitle.classsynopsis;
<classsynopsis class="class">
<ooclass>
<modifier>final</modifier>
<classname>__PHP_Incomplete_Class</classname>
</ooclass>
</classsynopsis>
<para>
This class has no default properties or methods.
When created by <function>unserialize</function>,
in addition to all unserialized properties and values
the object will have a <literal>__PHP_Incomplete_Class_Name</literal> property
which will contain the name of the unserialized class.
</para>
</section>
<section xml:id="php-incomplete-class.changelog" role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
This class is now <literal>final</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section xml:id="php-incomplete-class.examples" role="examples">
&reftitle.examples;
<example xml:id="php-incomplete-class.basic-example">
<title>Created by <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
-->
|