File: WeakRef.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (34 lines) | stat: -rw-r--r-- 1,661 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="WeakRef" namespace="" name="WeakRef">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a new weak reference"/>
      <return type="void"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </constructor>
  <method name="acquire" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Acquires a strong reference on that object">Acquires a strong reference on that object, virtually turning the weak reference into a strong one.</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the object pointed to by the weak reference"/>
      <return type="object"/>
    </docblock>
  </method>
  <method name="release" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Releases a previously acquired reference">Releases a previously acquired reference, potentially turning a strong reference back into a weak reference.</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks whether the object referenced still exists"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>