mirror of
https://github.com/php/doc-fr.git
synced 2026-04-29 17:53:17 +02:00
Pierre Ambroise
87 lines
2.5 KiB
XML
87 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 87a1b45a66c1ecc435dedd4e295f3c7140959e4b Maintainer: Fan2Shrek Status: ready -->
|
|
<!-- Reviewed: yes -->
|
|
<refentry xml:id="mongodb-bson-document.offsetget" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>MongoDB\BSON\Document::offsetGet</refname>
|
|
<refpurpose>Retourne la valeur d'une clé dans un document</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="MongoDB\BSON\Document">
|
|
<modifier>final</modifier> <modifier>public</modifier> <type>mixed</type><methodname>MongoDB\BSON\Document::offsetGet</methodname>
|
|
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La clé à récupérer dans le document.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Renvoie la valeur associée à la clé donnée. Si la clé n'est pas présente dans
|
|
le document, une exception est lancée.
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
Lorsqu'une valeur encodée en tant qu'entier 64 bits est rencontrée dans le document BSON,
|
|
la valeur de retour de cette méthode sera une
|
|
instance de <classname>MongoDB\BSON\Int64</classname>.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<simplelist>
|
|
&mongodb.throws.argumentparsing;
|
|
<member>Lance une <classname>MongoDB\Driver\Exception\RuntimeException</classname> si la clé n'est pas présente dans le document.</member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ArrayAccess::offsetGet</methodname></member>
|
|
<member><methodname>MongoDB\BSON\Document::get</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
|
|
-->
|