Improve various parts of documentation

Author: codedmonkey

DependencyInjection/Compiler/MetadataResourceResolverPass.php

@@ -17,7 +17,7 @@
 /**
  * Scans the services tree for resource loaders and adds them to the resource resolver.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class MetadataResourceResolverPass implements CompilerPassInterface
 {

DependencyInjection/Configuration.php

@@ -17,7 +17,7 @@
 /**
  * This class validates and merges configuration for the bundle.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class Configuration implements ConfigurationInterface
 {

DependencyInjection/HarmonyModularExtension.php

@@ -18,7 +18,7 @@
 /**
  * Loads and manages the bundle configuration.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class HarmonyModularExtension extends Extension
 {
@@ -29,7 +29,7 @@ public function load(array $configs, ContainerBuilder $container)
     {
         $config = $this->processConfiguration(new Configuration(), $configs);
 
-        // disable the bundle if no module class is specified
+        // Disable the bundle if no module class is specified
         if (!$config['module_class']) {
             return;
         }
@@ -83,6 +83,7 @@ private function setupRoutePrefix(array $config, ContainerBuilder $container)
     private function setupServices(array $config, ContainerBuilder $container)
     {
         // Define a different default module manager when using the default StaticModule class
+        // If you choose to extend the StaticModule class, make sure to change this manually
         $static = 'Harmony\Component\ModularRouting\Model\StaticModule' == $config['module_class'];
         $defaultManagerService = !$static ? 'harmony_modular.module_manager.doctrine' : 'harmony_modular.module_manager.static';
 

Doctrine/ModularSubscriber.php

@@ -17,7 +17,7 @@
 /**
  * Handle events regarding modular entities.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class ModularSubscriber extends BaseSubscriber implements EventSubscriber
 {
@@ -35,7 +35,10 @@ public function __construct(ContainerInterface $container, $moduleClass)
         $this->container   = $container;
         $this->moduleClass = $moduleClass;
     }
-    
+
+    /**
+     * {@inheritdoc}
+     */
     public function getModuleManager()
     {
         return $this->container->get('harmony_modular.module_manager');

EventListener/RoutingSubscriber.php

@@ -10,7 +10,7 @@
 /**
  * Handle events regarding routing.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class RoutingSubscriber extends BaseSubscriber implements EventSubscriberInterface
 {
@@ -27,11 +27,17 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getModuleManager()
     {
         return $this->container->get('harmony_modular.module_manager');
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getModularRouter()
     {
         return $this->container->get('harmony_modular.router');

HarmonyModularBundle.php

@@ -15,7 +15,7 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 /**
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class HarmonyModularBundle extends Bundle
 {

Request/ModularParamConverter.php

@@ -11,6 +11,7 @@
 namespace Harmony\Bundle\ModularBundle\Request;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\ORM\NoResultException;
 use Harmony\Component\ModularRouting\Manager\ModuleManagerInterface;
 use Harmony\Component\ModularRouting\Model\ModularRepositoryInterface;
@@ -20,9 +21,9 @@
 use Symfony\Component\HttpFoundation\Request;
 
 /**
- * Match the any modular (entity) argument of the controller
+ * Match any modular (entity) argument of the controller.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class ModularParamConverter extends DoctrineParamConverter implements ParamConverterInterface
 {
@@ -31,6 +32,10 @@ class ModularParamConverter extends DoctrineParamConverter implements ParamConve
      */
     protected $manager;
 
+    /**
+     * @param ManagerRegistry|null   $registry
+     * @param ModuleManagerInterface $manager
+     */
     public function __construct(ManagerRegistry $registry = null, ModuleManagerInterface $manager)
     {
         $this->manager = $manager;
@@ -126,6 +131,12 @@ public function supports(ParamConverterConfiguration $configuration)
         return $metadata->hasAssociation('module');
     }
 
+    /**
+     * @param string|null $name
+     * @param string      $class
+     *
+     * @return ObjectManager|null
+     */
     private function getManager($name, $class)
     {
         if (null === $name) {

Request/ModuleParamConverter.php

@@ -17,9 +17,9 @@
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 
 /**
- * Match the module argument of the controller
+ * Match the module argument of the controller.
  *
- * @author Tim Goudriaan <tim@codedmonkey.com>
+ * @author Tim Goudriaan <tim@harmony-project.io>
  */
 class ModuleParamConverter implements ParamConverterInterface
 {
@@ -28,6 +28,9 @@ class ModuleParamConverter implements ParamConverterInterface
      */
     protected $manager;
 
+    /**
+     * @param ModuleManagerInterface $manager
+     */
     public function __construct(ModuleManagerInterface $manager)
     {
         $this->manager = $manager;

LICENSE renamed to license

@@ -1,7 +1,7 @@
 ModularBundle
 =============
 
-The ModularBundle provides an integrated implementation of the Harmony Modular Routing component for the Symfony framework. This bundle relies on the Symfony CMF RoutingBundle to create a chain of routers to avoid replacing the default Router.
+ModularBundle provides an integrated implementation of the Harmony ModularRouting component for the Symfony framework. This bundle relies on Symfony CMF RoutingBundle to create a chain of routers to avoid replacing the default Router.
 
 Installation
 ------------