Files
2024-09-13 09:58:50 -03:00

82 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e50e79746736dbdfbabe9bd3566793b3ddf38f58 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: fernandowobeto,leonardolara -->
<refentry xml:id="reflectionreference.fromarrayelement" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionReference::fromArrayElement</refname>
<refpurpose>Cria um ReflectionReference a partir de um elemento de array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ReflectionReference">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>ReflectionReference</type><type>null</type></type><methodname>ReflectionReference::fromArrayElement</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
<methodparam><type class="union"><type>int</type><type>string</type></type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Cria um <classname>ReflectionReference</classname> a partir de um elemento de array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
O &array; que contém a referência potencial.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
A chave; ou um &integer; ou uma &string;.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna uma instância de <classname>ReflectionReference</classname> se
<literal>$array[$key]</literal> for uma referência, ou &null; caso contrário.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Se <parameter>array</parameter> não for um &array;, ou <parameter>key</parameter>
não for um &integer; ou &string;, um <classname>TypeError</classname> é lançado.
Se <literal>$array[$key]</literal> não existir,
uma exceção <classname>ReflectionException</classname> é lançada.
</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
-->