← Back to branch summary

~clinton-collins/familyproject/trunk

« back to all changes in this revision

Viewing changes to ZendFramework/library/Zend/Loader/Autoloader.php

  • Committer: Clinton Collins
  • Date: 2009-06-26 19:54:58 UTC
  • Revision ID: clinton.collins@gmail.com-20090626195458-5ebba0qcvo15xlpy
Initial Import

Show diffs side-by-side

added added

removed removed

Lines of Context:
ZendFramework/library/Zend/Loader/Autoloader.php
 
1
<?php
 
2
/**
 
3
 * Zend Framework
 
4
 *
 
5
 * LICENSE
 
6
 *
 
7
 * This source file is subject to the new BSD license that is bundled
 
8
 * with this package in the file LICENSE.txt.
 
9
 * It is also available through the world-wide-web at this URL:
 
10
 * http://framework.zend.com/license/new-bsd
 
11
 * If you did not receive a copy of the license and are unable to
 
12
 * obtain it through the world-wide-web, please send an email
 
13
 * to license@zend.com so we can send you a copy immediately.
 
14
 *
 
15
 * @category   Zend
 
16
 * @package    Zend_Loader
 
17
 * @subpackage Autoloader
 
18
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 
19
 * @version    $Id: Autoloader.php 15508 2009-05-11 03:29:01Z matthew $
 
20
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 
21
 */
 
22
 
 
23
/** Zend_Loader */
 
24
require_once 'Zend/Loader.php';
 
25
 
 
26
/**
 
27
 * Autoloader stack and namespace autoloader
 
28
 * 
 
29
 * @uses       Zend_Loader_Autoloader
 
30
 * @package    Zend_Loader
 
31
 * @subpackage Autoloader
 
32
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 
33
 * @license    New BSD {@link http://framework.zend.com/license/new-bsd}
 
34
 */
 
35
class Zend_Loader_Autoloader
 
36
{
 
37
    /**
 
38
     * @var Zend_Loader_Autoloader Singleton instance
 
39
     */
 
40
    protected static $_instance;
 
41
 
 
42
    /**
 
43
     * @var array Concrete autoloader callback implementations
 
44
     */
 
45
    protected $_autoloaders = array();
 
46
 
 
47
    /**
 
48
     * @var array Default autoloader callback
 
49
     */
 
50
    protected $_defaultAutoloader = array('Zend_Loader', 'loadClass');
 
51
 
 
52
    /**
 
53
     * @var bool Whether or not to act as a fallback autoloader
 
54
     */
 
55
    protected $_fallbackAutoloader = false;
 
56
 
 
57
    /**
 
58
     * @var array Callback for internal autoloader implementation
 
59
     */
 
60
    protected $_internalAutoloader;
 
61
 
 
62
    /**
 
63
     * @var array Supported namespaces 'Zend' and 'ZendX' by default.
 
64
     */
 
65
    protected $_namespaces = array(
 
66
        'Zend_'  => true,
 
67
        'ZendX_' => true,
 
68
    );
 
69
 
 
70
    /**
 
71
     * @var array Namespace-specific autoloaders
 
72
     */
 
73
    protected $_namespaceAutoloaders = array();
 
74
 
 
75
    /**
 
76
     * @var bool Whether or not to suppress file not found warnings
 
77
     */
 
78
    protected $_suppressNotFoundWarnings = false;
 
79
 
 
80
    /**
 
81
     * Retrieve singleton instance
 
82
     * 
 
83
     * @return Zend_Loader_Autoloader
 
84
     */
 
85
    public static function getInstance()
 
86
    {
 
87
        if (null === self::$_instance) {
 
88
            self::$_instance = new self();
 
89
        }
 
90
        return self::$_instance;
 
91
    }
 
92
 
 
93
    /**
 
94
     * Reset the singleton instance
 
95
     * 
 
96
     * @return void
 
97
     */
 
98
    public static function resetInstance()
 
99
    {
 
100
        self::$_instance = null;
 
101
    }
 
102
 
 
103
    /**
 
104
     * Autoload a class
 
105
     * 
 
106
     * @param  string $class 
 
107
     * @return bool
 
108
     */
 
109
    public static function autoload($class)
 
110
    {
 
111
        $self = self::getInstance();
 
112
 
 
113
        foreach ($self->getClassAutoloaders($class) as $autoloader) {
 
114
            if ($autoloader instanceof Zend_Loader_Autoloader_Interface) {
 
115
                if ($autoloader->autoload($class)) {
 
116
                    return true;
 
117
                }
 
118
            } elseif (is_string($autoloader)) {
 
119
                if ($autoloader($class)) {
 
120
                    return true;
 
121
                }
 
122
            } elseif (is_array($autoloader)) {
 
123
                $object = array_shift($autoloader);
 
124
                $method = array_shift($autoloader);
 
125
                if (call_user_func(array($object, $method), $class)) {
 
126
                    return true;
 
127
                }
 
128
            }
 
129
        }
 
130
 
 
131
        return false;
 
132
    }
 
133
 
 
134
    /**
 
135
     * Set the default autoloader implementation
 
136
     * 
 
137
     * @param  string|array $callback PHP callback
 
138
     * @return void
 
139
     */
 
140
    public function setDefaultAutoloader($callback)
 
141
    {
 
142
        if (!is_callable($callback)) {
 
143
            throw new Zend_Loader_Exception('Invalid callback specified for default autoloader');
 
144
        }
 
145
 
 
146
        $this->_defaultAutoloader = $callback;
 
147
        return $this;
 
148
    }
 
149
 
 
150
    /**
 
151
     * Retrieve the default autoloader callback
 
152
     * 
 
153
     * @return string|array PHP Callback
 
154
     */
 
155
    public function getDefaultAutoloader()
 
156
    {
 
157
        return $this->_defaultAutoloader;
 
158
    }
 
159
 
 
160
    /**
 
161
     * Set several autoloader callbacks at once
 
162
     * 
 
163
     * @param  array $autoloaders Array of PHP callbacks (or Zend_Loader_Autoloader_Interface implementations) to act as autoloaders
 
164
     * @return Zend_Loader_Autoloader
 
165
     */
 
166
    public function setAutoloaders(array $autoloaders)
 
167
    {
 
168
        $this->_autoloaders = $autoloaders;
 
169
        return $this;
 
170
    }
 
171
 
 
172
    /**
 
173
     * Get attached autoloader implementations
 
174
     * 
 
175
     * @return array
 
176
     */
 
177
    public function getAutoloaders()
 
178
    {
 
179
        return $this->_autoloaders;
 
180
    }
 
181
 
 
182
    /**
 
183
     * Return all autoloaders for a given namespace
 
184
     * 
 
185
     * @param  string $namespace
 
186
     * @return array
 
187
     */
 
188
    public function getNamespaceAutoloaders($namespace)
 
189
    {
 
190
        $namespace = (string) $namespace;
 
191
        if (!array_key_exists($namespace, $this->_namespaceAutoloaders)) {
 
192
            return array();
 
193
        }
 
194
        return $this->_namespaceAutoloaders[$namespace];
 
195
    }
 
196
 
 
197
    /**
 
198
     * Register a namespace to autoload
 
199
     * 
 
200
     * @param  string $namespace 
 
201
     * @return Zend_Loader_Autoloader
 
202
     */
 
203
    public function registerNamespace($namespace)
 
204
    {
 
205
        if (is_string($namespace)) {
 
206
            $namespace = (array) $namespace;
 
207
        } elseif (!is_array($namespace)) {
 
208
            throw new Zend_Loader_Exception('Invalid namespace provided');
 
209
        }
 
210
 
 
211
        foreach ($namespace as $ns) {
 
212
            if (!isset($this->_namespaces[$ns])) {
 
213
                $this->_namespaces[$ns] = true;
 
214
            }
 
215
        }
 
216
        return $this;
 
217
    }
 
218
 
 
219
    /**
 
220
     * Unload a registered autoload namespace
 
221
     * 
 
222
     * @param  string $namespace 
 
223
     * @return Zend_Loader_Autoloader
 
224
     */
 
225
    public function unregisterNamespace($namespace)
 
226
    {
 
227
        if (is_string($namespace)) {
 
228
            $namespace = (array) $namespace;
 
229
        } elseif (!is_array($namespace)) {
 
230
            throw new Zend_Loader_Exception('Invalid namespace provided');
 
231
        }
 
232
 
 
233
        foreach ($namespace as $ns) {
 
234
            if (isset($this->_namespaces[$ns])) {
 
235
                unset($this->_namespaces[$ns]);
 
236
            }
 
237
        }
 
238
        return $this;
 
239
    }
 
240
 
 
241
    /**
 
242
     * Get a list of registered autoload namespaces
 
243
     * 
 
244
     * @return array
 
245
     */
 
246
    public function getRegisteredNamespaces()
 
247
    {
 
248
        return array_keys($this->_namespaces);
 
249
    }
 
250
 
 
251
    /**
 
252
     * Get or set the value of the "suppress not found warnings" flag
 
253
     * 
 
254
     * @param  null|bool $flag 
 
255
     * @return bool|Zend_Loader_Autoloader Returns boolean if no argument is passed, object instance otherwise
 
256
     */
 
257
    public function suppressNotFoundWarnings($flag = null)
 
258
    {
 
259
        if (null === $flag) {
 
260
            return $this->_suppressNotFoundWarnings;
 
261
        }
 
262
        $this->_suppressNotFoundWarnings = (bool) $flag;
 
263
        return $this;
 
264
    }
 
265
 
 
266
    /**
 
267
     * Indicate whether or not this autoloader should be a fallback autoloader
 
268
     * 
 
269
     * @param  bool $flag 
 
270
     * @return Zend_Loader_Autoloader
 
271
     */
 
272
    public function setFallbackAutoloader($flag)
 
273
    {
 
274
        $this->_fallbackAutoloader = (bool) $flag;
 
275
        return $this;
 
276
    }
 
277
 
 
278
    /**
 
279
     * Is this instance acting as a fallback autoloader?
 
280
     * 
 
281
     * @return bool
 
282
     */
 
283
    public function isFallbackAutoloader()
 
284
    {
 
285
        return $this->_fallbackAutoloader;
 
286
    }
 
287
 
 
288
    /**
 
289
     * Get autoloaders to use when matching class
 
290
     *
 
291
     * Determines if the class matches a registered namespace, and, if so, 
 
292
     * returns only the autoloaders for that namespace. Otherwise, it returns 
 
293
     * all non-namespaced autoloaders.
 
294
     *
 
295
     * @param  string $class 
 
296
     * @return array Array of autoloaders to use
 
297
     */
 
298
    public function getClassAutoloaders($class)
 
299
    {
 
300
        $namespace   = false;
 
301
        $autoloaders = array();
 
302
 
 
303
        // Add concrete namespaced autoloaders
 
304
        foreach (array_keys($this->_namespaceAutoloaders) as $ns) {
 
305
            if ('' == $ns) {
 
306
                continue;
 
307
            }
 
308
            if (0 === strpos($class, $ns)) {
 
309
                $namespace   = $ns;
 
310
                $autoloaders = $autoloaders + $this->getNamespaceAutoloaders($ns);
 
311
                break;
 
312
            }
 
313
        }
 
314
 
 
315
        // Add internal namespaced autoloader
 
316
        foreach ($this->getRegisteredNamespaces() as $ns) {
 
317
            if (0 === strpos($class, $ns)) {
 
318
                $namespace     = $ns;
 
319
                $autoloaders[] = $this->_internalAutoloader;
 
320
                break;
 
321
            }
 
322
        }
 
323
 
 
324
        // Add non-namespaced autoloaders
 
325
        $autoloaders = $autoloaders + $this->getNamespaceAutoloaders('');
 
326
 
 
327
        // Add fallback autoloader
 
328
        if (!$namespace && $this->isFallbackAutoloader()) {
 
329
            $autoloaders[] = $this->_internalAutoloader;
 
330
        }
 
331
 
 
332
        return $autoloaders;
 
333
    }
 
334
 
 
335
    /**
 
336
     * Add an autoloader to the beginning of the stack
 
337
     * 
 
338
     * @param  object|array|string $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
 
339
     * @param  string|array $namespace Specific namespace(s) under which to register callback
 
340
     * @return Zend_Loader_Autoloader
 
341
     */
 
342
    public function unshiftAutoloader($callback, $namespace = '')
 
343
    {
 
344
        $autoloaders = $this->getAutoloaders();
 
345
        array_unshift($autoloaders, $callback);
 
346
        $this->setAutoloaders($autoloaders);
 
347
 
 
348
        $namespace = (array) $namespace;
 
349
        foreach ($namespace as $ns) {
 
350
            $autoloaders = $this->getNamespaceAutoloaders($ns);
 
351
            array_unshift($autoloaders, $callback);
 
352
            $this->_setNamespaceAutoloaders($autoloaders, $ns);
 
353
        }
 
354
 
 
355
        return $this;
 
356
    }
 
357
 
 
358
    /**
 
359
     * Append an autoloader to the autoloader stack
 
360
     * 
 
361
     * @param  object|array|string $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
 
362
     * @param  string|array $namespace Specific namespace(s) under which to register callback
 
363
     * @return Zend_Loader_Autoloader
 
364
     */
 
365
    public function pushAutoloader($callback, $namespace = '')
 
366
    {
 
367
        $autoloaders = $this->getAutoloaders();
 
368
        array_push($autoloaders, $callback);
 
369
        $this->setAutoloaders($autoloaders);
 
370
 
 
371
        $namespace = (array) $namespace;
 
372
        foreach ($namespace as $ns) {
 
373
            $autoloaders = $this->getNamespaceAutoloaders($ns);
 
374
            array_push($autoloaders, $callback);
 
375
            $this->_setNamespaceAutoloaders($autoloaders, $ns);
 
376
        }
 
377
 
 
378
        return $this;
 
379
    }
 
380
 
 
381
    /**
 
382
     * Remove an autoloader from the autoloader stack
 
383
     * 
 
384
     * @param  object|array|string $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
 
385
     * @param  null|string|array $namespace Specific namespace(s) from which to remove autoloader
 
386
     * @return Zend_Loader_Autoloader
 
387
     */
 
388
    public function removeAutoloader($callback, $namespace = null)
 
389
    {
 
390
        if (null === $namespace) {
 
391
            $autoloaders = $this->getAutoloaders();
 
392
            if (false !== ($index = array_search($callback, $autoloaders, true))) {
 
393
                unset($autoloaders[$index]);
 
394
                $this->setAutoloaders($autoloaders);
 
395
            }
 
396
 
 
397
            foreach ($this->_namespaceAutoloaders as $ns => $autoloaders) {
 
398
                if (false !== ($index = array_search($callback, $autoloaders, true))) {
 
399
                    unset($autoloaders[$index]);
 
400
                    $this->_setNamespaceAutoloaders($autoloaders, $ns);
 
401
                }
 
402
            }
 
403
        } else {
 
404
            $namespace = (array) $namespace;
 
405
            foreach ($namespace as $ns) {
 
406
                $autoloaders = $this->getNamespaceAutoloaders($ns);
 
407
                if (false !== ($index = array_search($callback, $autoloaders, true))) {
 
408
                    unset($autoloaders[$index]);
 
409
                    $this->_setNamespaceAutoloaders($autoloaders, $ns);
 
410
                }
 
411
            }
 
412
        }
 
413
 
 
414
        return $this;
 
415
    }
 
416
 
 
417
    /**
 
418
     * Constructor
 
419
     *
 
420
     * Registers instance with spl_autoload stack
 
421
     * 
 
422
     * @return void
 
423
     */
 
424
    protected function __construct()
 
425
    {
 
426
        spl_autoload_register(array(__CLASS__, 'autoload'));
 
427
        $this->_internalAutoloader = array($this, '_autoload');
 
428
    }
 
429
 
 
430
    /**
 
431
     * Internal autoloader implementation
 
432
     * 
 
433
     * @param  string $class 
 
434
     * @return bool
 
435
     */
 
436
    protected function _autoload($class)
 
437
    {
 
438
        $callback = $this->getDefaultAutoloader();
 
439
        try {
 
440
            if ($this->suppressNotFoundWarnings()) {
 
441
                @call_user_func($callback, $class);
 
442
            } else {
 
443
                call_user_func($callback, $class);
 
444
            }
 
445
            return $class;
 
446
        } catch (Zend_Exception $e) {
 
447
            return false;
 
448
        }
 
449
    }
 
450
 
 
451
    /**
 
452
     * Set autoloaders for a specific namespace
 
453
     * 
 
454
     * @param  array $autoloaders 
 
455
     * @param  string $namespace 
 
456
     * @return Zend_Loader_Autoloader
 
457
     */
 
458
    protected function _setNamespaceAutoloaders(array $autoloaders, $namespace = '')
 
459
    {
 
460
        $namespace = (string) $namespace;
 
461
        $this->_namespaceAutoloaders[$namespace] = $autoloaders;
 
462
        return $this;
 
463
    }
 
464
}