Skip to content

Commit

Permalink
Updating the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
zyxist committed Jul 23, 2011
1 parent 5825814 commit 374e7cf
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
@@ -1,4 +1,4 @@
Open Power Autoloader 3.0.2.0
Open Power Autoloader 3.0.3.0
=============================

This is a collection of universal class loaders for PHP 5.3+ compatible with
Expand All @@ -9,14 +9,15 @@ naming rules.
Version information
-------------------

This is a development version of Open Power Autoloader 3.0.2.0
This is a development version of Open Power Autoloader 3.0.3.0

Requirements
------------

+ PHP 5.3+
+ [Open Power Cache](http://www.github.com/OPL/opl3-cache) (Optional)
+ [Symfony 2 Console Component](http://www.symfony-reloaded.org) (Optional)
+ PHP 5.3 or 5.4
+ [Symfony 2 Console Component](http://www.symfony-reloaded.org) (Optional, recommended)
+ [Advanced PHP Cache](http://pecl.php.net/package/APC) (Optional)
+ [chdb](http://pecl.php.net/package/chdb) (Optional)

Contents
--------
Expand All @@ -25,20 +26,29 @@ The package provides the following class loaders:

* `\Opl\Autoloader\GenericLoader` - generic class loader with dynamic class-to-file
translation.
* `\Opl\Autoloader\UniversalLoader` - a slower variant of `GenericLoader` that allows
to register subnamespaces, too.
* `\Opl\Autoloader\ClassMapLoader` - class loader which uses a predefined map of
classes and their paths. Provides greater performance at the cost of flexibility.
* `\Opl\Autoloader\PHARLoader` - class loader with predefined maps of classes for
self-contained PHAR archives with web and console applications.
* `\Opl\Autoloader\ApcLoader` - a modification of `ClassMapLoader` which allows to
cache the class maps in the [APC](http://pecl.php.net/package/APC) shared memory.
* `\Opl\Autoloader\ChdbLoader` - a modification of `ClassMapLoader` which uses Unix
shared memory files and [chdb](http://pecl.php.net/package/chdb) caching extension
to store the class maps.

Extra classes:

* `\Opl\Autoloader\ClassMapBuilder` - class map builder for the map-based autoloaders.
* `\Opl\Autoloader\CoreTracker` - an autoloader decorator that allows to find the common application
core loaded every time.
* `\Opl\Autoloader\Command\ClassMapBuild` - Symfony 2 Console command that builds
the class maps for the map-based autoloaders.
* `\Opl\Autoloader\Command\CoreDump` - Symfony 2 Console command that generates the
application core loading code from the `CoreTracker` dump.

Extra tools:

* *Class map builder* - produces the class maps for the given namespaces in the serialized
array or chdb shared memory file formats.
* *CoreDump* - exports the core dump generated by the `CoreTracker`, concatenating it
into a single PHP file or a list of *require* statements.

Documentation can be found [here](http://static.invenzzia.org/docs/opl/3_0/book/en/autoloader.html).

Expand Down

0 comments on commit 374e7cf

Please sign in to comment.