• Home
• lithium
• core
• Libraries

PHP Class lithium\core\Libraries

Typically, libraries and plugins are registered in app/config/bootstrap/libraries.php. By convention, vendor libraries are typically located in app/libraries or /libraries, and plugins are located in app/libraries/plugins or /libraries/plugins. By default, Libraries will use its own autoloader for all plugins and vendor libraries, but can be configured to use others on a case-by-case basis. Libraries also handles service location. Various 'types' of classes can be defined by name, using _class patterns_, which define conventions for organizing classes, i.e. 'models' is '{:library}\models\{:name}', which will find a model class in any registered app, plugin or vendor library that follows that path (namespace) convention. You can find classes by name (see locate() for more information on class-locating precedence), or find all models in all registered libraries (apps / plugins / vendor libraries, etc). For more information on modifying the default class organization, or defining your own class types, see the paths() method. Show file Open project: unionofrad/lithium Class Usage Examples

Protected Properties

Property	Type	Description
$_cachedPaths	array	Holds cached class paths generated and used by lithium\core\Libraries::load().
$_configurations	array	The list of class libraries registered with the class loader.
$_default	string	Stores the name of the default library. When adding a library configuration to the application, if the 'default' option flag is set to true, the name of the library will be assigned. To retrieve the default library's configuration, use Libraries::get(true).
$_map	array	Holds associations between fully-namespaced class names and file's paths mapped with lithium\core\Libraries::map().
$_methodFilters	array	Stores the closures that represent the method filters. They are indexed by method name.
$_paths	array	Used by Libraries::locate() to perform service location. This allows new types of objects (i.e. models, helpers, cache adapters and data sources) to be automatically 'discovered' when you register a new vendor library or plugin (using Libraries::add()). Because paths are checked in the order in which they appear, path templates should be specified from most-specific to least-specific. See the locate() method for usage examples.

Public Methods

Method	Description
add ( string $name, array $config = [] ) : array	Adds a class library from which files can be loaded.
applyFilter ( string $method, Closure $filter = null ) : void	Apply a closure to a method in Libraries.
cache ( array $cache = null ) : array	Returns or sets the the class path cache used for mapping class names to file paths, or locating classes using Libraries::locate().
find ( mixed $library, array $options = [] ) : array	Finds the classes or namespaces belonging to a particular library. _Note_: This method assumes loaded class libraries use a consistent class-to-file naming convention.
get ( mixed $name = null, string $key = null ) : mixed	Allows library information to be retrieved in various ways, including:
instance ( string $type, string $name, array $options = [] ) : object	Uses service location (i.e. Libraries::locate()) to look up a named class of a particular type, and creates an instance of it, and passes an array of parameters to the constructor.
load ( string $class, boolean $require = false ) : void	Loads the class definition specified by $class. Looks through the list of libraries defined in $_configurations, which are added through lithium\core\Libraries::add().
locate ( string $type, string $name = null, array $options = [] ) : mixed	Performs service location for an object of a specific type. If $name is a string, finds the first instance of a class with the given name in any registered library (i.e. apps, plugins or vendor libraries registered via Libraries::add()), based on each library's order of precedence. For example, this will find the first model called File in any plugin or class library loaded into an application, including the application itself.
map ( array $classes ) : void	Associtates fully-namespaced class names to their corresponding paths on the file system.
path ( string $class, array $options = [] ) : string	Get the corresponding physical file path for a class or namespace name.
paths ( mixed $path = null ) : mixed	Accessor method for the class path templates which Libraries uses to look up and load classes. Using this method, you can define your own types of classes, or modify the default organization of built-in class types.
realPath ( string $path ) : string	Wraps the PHP realpath() function to add support for finding paths to files inside Phar archives.
remove ( mixed $name )	Removes a registered library, and unregister's the library's autoloader, if it has one.
unmap ( mixed $classes )	Unmap fully-namespaced class names mapped using lithium\core\Libraries::map().

Protected Methods

Method	Description
_configure ( array $config ) : void	Configures the application environment based on a library's settings, including appending to the include path, loading a bootstrap file, and registering a loader with SPL's autoloading system.
_filter ( array $libs, array $config, array $options = [] ) : array	Filters a list of library search results by the given set of options.
_locateAll ( array $params, array $options = [] ) : array	Locates all possible classes for given set of parameters.
_locateDeferred ( boolean | null $defer, array $paths, array $params, array $options = [] ) : string	Performs service location lookups by library, based on the library's 'defer' flag.
_locatePath ( string $type, array $params ) : string | null	Helper function for returning known paths given a certain type.
_params ( string $type, string $name = "*" ) : array	Get params from type.
_search ( string $config, array $options, string $name = null ) : array	Search file system.
_searchPaths ( array $paths, string $library ) : array	Returns the list of valid search path templates for the given service location lookup.
_transformPath ( mixed $transform, string $class, array $options = [] ) : string	Handles the conversion of a class name to a file name using a custom transformation typically defined in the 'transform' key of a configuration defined through Libraries::add().

Method Details

Property Details