[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/libraries/ -> loader.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 308 lines (8 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  discover()
  getClassList()
  import()
  load()
  register()
  setup()
  _autoload()
  jexit()
  jimport()

Functions
Functions that are not part of a class:

discover($classPrefix, $parentPath, $force = true, $recurse = false)   X-Ref
Method to discover classes of a given type in a given path.

param: string   $classPrefix  The class name prefix to use for discovery.
param: string   $parentPath   Full path to the parent folder for the classes to discover.
param: boolean  $force        True to overwrite the autoload path value for the class if it already exists.
param: boolean  $recurse      Recurse through all child directories as well as the parent path.
return: void

getClassList()   X-Ref
Method to get the list of registered classes and their respective file paths for the autoloader.

return: array  The array of class => path values for the autoloader.

import($key, $base = null)   X-Ref
Loads a class from specified directories.

param: string  $key   The class name to look for (dot notation).
param: string  $base  Search this directory for the class.
return: boolean  True on success.

load($class)   X-Ref
Load the file for a class.

param: string  $class  The class to be loaded.
return: boolean  True on success

register($class, $path, $force = true)   X-Ref
Directly register a class to the autoload list.

param: string   $class  The class name to register.
param: string   $path   Full path to the file that holds the class to register.
param: boolean  $force  True to overwrite the autoload path value for the class if it already exists.
return: void

setup()   X-Ref
Method to setup the autoloaders for the Joomla Platform.  Since the SPL autoloaders are
called in a queue we will add our explicit, class-registration based loader first, then
fall back on the autoloader based on conventions.  This will allow people to register a
class in a specific location and override platform libraries as was previously possible.

return: void

_autoload($class)   X-Ref
Autoload a Joomla Platform class based on name.

param: string  $class  The class to be loaded.
return: void

jexit($message = 0)   X-Ref
Global application exit.

This function provides a single exit point for the platform.

param: mixed  $message  Exit code or string. Defaults to zero.
return: void

jimport($path)   X-Ref
Intelligent file importer.

param: string  $path  A dot syntax path.
return: boolean  True on success.



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1