MxcGenerics
Version 0.1.0 created by Frank Hein and the mxc-commons team., (*1)
MxcGenerics is part of the maxence Open Source Initiative by maxence business consulting gmbh, Germany., (*2)
Introduction
MxcGenerics provides generic classes and assets we use in development. Other modules from maxence rely on
MxcGenerics., (*3)
Features / Goals
Main design goal of MxcGenerics is to encapsulate often used generic functionality., (*4)
Requirements
Installation
Main Setup
By cloning project
- Clone this project into your
./vendor/ directory.
With composer
-
Add this project in your composer.json:, (*5)
"require": {
"mxc-commons/mxc-generics": "dev-master"
}
-
Now tell composer to download MxcGenerics by running the command:, (*6)
$ php composer.phar update
Post installation
-
Enabling it in your application.config.phpfile., (*7)
<?php
return array(
'modules' => array(
// ...
'MxcGenerics',
),
// ...
);
Package Contents
Class derived from Zend\Form\Form enabled to trigger events., (*8)
Class derived from EventProviderForm which issues EVENT_PRE_BIND, EVENT_PRE_PREPARE and EVENT_PRE_VALIDATE., (*9)
Directory: Session
SessionManagerFactory
Class which creates a Zend\Session\SessionManager. Configuration options can be supplied through the 'session'
config key., (*10)
Directory: Stdlib
GenericRegistry
GenericRegistry is a class comparable to Zend\Stdlib\AbstractOptions. It utilizes magic function to emulate
a setter and getter for each value. Internally data is stored in an associative array., (*11)
$registry = new GenericRegistry();
$registry->setKneel(72);
$registry->setPray(42);
echo $registry->getKneel();
echo $registry->getPray();
output: 72 42
GenericOptions
GenericOptions is a class derived from GenericRegistry. On construction it expects an array structured like, (*12)
$myOptions => array(
'options' => array(
'set1' => array(
'value1' => 10,
'value2' => 20,
...
),
'set2' => array(
'value1' => 32,
),
),
'defaults' => array(
'value1' => 1,
'value2' => 2,
),
);
On construction GenericOptions get initialized with the values from the default section. If an (optional)
option set is specified, these option set will be applied afterwards and extends/overrides the default options., (*13)
$options = new GenericOptions($myOptions);
echo $options->getValue1(); //-- output 1
echo $options->getValue2(); //-- output 2
$options = new GenericOptions($myOptions, 'set1');
echo $options->getValue1(); //-- output 10
echo $options->getValue2(); //-- output 20
$options = new GenericOptions($myOptions, 'set2');
echo $options->getValue1(); //-- output 32
echo $options->getValue2(); //-- output 2
StringHelper
Collection of helper functions for strings. Currently the class contains one first single static member.
formatVarExport is meant to make array var_export output look a little bit nicer., (*14)
Directory: Stdlib\Hydrator
ClassMethods
Hydrator derived from Zend\Stdlib\Hydrator\ClassMethods. Overrides the __construct() parameter's default value for behaviour compatibility reasons regarding other hydrators., (*15)
Directory: ServiceManager
GenericPluginManager
Class derived from Zend\ServiceManager\AbstractPluginManager. Associates Plugins with a set of GenericOptions., (*16)
'my_plugin_options' => array(
'plugin1' => array(
//-- see GenericOptions above
),
'plugin2' => array(
//-- see GenericOptions above
)
),
'my_plugins' => array(
'invobables' => array(
'plugin1' => 'My\Namespace\MyClass1',
'plugin2' => 'My\Namespace\MyClass2',
),
),
GenericPluginManagerFactory
Class derived from Zend\Mvc\Service\AbstractPluginManagerFactory. Applies setup options to the GenericPluginManager., (*17)
If you derive a plugin manager from GenericPluginManager and register it in the app's onInit you
would implement the factory for your class like this:, (*18)
class FirewallManagerFactory extends GenericPluginManagerFactory {
const PLUGIN_MANAGER_CLASS = 'MxcFirewall\FirewallManager\FirewallManager';
/**
* @see \Zend\ServiceManager\FactoryInterface::createService()
*/
public function createService(ServiceLocatorInterface $serviceLocator) {
$config = $serviceLocator->get('Configuration');
$this->setup = array(
'plugin_options' => 'firewall-options',
);
$plugins = parent::createService($serviceLocator);
return $plugins;
}
}
If you want to create a plugin manager without global registration, you would create a factory
like this (ListenerManager is the class derived from GenericPluginManager in this example):, (*19)
class ListenerManagerFactory implements FactoryInterface {
/*
* @see \Zend\ServiceManager\FactoryInterface::createService()
*/
public function createService(ServiceLocatorInterface $serviceLocator) {
$config = $serviceLocator->get('Configuration');
$config = isset($config['firewall-listeners']) ? $config['firewall-listeners'] : null;
$config = new Config($config);
$plugins = new ListenerManager($config);
$plugins->setup(array('plugin_options' => 'firewall-listener-options'));
return $plugins;
}
}
Directory: ServiceManager/Plugin
AbstractPlugin
Base class of all Plugins maintained by GenericPluginManager. Derived PluginManagers should overwrite GenericPluginManager::isValid() according to the particular service classes you derive from AbstractPlugin., (*20)
AbstractPlugin handles service option setup through the GenericPluginManager., (*21)
Additionally, AbstractPlugin a generic helper function translateVars to replace strings in option values. Derived classes should overwrite getVars() according to their needs., (*22)
public function getRootDirectory() {
return 'C:\';
}
public function getVars() {
return array(
'%rootDirectory% => $this->getRootDirectory(),
'%myOtherReplacement% => 'test',
);
}
$value1 = '%rootDirectory%' . 'temp';
$value2 = '%myOtherReplacement%' . 'ing';
$value3 = 'myOption';
echo $this->translateVars($value1); //-- output: 'C:\temp'
echo $this->translateVars($value2); //-- output: 'testing'
echo $this->translateVars($value3); //-- output: 'myOption';
AbstractGenerator
Example class demonstrating how to implement a plugin that allows overriding of it's options
for the runtime of a particular method by parameters provided., (*23)
abstract class AbstractGenerator extends AbstractPlugin {
protected $optionStack;
public function generate($params, $options = null) {
$this->getOptionStack()->push($this->options);
$this->options = $this->getActualOptions($params, $options);
$result = $this->doGenerate($this->options);
$reset = $this->options->getResetOptionsAfterRun();
$this->options = $this->optionStack->pop();
if ($reset) $this->resetOptions();
return $result;
}
public function doGenerate($options) {
//abstract
}
protected function getOptionStack() {
if (!$this->optionStack) {
$this->optionStack = new SplStack();
}
return $this->optionStack;
}
public function resetOptions() {
parent::resetOptions();
$this->optionStack = new SplStack();
}
}
We use an SplStack stack here to save the current options. Then, the parameters get merged with the options, thus overwriting/extending them. With the merged set of options we call doGenerate. Afterwards the original options get restored from the stack., (*24)
If the plugin options contain reset_options_after_run with value true, the plugin will be restored to its default setup and the option stack gets cleared., (*25)
Credits
We saw something like EventProviderForm in many modules., (*26)
License
MxcGenerics is released under the New BSD License. See license.txt., (*27)
Wallogit.com
