php-doc-en/reference/filesystem/ini.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="filesystem.configuration" xmlns="http://docbook.org/ns/docbook">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  <table>
   <title>Filesystem and Streams Configuration Options</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.allow-url-fopen">allow_url_fopen</link></entry>
      <entry>"1"</entry>
      <entry>PHP_INI_SYSTEM</entry>
      <entry>PHP_INI_ALL in PHP &lt;= 4.3.4. Available since PHP 4.0.4.</entry>
      <!-- FIXME PHP_6 	 
      <entry>PHP_INI_ALL</entry> 	 
      <entry>PHP_INI_ALL in PHP &lt;= 4.3.4. PHP_INI_SYSTEM in PHP &lt; 6. Available since PHP 4.0.4.</entry> 	 
      -->
     </row>
     <row>
      <entry><link linkend="ini.allow-url-include">allow_url_include</link></entry>
      <entry>"0"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>PHP_INI_SYSTEM in PHP 5. Available since PHP 5.2.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.user-agent">user_agent</link></entry>
      <entry>NULL</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.3.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.default-socket-timeout">default_socket_timeout</link></entry>
      <entry>"60"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.3.0.</entry>
    </row>
     <row>
      <entry><link linkend="ini.from">from</link></entry>
      <entry>""</entry>
      <entry>PHP_INI_ALL</entry>
      <entry></entry>
     </row>
     <row>
      <entry><link linkend="ini.auto-detect-line-endings">auto_detect_line_endings</link></entry>
      <entry>"0"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.3.0.</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
 </para>
 
 &ini.descriptions.title;
 
 <para>
  <variablelist>
   <varlistentry xml:id="ini.allow-url-fopen">
    <term>
     <parameter>allow_url_fopen</parameter>
     <type>boolean</type>
    </term>
    <listitem>
     <para>
      This option enables the URL-aware fopen wrappers that enable 
      accessing URL object like files. Default wrappers are provided for 
      the access of <link linkend="features.remote-files">remote files</link>
      using the ftp or http protocol, some extensions like
      <link linkend="ref.zlib">zlib</link> may register additional
      wrappers. 
     </para>
     <note>
      <para>
       This option was introduced immediately after the release of version 
       4.0.3. For versions up to and including 4.0.3 you can only disable this 
       feature at compile time by using the configuration switch 
       <link linkend="configure.disable-url-fopen-wrapper"><parameter>
       --disable-url-fopen-wrapper</parameter></link>.
      </para>
     </note>
     <warning>
      <para> 
       On Windows versions prior to PHP 4.3.0, the following functions do not
       support remote file accessing: <link linkend="function.include"><literal>include</literal></link>,
       <link linkend="function.include-once"><literal>include_once</literal></link>, <link linkend="function.require"><literal>require</literal></link>,
       <link linkend="function.require-once"><literal>require_once</literal></link> and the imagecreatefromXXX
       functions in the <xref linkend="ref.image"/> extension.
      </para>
     </warning>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.allow-url-include">
    <term>
     <parameter>allow_url_include</parameter>
     <type>boolean</type>
    </term>
    <listitem>
     <para>
      This option allows the use of URL-aware fopen wrappers with the following 
      functions: <link linkend="function.include"><literal>include</literal></link>, <link linkend="function.include-once"><literal>include_once</literal></link>, 
      <link linkend="function.require"><literal>require</literal></link>, <link linkend="function.require-once"><literal>require_once</literal></link>.
     </para>
     <note>
      <para>
       This setting requires allow_url_fopen to be on. 
      </para>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.user-agent">
    <term>
     <parameter>user_agent</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Define the user agent for PHP to send.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.default-socket-timeout">
    <term>
     <parameter>default_socket_timeout</parameter>
     <type>integer</type>
    </term>
    <listitem>
     <para>
      Default timeout (in seconds) for socket based streams.
     </para>
     <note>
      <simpara>
       This configuration option was introduced in PHP 4.3.0
      </simpara>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.from">
    <term>
     <parameter>from</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      The email address to be used on unauthenticated FTP connections and
      as the value of From header for HTTP connections, when using the ftp
      and http wrappers, respectively.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.auto-detect-line-endings">
    <term>
     <parameter>auto_detect_line_endings</parameter>
     <type>boolean</type>
    </term>
    <listitem>
     <para>
      When turned on, PHP will examine the data read by
      <function>fgets</function> and <function>file</function> to see if it
      is using Unix, MS-Dos or Macintosh line-ending conventions.
     </para>
     <para>This enables PHP to interoperate with Macintosh systems,
      but defaults to Off, as there is a very small performance penalty
      when detecting the EOL conventions for the first line, and also
      because people using carriage-returns as item separators under
      Unix systems would experience non-backwards-compatible behaviour.
     </para>
     <note>
      <simpara>
       This configuration option was introduced in PHP 4.3.0
      </simpara>
     </note>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
</section>

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