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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 305566 $ -->
<refentry xml:id="arrayaccess.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayAccess::offsetGet</refname>
<refpurpose>Offset to retrieve</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>mixed</type><methodname>ArrayAccess::offsetGet</methodname>
<methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the value at specified offset.
</para>
<para>
This method is executed when checking if offset is <function>empty</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The offset to retrieve.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Starting with PHP 5.3.4, the prototype checks were relaxed and it's
possible for implementations of this method to return by reference.
This makes indirect modifications to the overloaded array dimensions of
<classname>ArrayAccess</classname> objects possible.
</para>
<para>
A direct modification is one that replaces completely the value of
the array dimension, as in <literal>$obj[6] = 7</literal>. An
indirect modification, on the other hand, only changes part of the
dimension, or attempts to assign the dimension by reference to
another variable, as in <literal>$obj[6][7] = 7</literal> or
<literal>$var =& $obj[6]</literal>. Increments with
<literal>++</literal> and decrements with <literal>--</literal>
are also implemented in a way that requires indirect modification.
</para>
<para>
While direct modification triggers a call to
<function>ArrayAccess::offsetSet</function>, indirect modification
triggers a call to <function>ArrayAccess::offsetGet</function>.
In that case, the implementation of
<function>ArrayAccess::offsetGet</function> must be able to return by
reference, otherwise an <constant>E_NOTICE</constant> message is raised.
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Can return all value types.
</para>
</refsect1>
<!--
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ArrayAccess::offsetGet</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ArrayAccess::offsetExists</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->
|
