binary.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4639881688d3faaf0073ad71fe0a4b730aea15a0 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->

<reference xml:id="class.mongodb-bson-binary" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>La clase MongoDB\BSON\Binary</title>
 <titleabbrev>MongoDB\BSON\Binary</titleabbrev>

 <partintro>

<!-- {{{ MongoDB\BSON\Binary intro -->
  <section xml:id="mongodb-bson-binary.intro">
   &reftitle.intro;
   <para>
    Tipo BSON para datos binarios (i.e. array de bytes). Los valores binarios también tienen un subtipo, que se utiliza para indicar qué tipo de datos se encuentra en el array de bytes. Los subtipos de cero a 127 están predefinidos o reservados. Los subtipos de 128-255 son definidos por el usuario.
   </para>
  </section>
  <!-- }}} -->

  <section xml:id="mongodb-bson-binary.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>MongoDB\BSON\Binary</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <modifier>final</modifier>
     <ooclass>
      <classname>MongoDB\BSON\Binary</classname>
     </ooclass>

     <oointerface>
      <interfacename>MongoDB\BSON\BinaryInterface</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>MongoDB\BSON\Type</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>JsonSerializable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Stringable</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-generic">MongoDB\BSON\Binary::TYPE_GENERIC</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-function">MongoDB\BSON\Binary::TYPE_FUNCTION</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-old-binary">MongoDB\BSON\Binary::TYPE_OLD_BINARY</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-old-uuid">MongoDB\BSON\Binary::TYPE_OLD_UUID</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-uuid">MongoDB\BSON\Binary::TYPE_UUID</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-md5">MongoDB\BSON\Binary::TYPE_MD5</varname>
     <initializer>5</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-encrypted">MongoDB\BSON\Binary::TYPE_ENCRYPTED</varname>
     <initializer>6</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-column">MongoDB\BSON\Binary::TYPE_COLUMN</varname>
     <initializer>7</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-sensitive">MongoDB\BSON\Binary::TYPE_SENSITIVE</varname>
     <initializer>8</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="mongodb-bson-binary.constants.type-user-defined">MongoDB\BSON\Binary::TYPE_USER_DEFINED</varname>
     <initializer>128</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-bson-binary')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ MongoDB\BSON\Binary constants -->
  <section xml:id="mongodb-bson-binary.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-generic">
     <term><constant>MongoDB\BSON\Binary::TYPE_GENERIC</constant></term>
     <listitem>
      <para>Datos binarios genéricos.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-function">
     <term><constant>MongoDB\BSON\Binary::TYPE_FUNCTION</constant></term>
     <listitem>
      <para>Función.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-old-binary">
     <term><constant>MongoDB\BSON\Binary::TYPE_OLD_BINARY</constant></term>
     <listitem>
      <para>
       Datos binarios genéricos (desaconsejados en favor de <constant>MongoDB\BSON\Binary::TYPE_GENERIC</constant>).
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-old-uuid">
     <term><constant>MongoDB\BSON\Binary::TYPE_OLD_UUID</constant></term>
     <listitem>
      <para>
       Identificador universalmente único (desaconsejado en favor de
       <constant>MongoDB\BSON\Binary::TYPE_UUID</constant>). Al utilizar este tipo, los datos del binario deben tener una longitud de 16 bytes.
      </para>
      <para>
       Históricamente, otros controladores codifican valores con este tipo según sus convenciones lingüísticas (por ejemplo, variable indianness), lo que lo hace no portable. El controlador PHP no aplica ninguna manipulación especial para codificar o decodificar datos con este tipo.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-uuid">
     <term><constant>MongoDB\BSON\Binary::TYPE_UUID</constant></term>
     <listitem>
      <para>Identificador universalmente único. Al utilizar este tipo, los datos del binario deben tener una longitud de 16 bytes y estar codificados según <link xlink:href="&url.rfc;4122">RFC 4122</link>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-md5">
     <term><constant>MongoDB\BSON\Binary::TYPE_MD5</constant></term>
     <listitem>
      <para>
       Hash MD5. Al utilizar este tipo, los datos del binario deben tener una longitud de 16 bytes.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-encrypted">
     <term><constant>MongoDB\BSON\Binary::TYPE_ENCRYPTED</constant></term>
     <listitem>
      <para>Valor cifrado. Este subtipo se utiliza para el cifrado del lado del cliente.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-column">
     <term><constant>MongoDB\BSON\Binary::TYPE_COLUMN</constant></term>
     <listitem>
      <para>Dato de columna. Este subtipo se utiliza para las colecciones de series temporales.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-sensitive">
     <term><constant>MongoDB\BSON\Binary::TYPE_SENSITIVE</constant></term>
     <listitem>
      <para>
       Datos sensibles. Este subtipo se utiliza para los datos sensibles
       que deberían ser excluidos de los registros de eventos del lado del servidor si es posible.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-bson-binary.constants.type-user-defined">
     <term><constant>MongoDB\BSON\Binary::TYPE_USER_DEFINED</constant></term>
     <listitem>
      <para>
       Tipo definido por el usuario. Mientras que los tipos entre 0 y 127 están predefinidos o reservados, los tipos entre 128 y 255 son definidos por el usuario y pueden ser utilizados para cualquier cosa.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
  <!-- }}} -->

  <section role="changelog">
   &reftitle.changelog;
   <para>
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>&Version;</entry>
        <entry>&Description;</entry>
       </row>
      </thead>
      <tbody>
       &mongodb.changelog.serializable-interface-removed;
       <row>
        <entry>PECL mongodb 1.17.0</entry>
        <entry>
         Adición de <constant>MongoDB\BSON\Binary::TYPE_SENSITIVE</constant>.
        </entry>
       </row>
       <row>
        <entry>PECL mongodb 1.12.0</entry>
        <entry>
         <para>
          Implementa <interfacename>Stringable</interfacename> para PHP 8.0+.
         </para>
         <para>
          Adición de <constant>MongoDB\BSON\Binary::TYPE_COLUMN</constant>.
         </para>
        </entry>
       </row>
       <row>
        <entry>PECL mongodb 1.7.0</entry>
        <entry>
         Adición de <constant>MongoDB\BSON\Binary::TYPE_ENCRYPTED</constant>.
        </entry>
       </row>
       <row>
        <entry>PECL mongodb 1.3.0</entry>
        <entry>
         Implementa <interfacename>MongoDB\BSON\BinaryInterface</interfacename>.
        </entry>
       </row>
       <row>
        <entry>PECL mongodb 1.2.0</entry>
        <entry>
         Implementa <interfacename>Serializable</interfacename> y
         <interfacename>JsonSerializable</interfacename>.
        </entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section>

 </partintro>

 &reference.mongodb.bson.entities.binary;

</reference>

<!-- 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
-->