Merge pull request #105 from symfony-cmf/code-cleanup

visbility cleanup

Author: dbu

UPGRADE-2.0.md

@@ -38,3 +38,11 @@
 
  * The `subjectObject` and `translatedSubjectObject` with their related methods
    are renamed to `subject` and `translatedSubject`.
+
+## Customization
+
+A lot of previously protected fields and some methods where moved to private, 
+as they are not meant to represent part of the contract. If you have a valid 
+use case to extend one of the classes, please explain in a github issue and
+we will see whether that property should be made protected or whether ther is a
+cleaner sulution.

src/AutoRouteManager.php

@@ -23,17 +23,17 @@ class AutoRouteManager
     /**
      * @var AdapterInterface
      */
-    protected $adapter;
+    private $adapter;
 
     /**
      * @var UriGeneratorInterface
      */
-    protected $uriGenerator;
+    private $uriGenerator;
 
     /**
      * @var DefunctRouteHandlerInterface
      */
-    protected $defunctRouteHandler;
+    private $defunctRouteHandler;
 
     /**
      * @var UriContextCollection[]
@@ -43,7 +43,7 @@ class AutoRouteManager
     /**
      * @var UriContextCollectionBuilder
      */
-    protected $collectionBuilder;
+    private $collectionBuilder;
 
     public function __construct(
         AdapterInterface $adapter,

src/ConflictResolver/AutoIncrementConflictResolver.php

@@ -24,8 +24,17 @@
  */
 class AutoIncrementConflictResolver implements ConflictResolverInterface
 {
-    protected $adapter;
-    protected $index;
+    /**
+     * @var AdapterInterface
+     */
+    private $adapter;
+
+    /**
+     * To count the increment, increased until conflic is resolved.
+     *
+     * @var int
+     */
+    private $index;
 
     /**
      * Construct the conflict resolver using the given adapter.
@@ -56,13 +65,13 @@ public function resolveConflict(UriContext $uriContext)
      * Tell if the given URI for the given context is conflicting with another
      * route.
      */
-    protected function isUriConflicting($uri, UriContext $uriContext)
+    private function isUriConflicting($uri, UriContext $uriContext)
     {
         return null !== $uriContext->getCollection()->getAutoRouteByUri($uri)
             || null !== $this->adapter->findRouteForUri($uri, $uriContext);
     }
 
-    protected function incrementUri($uri)
+    private function incrementUri($uri)
     {
         return sprintf('%s-%s', $uri, ++$this->index);
     }

src/DefunctRouteHandler/DelegatingDefunctRouteHandler.php

@@ -25,14 +25,23 @@
  */
 class DelegatingDefunctRouteHandler implements DefunctRouteHandlerInterface
 {
-    protected $serviceRegistry;
-    protected $adapter;
+    /**
+     * Used to find the old route action.
+     *
+     * @var ServiceRegistry
+     */
+    private $serviceRegistry;
+
+    /**
+     * @var AdapterInterface
+     */
+    private $adapter;
 
     /**
-     * @param ServiceRegistry auto routing service registry (for getting old route action)
-     * @param AdapterInterface auto routing backend adapter
-     * @param MetadataFactory  auto routing metadata factory
+     * @var MetadataFactory
      */
+    private $metadataFactory;
+
     public function __construct(
         MetadataFactory $metadataFactory,
         AdapterInterface $adapter,

src/DefunctRouteHandler/LeaveRedirectDefunctRouteHandler.php

@@ -20,7 +20,7 @@ class LeaveRedirectDefunctRouteHandler implements DefunctRouteHandlerInterface
     /**
      * @var AdapterInterface
      */
-    protected $adapter;
+    private $adapter;
 
     public function __construct(AdapterInterface $adapter)
     {

src/DefunctRouteHandler/RemoveDefunctRouteHandler.php

@@ -20,7 +20,7 @@ class RemoveDefunctRouteHandler implements DefunctRouteHandlerInterface
     /**
      * @var AdapterInterface
      */
-    protected $adapter;
+    private $adapter;
 
     /**
      * @param AdapterInterface

src/Mapping/ClassMetadata.php

@@ -24,12 +24,12 @@ class ClassMetadata extends MergeableClassMetadata
     /**
      * @var array
      */
-    protected $tokenProviders = [];
+    private $tokenProviders = [];
 
     /**
      * @var array
      */
-    protected $conflictResolver = ['name' => 'throw_exception', 'options' => []];
+    private $conflictResolver = ['name' => 'throw_exception', 'options' => []];
 
     /**
      * Defunct route handler, default to remove.

src/ServiceRegistry.php

@@ -13,9 +13,20 @@
 
 class ServiceRegistry
 {
-    protected $tokenProviders = [];
-    protected $conflictResolvers = [];
-    protected $defunctRouteHandlers = [];
+    /**
+     * @var TokenProviderInterface[]
+     */
+    private $tokenProviders = [];
+
+    /**
+     * @var ConflictResolverInterface[]
+     */
+    private $conflictResolvers = [];
+
+    /**
+     * @var DefunctRouteHandlerInterface[]
+     */
+    private $defunctRouteHandlers = [];
 
     /**
      * Return the named token provider.
@@ -60,7 +71,7 @@ public function getConflictResolver($name)
      *
      * @throws \InvalidArgumentException if the named token provider does not exist
      *
-     * @return ConflictResolverInterface
+     * @return DefunctRouteHandlerInterface
      */
     public function getDefunctRouteHandler($name)
     {

src/UriContext.php

@@ -26,16 +26,54 @@
  */
 class UriContext
 {
-    protected $collection;
-    protected $translatedSubject;
-    protected $locale;
-    protected $uri;
-    protected $autoRoute;
-    protected $uriSchema;
-    protected $tokenProviderConfigs;
-    protected $conflictResolverConfig;
-    protected $subjectMetadata;
-    protected $defaults;
+    /**
+     * @var UriContextCollection
+     */
+    private $collection;
+
+    /**
+     * @var string
+     */
+    private $uriSchema;
+
+    /**
+     * @var array
+     */
+    private $defaults;
+
+    /**
+     * @var array
+     */
+    private $tokenProviderConfigs;
+
+    /**
+     * @var array
+     */
+    private $conflictResolverConfig;
+
+    /**
+     * The locale of the translatedSubject.
+     *
+     * If null, the subject is not translated.
+     *
+     * @var string
+     */
+    private $locale;
+
+    /**
+     * @var object
+     */
+    private $translatedSubject;
+
+    /**
+     * @var string
+     */
+    private $uri;
+
+    /**
+     * @var AutoRouteInterface
+     */
+    private $autoRoute;
 
     /**
      * Construct the context.

src/UriContextCollection.php

@@ -18,12 +18,12 @@
  */
 class UriContextCollection
 {
-    protected $subject;
+    private $subject;
 
     /**
      * @var UriContext[]
      */
-    protected $uriContexts = [];
+    private $uriContexts = [];
 
     /**
      * Construct the collection for the given subject.