PVLibraries is designed to load external libraries into the system, especially those that are not in a management service like Composer.
While tools like composer make including and accessing libraries easy, not every library is on the service nor does every project want to manage their 3rd parties libraries in the same way. PVLibraries primary focus is the loading of external libraries to be used in your application.
Example:
//Initialize the class
PVLibraries::init();
//Add an external library
PVLibraries::addLibrary('MailLoader', array('path' => '/absolute/path/to/library/1', 'explicit_load' => true));
//Add a library with name spaces
PVLibraries::addLibrary('Facebook', array('path' => '/absolute/path/to/library/2', 'namespaced' => true));
//To your application to load these libraries for use
PVLibraries::loadLibraries();
package |
system |
---|
__callStatic(string $method, mixed $args = array()) : mixed
access |
public |
---|
string
The key/name assigned to the method when added
mixed
Arguements to pass to the annoymous function. The function is called using call_user_func_array.
mixed
$value The value returned is the value the stored function returns
_applyFilter(string $class, string $method, mixed $data, array $options = array()) : mixed
access |
protected |
---|
string
The name of the class the filter is in
string
The method the filter is in
mixed
The data that is being passed to the filter
array
options to be passed to the filter. Passed options we be passed to the function. -'default_return' mixed: If no filter is return, the data passed in by default will be return. Can be overriden -'event' string: An event to associate with the filter. Default is null
mixed
$data The data the function returns
_autoload( $classname) : void
access |
protected |
---|---|
todo |
Fix for dealing with namespaces |
The name of the class to autoload
_buildAutoLoads() : void
access |
public |
---|---|
todo |
Find a faster method for autloading |
_callAdapter(string $class, string $method) : mixed
access |
protected |
---|
string
The name of the class the adapter is in
string
THe name of the method the class is being called from.
mixed
$value A value that the adapter returns
_hasAdapter( $class, string $method) : \boolea
access |
protected |
---|
string
The associated method
\boolea
$hasAdapter Returns true if it has an adapter or false if it doesn not
_hasFilter(string $class, string $method)
string
The class the filter is in
string
The method of the class that the filter is in
_invokeMethod(string $class, string $method, array $args) : mixed
access |
protected |
---|
string
The name of the class to be called
string
The name of the method in the class to be called
array
An array of arguements. Arguements have to be embedded in an array to be called.
mixed
$data Data returned by the function called
_invokeStaticMethod(string $class, string $method, array $args) : mixed
access |
protected |
---|
string
The name of the class to be called
string
The name of the method in the class to be called
array
An array of arguements. Arguements have to be embedded in an array to be called.
mixed
$data Data returned by the function called
_loadLibrary(array $library, array $allow_extensions) : void
access |
protected |
---|
array
An array of the library that contains directores, files, and file information
array
The allowed extensions
_logAdapter(array $data) : void
access |
private |
---|
array
The data in the adapter
_logFilter(array $data) : void
access |
private |
---|
array
The data in the filter
_logObserver(array $data) : void
access |
private |
---|
array
The data in the observer
_notify(string $event) : void
access |
protected |
---|
string
The name of the even that occured that will trigger notifies
_prepareLogData(array $data) : string
access |
private |
---|
array
string
$message JSON encode message of information about the data
addAdapter(string $trigger_class, string $trigger_method, string $call_class, array $options = array()) : void
access |
public |
---|---|
todo |
add ability to adapt singleton class |
string
The class that contains the function the adapter will respond too
string
The method called that will have the adapter to be called.
string
The new class to be called that has the same method name
array
An array of options that be called -'object' string : Assumes that default method in the class to be called is static. If called object needs to be instantiated, change to object to 'instance' and one will be created before the adapter calls the function -'call_method' string: By default the method to be called to override the current one should be the same name. But this can be ovveridden to call a different method. -'type' string: The type of method being called. Default is class_method but if the method is a closure, set the type to be 'closure' and make the $trigger_method the closure
addClassAdapter(mixed $trigger_class, string $call_class, array $options = array()) : void
access |
public |
---|---|
todo |
Add ability to use singleton classes |
mixed
This can either be the name of the class or an object whose methods will be adapted to another class. The class should be included or be autoloaded by this point.
string
The call class is the classes methods that will be called in place of the methods in the trigger_class. These class does not have to be included as this point.
array
Options that be used to further distinguish the behavior of the adapters added -'object' string: Determines if the object being adapted to is static or an instance.Default is static -'call_class' string: The name of the class that the methods will be adapted too. -'class' string: The name of the whose methods will be adapted to another class
addFilter(string $class, string $method, string $filter_class, string $filter_method, array $options = array()) : void
access |
public |
---|
string
The name of the class the filter is going in
string
The name of the method the filter is in
string
The class that the filter resides in.
string
The method in the class that the parameters will be passed too.
array
Options that can be set for further modifying the filter. -'object' string: If the method being called is static, static should be inserted. If its in an instance, 'instance' should be set. Default is set to static. -'event' string: Associate this filter with an event. -'type' string: The type of function being called. Default is class_method but if the function is a closure, set the type to be 'closure' and make the $filter_method the closure
addLibrary( $folder_name, array $options = array()) : void
access |
public |
---|
array
Options than can be used to configure the library that will be loaded -'path' string: The path to the library. The default path is PV_LIBRARIES.$folder_name.DS -'auto_load' boolean: When true, library will become part of the spl_autoload. Default is true. Other the library will not be auto_loaded -'explicit_load' boolean: Default is false. If set to false -'extensions' array: An array of allowed file extensions that will be included when the library loads. Default is .php
addMethod(string $method, \function $closure) : void
access |
public |
---|
string
The key/value that will be used to call the function
\function
The anonymous function/closure to be added
addObserver(string $event, string $class, string $method, array $options = array()) : void
access |
public |
---|
string
The name of the event that will cause a certain class and method to fire
string
The name of the class that contains the function that will be fired for this event
string
The name of the method that will be fired when the event occurs
array
Options to further the define the firing of an event -'object' string : If the method being called is static, should be set to static. Else set to instance -'class' stinrg : The name of the class to be called. Default is the class that is passed in. -'method' string: The name of the method to be called. Default is the method that is passed in. -'type' string: The type of function being called. Default is class_method but if the function is a closure, set the type to be 'closure' and make the $method the closure
addToCollection(mixed $data) : void
access |
public |
---|
mixed
Any data type( Object, Array, int, etc) to add to the public data collection
addToCollectionWithName(string $name, mixed $data) : void
access |
public |
---|---|
todo |
check the relevance of get and set |
string
The key/index to assign the value to
mixed
Data to be stored in the collection
clearFilters(string $class, string $method) : void
access |
public |
---|
string
The class the filter is in
string
The method of the class that the filter is in
clearObservers(string $event) : void
access |
public |
---|
string
The event to remove all the observers from
enqueueCss(string $script) : void
access |
public |
---|
string
The name of script to be added. The name of script acts as key for accessing the script and the location of the script.
enqueueJavascript(string $script) : void
access |
public |
---|
string
The name of script to be added. The name of script acts as key for accessing the script and the location of the script.
enqueueJquery(string $script) : void
access |
public |
---|
string
The name of script to be added. The name of script acts as key for accessing the script and the location of the script.
enqueueMootools(string $script) : void
access |
public |
---|
string
The name of script to be added. The name of script acts as key for accessing the script and the location of the script.
enqueueOpenscript(string $script) : void
access |
public |
---|
string
The string to be added to a queue. The string does not have a key and cannot be removed once added.
enqueuePrototype(string $script) : void
access |
public |
---|
string
The name of script to be added. The name of script acts as key for accessing the script and the location of the script.
get(string $index) : mixed
access |
public |
---|
string
The index to retrieve a value from
mixed
$data The data that was stored at that index
getCssQueue() : array
access |
public |
---|---|
array
$script Returns an array of scripts. The key => value are the same and should present the location of the script
getInstance() : object
access |
public |
---|---|
object
$instance Returns the instance of a class.
getIterator() : \PVIterator
getJavascriptQueue() : array
access |
public |
---|---|
array
$script Returns an array of scripts. The key => value are the same and should present the location of the script
getJqueryQueue() : array
access |
public |
---|---|
array
$script Returns an array of scripts. The key => value are the same and should present the location of the script
getMootoolsQueue() : array
access |
public |
---|---|
array
$script Returns an array of scripts. The key => value are the same and should present the location of the script
getOpenscriptQueue() : string
access |
public |
---|---|
string
$script The scripts added will be returned in one unified string
getPrototypeQueue() : array
access |
public |
---|---|
array
$script Returns an array of scripts. The key => value are the same and should present the location of the script
init(array $config = array()) : void
access |
public |
---|
array
A configuration that can be used for setting how the class works -'namespaced' boolean: Default is false. If set to true, classes will be treated and react as if they are namespaced
loadLibraries() : void
access |
public |
---|---|
loadLibrary(string $library_name) : void
access |
public |
---|
string
The name of the library to be load. Will be the same name passed when addLibrary was used.
removeAdapter( $class, string $method) : void
access |
public |
---|
string
The associated method
removeClassAdapter( $class) : void
access |
public |
---|
set(string $index, mixed $value) : void
access |
public |
---|
string
The key or index to store the value at
mixed
A mixed value that can be anytype
setAdapterTrace(boolean $trace = false) : void
access |
public |
---|
boolean
Default is false. If set to true, will trace adatper.
setFilterTrace(boolean $trace = false) : void
access |
public |
---|
boolean
Default is false. If set to true, will trace filter.
setObserverTrace(boolean $trace = false) : void
access |
public |
---|
boolean
Default is false. If set to true, will trace observer.
javascript_libraries_array :
jquery_libraries_array :
deprecated |
To remove |
---|---|
prototype_libraries_array :
deprecated |
To remove |
---|---|
motools_libraries_array :
deprecated |
To remove |
---|---|
css_files_array :
open_javascript :
libraries :
_autoloadClasses :
_namespaced :
_collection :
_methods :
_adapters :
_observers :
_instances :
_filters :
_traceAdapters :
_traceFilters :
_traceObservers :