Files
André L F S Bacci 92dac04ad0 "Update translation."
2023-04-03 13:27:27 -03:00

130 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ed312486fff2251b6625b017df2e8f847f656296 Maintainer: ae Status: ready --><!-- CREDITS: fabioluciano,ae -->
<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>Posição a ser obtida</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>
Retorna o valor de uma posição específica.
</para>
<para>
Este método é executado ao checar se uma posição está vazia, com a função <function>empty</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
A posição a ser obtida.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Pode retornar valores de qualquer tipo.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
É possível para implementações deste método serem retornadas por referência.
Isso modifica indiretamente a sobrecarga de dimensões do array de objetos
<classname>ArrayAccess</classname> possíveis.
</para>
<para>
Uma modificação direta é aquela que substitui completamente o valor de
uma dimensão do array, como em <literal>$obj[6] = 7</literal>. Uma
modificação indireta, por outro lado, modifica somente parte da
dimensão, ou tenta atribuir a dimensão por referência a
outra variável, como em <literal>$obj[6][7] = 7</literal> ou
<literal>$var =&amp; $obj[6]</literal>. Incrementos com
<literal>++</literal> e decrementos com <literal>--</literal>
também são implementados de forma a exigirem modificações indiretas.
</para>
<para>
Enquanto uma modificação direta engatilha uma chamada ao método
<function>ArrayAccess::offsetSet</function>, uma modificação indireta
engatilha uma chamada ao <function>ArrayAccess::offsetGet</function>.
Neste caso, a implementação do método
<function>ArrayAccess::offsetGet</function> deve permitir o retorno por
referência, caso contrário uma mensagem <constant>E_NOTICE</constant> será disparada.
</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
-->