php-doc-en/reference/info/functions/set-include-path.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.set-include-path" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>set_include_path</refname>
  <refpurpose>Sets the include_path configuration option</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>set_include_path</methodname>
   <methodparam><type>string</type><parameter>new_include_path</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the <link linkend="ini.include-path">include_path</link>
   configuration option for the duration of the script.  
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>new_include_path</parameter></term>
     <listitem>
      <para>
       The new value for the <link
       linkend="ini.include-path">include_path</link>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the old <link linkend="ini.include-path">include_path</link> on
   success&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>set_include_path</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Works as of PHP 4.3.0
set_include_path('/usr/lib/pear');

// Works in all PHP versions
ini_set('include_path', '/usr/lib/pear');
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Adding to the include path</title>
    <para>
     Making use of the <constant>PATH_SEPARATOR</constant> constant, it is
     possible to extend the include path regardless of the operating system.
    </para>
    <para>
     In this example we add <filename>/usr/lib/pear</filename> to the end of
     the existing <literal>include_path</literal>.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$path = '/usr/lib/pear';
set_include_path(get_include_path() . PATH_SEPARATOR . $path);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ini_set</function></member>
    <member><function>get_include_path</function></member>
    <member><function>restore_include_path</function></member>
    <member><function>include</function></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
-->