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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 325783 $ -->
<refentry xml:id="function.spl-autoload-register" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>spl_autoload_register</refname>
<refpurpose>Register given function as __autoload() implementation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>spl_autoload_register</methodname>
<methodparam choice="opt"><type>callable</type><parameter>autoload_function</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>throw</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>prepend</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Register a function with the spl provided __autoload stack. If the stack
is not yet activated it will be activated.
</para>
<para>
If your code has an existing <function>__autoload</function> function then
this function must be explicitly registered on the __autoload stack. This
is because <function>spl_autoload_register</function> will effectively
replace the engine cache for the <function>__autoload</function> function
by either <function>spl_autoload</function> or
<function>spl_autoload_call</function>.
</para>
<para>
If there must be multiple autoload functions, <function>spl_autoload_register</function>
allows for this. It effectively creates a queue of autoload functions, and
runs through each of them in the order they are defined. By contrast,
<function>__autoload</function> may only be defined once.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>autoload_function</parameter></term>
<listitem>
<para>
The autoload function being registered.
If no parameter is provided, then the default implementation of
<function>spl_autoload</function> will be registered.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>throw</parameter></term>
<listitem>
<para>
This parameter specifies whether
<function>spl_autoload_register</function> should throw
exceptions when the <parameter>autoload_function</parameter>
cannot be registered.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prepend</parameter></term>
<listitem>
<para>
If true, <function>spl_autoload_register</function> will prepend
the autoloader on the autoload stack instead of appending it.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.3.0</entry>
<entry>
Namespaces support was introduced.
</entry>
</row>
<row>
<entry>5.3.0</entry>
<entry>
The <parameter>prepend</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>spl_autoload_register</function> as a replacement for an <function>__autoload</function> function</title>
<programlisting role="php">
<![CDATA[
<?php
// function __autoload($class) {
// include 'classes/' . $class . '.class.php';
// }
function my_autoloader($class) {
include 'classes/' . $class . '.class.php';
}
spl_autoload_register('my_autoloader');
// Or, using an anonymous function as of PHP 5.3.0
spl_autoload_register(function ($class) {
include 'classes/' . $class . '.class.php';
});
?>
]]>
</programlisting>
</example>
<example>
<title><function>spl_autoload_register</function> example where the class is not loaded</title>
<programlisting role="php">
<![CDATA[
<?php
namespace Foobar;
class Foo {
static public function test($name) {
print '[['. $name .']]';
}
}
spl_autoload_register(__NAMESPACE__ .'\Foo::test'); // As of PHP 5.3.0
new InexistentClass;
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
[[Foobar\InexistentClass]]
Fatal error: Class 'Foobar\InexistentClass' not found in ...
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>__autoload</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
-->
|
