1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Files
archived-doc-en/language/predefined/php-incomplete-class.xml
2026-01-02 14:37:19 +01:00

150 lines
3.8 KiB
XML

<?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 role="attribute">#[\AllowDynamicProperties]</modifier>
<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
-->