1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
2022-12-13 01:32:36 +09:00

131 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ed312486fff2251b6625b017df2e8f847f656296 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<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>オフセットを取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ArrayAccess">
<modifier>public</modifier> <type>mixed</type><methodname>ArrayAccess::offsetGet</methodname>
<methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
指定したオフセットの値を返します。
</para>
<para>
このメソッドは、オフセットが <function>empty</function> かどうかを調べる際に実行されます。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
取得したいオフセット。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
すべての型の値を返すことができます。
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
このメソッドの実装で参照を返すことができます。
これにより、<classname>ArrayAccess</classname>
オブジェクトのオーバーロードされた配列に対する間接的な変更ができます。
</para>
<para>
直接的な変更とは、<literal>$obj[6] = 7</literal>
のように配列のその次元の値を完全に置き換える変更のことです。
一方、間接的な変更とは、<literal>$obj[6][7] = 7</literal>
のようにその次元の一部分のみを変更したり <literal>$var =&amp; $obj[6]</literal>
のように他の変数に参照を代入したりする変更のことです。
<literal>++</literal> によるインクリメントや <literal>--</literal>
によるデクリメントもまた、ある意味では間接的な変更を要するものです。
</para>
<para>
直接的な変更の際には <function>ArrayAccess::offsetSet</function>
がコールされますが、間接的な変更の際には
<function>ArrayAccess::offsetGet</function> がコールされます。この場合は
<function>ArrayAccess::offsetGet</function>
の実装が参照を返せるようにしておく必要があります。
そうしなければ <constant>E_NOTICE</constant> メッセージが発生します。
</para>
</note>
</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
-->