Merge branch 'feature/config-provider' into develop

Close #53

Author: weierophinney

CHANGELOG.md

@@ -6,11 +6,30 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#53](https://github.com/zendframework/zend-form/pull/53) adds
+  `Zend\Form\FormElementManagerFactory`, for creating and returning instances of
+  `Zend\Form\FormElementManager`. This factory was ported from zend-mvc, and
+  will replace it for version 3 of that component.
+- [#53](https://github.com/zendframework/zend-form/pull/53) adds
+  `Zend\Form\Annotation\AnnotationBuilderFactory`, for creating and returning
+  instances of `Zend\Form\Annotation\AnnotationBuilder`. This factory was ported
+  from zend-mvc, and will replace it for version 3 of that component.
+- [#53](https://github.com/zendframework/zend-form/pull/53) exposes the package
+  as a config-provider and ZF component, by adding:
+  - `ConfigProvider`, which maps the `FormElementsManager` and
+    `FormAnnotationBuilder` servies previously provided by zend-mvc; the form
+    abstract factory as previously registered by zend-mvc; and all view helper
+    configuration.
+  - `Module`, which maps services and view helpers per the `ConfigProvider`, and
+    provides configuration to the zend-modulemanager `ServiceLocator` in order
+    for modules to provide form and form element configuration.
 
 ### Deprecated
 
-- Nothing.
+- [#53](https://github.com/zendframework/zend-form/pull/53) deprecates
+  `Zend\Form\View\HelperConfig`; the functionality is made obsolete by
+  `ConfigProvider`. It now consumes the latter in order to provide view helper
+  configuration.
 
 ### Removed
 

composer.json

@@ -52,6 +52,10 @@
         "branch-alias": {
             "dev-master": "2.7-dev",
             "dev-develop": "2.8-dev"
+        },
+        "zf": {
+            "component": "Zend\\Form",
+            "config-provider": "Zend\\Form\\ConfigProvider"
         }
     },
     "autoload-dev": {

src/Annotation/AnnotationBuilderFactory.php

@@ -0,0 +1,139 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-form for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Form\Annotation;
+
+use Interop\Container\ContainerInterface;
+use Zend\EventManager\EventManagerInterface;
+use Zend\EventManager\ListenerAggregateInterface;
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class AnnotationBuilderFactory implements FactoryInterface
+{
+    /**
+     * @param  ContainerInterface $container
+     * @param  string $name
+     * @param  null|array $options
+     * @return AnnotationBuilder
+     * @throws ServiceNotCreatedException for invalid listener configuration.
+     */
+    public function __invoke(ContainerInterface $container, $name, array $options = null)
+    {
+        //setup a form factory which can use custom form elements
+        $annotationBuilder = new AnnotationBuilder();
+        $eventManager      = $container->get('EventManager');
+        $annotationBuilder->setEventManager($eventManager);
+
+        $formElementManager = $container->get('FormElementManager');
+        $formElementManager->injectFactory($container, $annotationBuilder);
+
+        $config = $this->marshalConfig($container);
+        if (isset($config['preserve_defined_order'])) {
+            $annotationBuilder->setPreserveDefinedOrder($config['preserve_defined_order']);
+        }
+
+        $this->injectAnnotations($config, $annotationBuilder);
+        $this->injectListeners($config, $eventManager, $container);
+
+        return $annotationBuilder;
+    }
+
+    /**
+     * Create and return AnnotationBuilder instance
+     *
+     * For use with zend-servicemanager v2; proxies to __invoke().
+     *
+     * @param ServiceLocatorInterface $container
+     * @return AnnotationBuilder
+     */
+    public function createService(ServiceLocatorInterface $container)
+    {
+        return $this($container, AnnotationBuilder::class);
+    }
+
+    /**
+     * Marshal annotation builder configuration, if any.
+     *
+     * Looks for the `config` service in the container, returning an empty array
+     * if not found.
+     *
+     * If found, checks for a `form_annotation_builder` entry, returning an empty
+     * array if not found or not an array.
+     *
+     * Otherwise, returns the `form_annotation_builder` array.
+     *
+     * @param ContainerInterface $container
+     * @return array
+     */
+    private function marshalConfig(ContainerInterface $container)
+    {
+        if (! $container->has('config')) {
+            return [];
+        }
+
+        $config = $container->get('config');
+        $config = isset($config['form_annotation_builder'])
+            ? $config['form_annotation_builder']
+            : [];
+
+        return is_array($config) ? $config : [];
+    }
+
+    /**
+     * Inject annotations from configuration, if any.
+     *
+     * @param array $config
+     * @param AnnotationBuilder $builder
+     * @return void
+     */
+    private function injectAnnotations(array $config, AnnotationBuilder $builder)
+    {
+        if (! isset($config['annotations'])) {
+            return;
+        }
+
+        $parser = $builder->getAnnotationParser();
+        foreach ($config['annotations'] as $fullyQualifiedClassName) {
+            $parser->registerAnnotation($fullyQualifiedClassName);
+        }
+    }
+
+    /**
+     * Inject event listeners from configuration, if any.
+     *
+     * Loops through the 'listeners' array, and:
+     *
+     * - attempts to fetch it from the container
+     * - if the fetched instance is not a `ListenerAggregate`, raises an exception
+     * - otherwise attaches it to the event manager
+     *
+     * @param array $config
+     * @param EventManagerInterface $events
+     * @param ContainerInterface $container
+     * @return void
+     * @throws ServiceNotCreatedException if any listener is not an event listener
+     *     aggregate.
+     */
+    private function injectListeners(array $config, EventManagerInterface $events, ContainerInterface $container)
+    {
+        if (! isset($config['listeners'])) {
+            return;
+        }
+
+        foreach ($config['listeners'] as $listenerName) {
+            $listener = $container->get($listenerName);
+
+            if (! $listener instanceof ListenerAggregateInterface) {
+                throw new ServiceNotCreatedException(sprintf('Invalid event listener (%s) provided', $listenerName));
+            }
+
+            $listener->attach($events);
+        }
+    }
+}