archived-doc-en/reference/yaml/ini.xml

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

<section xml:id="yaml.configuration" xmlns="http://docbook.org/ns/docbook">
  &reftitle.runtime;
  &extension.runtime;
  <para>
    <table>
      <title>Yaml &ConfigureOptions;</title>
      <tgroup cols="4">
        <thead>
          <row>
            <entry>&Name;</entry>
            <entry>&Default;</entry>
            <entry>&Changeable;</entry>
            <entry>&Changelog;</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry><link linkend="ini.yaml.decode-binary">yaml.decode_binary</link></entry>
            <entry>0</entry>
            <entry><constant>INI_ALL</constant></entry>
            <entry><!-- leave empty, this will be filled by an automatic script --></entry>
          </row>
          <row>
            <entry><link linkend="ini.yaml.decode-php">yaml.decode_php</link></entry>
            <entry>0</entry>
            <entry><constant>INI_ALL</constant></entry>
            <entry>Added in 1.2.0, before 2.0.0 the default was 1</entry>
          </row>
          <row>
            <entry><link linkend="ini.yaml.decode-timestamp">yaml.decode_timestamp</link></entry>
            <entry>0</entry>
            <entry><constant>INI_ALL</constant></entry>
            <entry><!-- leave empty, this will be filled by an automatic script --></entry>
          </row>
          <row>
            <entry><link linkend="ini.yaml.output-canonical">yaml.output_canonical</link></entry>
            <entry>0</entry>
            <entry><constant>INI_ALL</constant></entry>
            <entry><!-- leave empty, this will be filled by an automatic script --></entry>
          </row>
          <row>
            <entry><link linkend="ini.yaml.output-indent">yaml.output_indent</link></entry>
            <entry>2</entry>
            <entry><constant>INI_ALL</constant></entry>
            <entry><!-- leave empty, this will be filled by an automatic script --></entry>
          </row>
          <row>
            <entry><link linkend="ini.yaml.output-width">yaml.output_width</link></entry>
            <entry>80</entry>
            <entry><constant>INI_ALL</constant></entry>
            <entry><!-- leave empty, this will be filled by an automatic script --></entry>
          </row>
        </tbody>
      </tgroup>
    </table>
  </para>

  &ini.descriptions.title;

  <para>
    <variablelist>
      <varlistentry xml:id="ini.yaml.decode-binary">
        <term>
          <parameter>yaml.decode_binary</parameter>
          <type>bool</type>
        </term>
        <listitem>
          <para>
            Off by default, but can be set to on to cause base64 binary encoded entities which have the explicit tag "tag:yaml.org,2002:binary" to be decoded.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry xml:id="ini.yaml.decode-php">
        <term>
          <parameter>yaml.decode_php</parameter>
          <type>bool</type>
        </term>
        <listitem>
          <para>
            Off by default, but can be set to on to cause serialized php objects which have the explicit tag "!php/object" to be unserialized.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry xml:id="ini.yaml.decode-timestamp">
        <term>
          <parameter>yaml.decode_timestamp</parameter>
          <type>int</type>
        </term>
        <listitem>
          <para>
            Controls the decoding of both implicit and explicit "tag:yaml.org,2002:timestamp" scalars in the YAML document stream. The default setting of <literal>0</literal> will not apply any decoding. A setting of <literal>1</literal> will use <function>strtotime</function> to parse the timestamp value as a Unix timestamp. A setting of <literal>2</literal> will use <function>date_create</function> to parse the timestamp value as <type>DateTime</type> object.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry xml:id="ini.yaml.output-canonical">
        <term>
          <parameter>yaml.output_canonical</parameter>
          <type>bool</type>
        </term>
        <listitem>
          <para>
            Off by default, but can be set to on to cause canonical form output.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry xml:id="ini.yaml.output-indent">
        <term>
          <parameter>yaml.output_indent</parameter>
          <type>int</type>
        </term>
        <listitem>
          <para>
            Number of spaces to indent sections. Value should be between
            <literal>1</literal> and <literal>10</literal>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry xml:id="ini.yaml.output-width">
        <term>
          <parameter>yaml.output_width</parameter>
          <type>int</type>
        </term>
        <listitem>
          <para>
            Set the preferred line width. <literal>-1</literal> means unlimited.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </para>
</section>