archived-doc-zh/language/predefined/arrayaccess/offsetget.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ed312486fff2251b6625b017df2e8f847f656296 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<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
-->