-
Notifications
You must be signed in to change notification settings - Fork 860
Expand file tree
/
Copy pathweakreference.xml
More file actions
133 lines (116 loc) · 3.62 KB
/
weakreference.xml
File metadata and controls
133 lines (116 loc) · 3.62 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.weakreference" 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 WeakReference class</title>
<titleabbrev>WeakReference</titleabbrev>
<partintro>
<!-- {{{ WeakReference intro -->
<section xml:id="weakreference.intro">
&reftitle.intro;
<para>
Weak references allow the programmer to retain a reference to an object which does not prevent
the object from being destroyed. They are useful for implementing cache like structures.
If the original object has been destroyed, &null; will be returned
when calling the <methodname>WeakReference::get</methodname> method.
The original object will be destroyed when the
<link linkend="features.gc.refcounting-basics">refcount</link> for it drops to zero;
creating weak references does not increase the <literal>refcount</literal> of the object being referenced.
</para>
<para>
<classname>WeakReference</classname>s cannot be serialized.
</para>
</section>
<!-- }}} -->
<section xml:id="weakreference.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<modifier>final</modifier>
<classname>WeakReference</classname>
</ooclass>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.weakreference')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='WeakReference'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.weakreference')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='WeakReference'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<section xml:id="weakreference.examples">
<title>WeakReference Examples</title>
<para>
<example xml:id="weakreference.basic-example">
<title>Basic WeakReference Usage</title>
<programlisting role="php">
<![CDATA[
<?php
$obj = new stdClass();
$weakref = WeakReference::create($obj);
var_dump($weakref->get());
unset($obj);
var_dump($weakref->get());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(stdClass)#1 (0) {
}
NULL
]]>
</screen>
</example>
</para>
</section>
<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The output of <methodname>WeakReference::__debugInfo</methodname> now includes
the referenced object, or <literal>NULL</literal> if the reference is no longer
valid.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</partintro>
&language.predefined.weakreference.construct;
&language.predefined.weakreference.create;
&language.predefined.weakreference.get;
</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
-->