php-doc-en/reference/yaml/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<appendix xml:id="yaml.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants;
 <para>
 </para>

 <variablelist xml:id="yaml.constants.style">
  <title>Scalar entity styles usable by <function>yaml_parse</function>
   callback methods.</title>
  <varlistentry xml:id="constant.yaml-any-scalar-style">
   <term>
    <constant>YAML_ANY_SCALAR_STYLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-plain-scalar-style">
   <term>
    <constant>YAML_PLAIN_SCALAR_STYLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-single-quoted-scalar-style">
   <term>
    <constant>YAML_SINGLE_QUOTED_SCALAR_STYLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-double-quoted-scalar-style">
   <term>
    <constant>YAML_DOUBLE_QUOTED_SCALAR_STYLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-literal-scalar-style">
   <term>
    <constant>YAML_LITERAL_SCALAR_STYLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-folded-scalar-style">
   <term>
    <constant>YAML_FOLDED_SCALAR_STYLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist xml:id="yaml.constants.tag">
  <title>Common tags usable by <function>yaml_parse</function>
   callback methods.</title>
  <varlistentry xml:id="constant.yaml-null-tag">
   <term>
    <constant>YAML_NULL_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:null"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-bool-tag">
   <term>
    <constant>YAML_BOOL_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:bool"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-str-tag">
   <term>
    <constant>YAML_STR_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:str"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-int-tag">
   <term>
    <constant>YAML_INT_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:int"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-float-tag">
   <term>
    <constant>YAML_FLOAT_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:float"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-timestamp-tag">
   <term>
    <constant>YAML_TIMESTAMP_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:timestamp"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-seq-tag">
   <term>
    <constant>YAML_SEQ_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:seq"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-map-tag">
   <term>
    <constant>YAML_MAP_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "tag:yaml.org,2002:map"
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-php-tag">
   <term>
    <constant>YAML_PHP_TAG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     "!php/object"
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist xml:id="yaml.constants.encoding">
  <title>Encoding types for <function>yaml_emit</function></title>
  <varlistentry xml:id="constant.yaml-any-encoding">
   <term>
    <constant>YAML_ANY_ENCODING</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Let the emitter choose an encoding.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-utf8-encoding">
   <term>
    <constant>YAML_UTF8_ENCODING</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Encode as UTF8.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-utf16le-encoding">
   <term>
    <constant>YAML_UTF16LE_ENCODING</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Encode as UTF16LE.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-utf16be-encoding">
   <term>
    <constant>YAML_UTF16BE_ENCODING</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Encode as UTF16BE.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

 <variablelist xml:id="yaml.constants.break">
  <title>Linebreak types for <function>yaml_emit</function></title>
  <varlistentry xml:id="constant.yaml-any-break">
   <term>
    <constant>YAML_ANY_BREAK</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Let emitter choose linebreak character.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-cr-break">
   <term>
    <constant>YAML_CR_BREAK</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Use <literal>\r</literal> as break character (Mac style).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-ln-break">
   <term>
    <constant>YAML_LN_BREAK</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Use <literal>\n</literal> as break character (Unix style).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.yaml-crln-break">
   <term>
    <constant>YAML_CRLN_BREAK</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Use <literal>\r\n</literal> as break character (DOS style).
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>

</appendix>

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