File: set-include-path.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (88 lines) | stat: -rw-r--r-- 2,420 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
  <refentry id="function.set-include-path">
   <refnamediv>
    <refname>set_include_path</refname>
    <refpurpose>
     Sets the include_path configuration option
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>set_include_path</methodname>
      <methodparam><type>string</type><parameter>new_include_path</parameter></methodparam>      
     </methodsynopsis>
    <simpara>
     Sets the <link linkend="ini.include-path">include_path</link> 
     configuration option for the duration of the script.  Returns the old 
     <link linkend="ini.include-path">include_path</link> on success or 
     &false; on failure.
    </simpara>
    <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('/inc');

// Works in all PHP versions
ini_set('include_path', '/inc');
?>
]]>
      </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>
    <simpara>
     See also <function>ini_set</function>,
     <function>get_include_path</function>,
     <function>restore_include_path</function>, and
     <function>include</function>.
    </simpara>
   </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:"../../../../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
-->