[Encapsulation] Move everything from protected to private (except for…

… entry point)
egeloen · Nov 8, 2014 · cc0a387 · cc0a387
1 parent b6c6b1d
commit cc0a387
Show file tree

Hide file tree

Showing 21 changed files with 83 additions and 73 deletions.
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,7 @@
+inherit: true
+
+filter:
+    excluded_paths:
+        - bin/*
+        - vendor/*
+        - Tests/*
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -51,7 +51,7 @@ public function getConfigTreeBuilder()
      *
      * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The configs node.
      */
-    protected function createConfigsNode()
+    private function createConfigsNode()
     {
         return $this->createNode('configs')
             ->useAttributeAsKey('name')
@@ -66,7 +66,7 @@ protected function createConfigsNode()
      *
      * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The plugins node.
      */
-    protected function createPluginsNode()
+    private function createPluginsNode()
     {
         return $this->createNode('plugins')
             ->useAttributeAsKey('name')
@@ -83,7 +83,7 @@ protected function createPluginsNode()
      *
      * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The styles node.
      */
-    protected function createStylesNode()
+    private function createStylesNode()
     {
         return $this->createNode('styles')
             ->useAttributeAsKey('name')
@@ -114,7 +114,7 @@ protected function createStylesNode()
      *
      * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The templates node.
      */
-    protected function createTemplatesNode()
+    private function createTemplatesNode()
     {
         return $this->createNode('templates')
             ->useAttributeAsKey('name')
@@ -140,7 +140,7 @@ protected function createTemplatesNode()
      *
      * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The toolbars node.
      */
-    protected function createToolbarsNode()
+    private function createToolbarsNode()
     {
         return $this->createNode('toolbars')
             ->addDefaultsIfNotSet()
@@ -167,7 +167,7 @@ protected function createToolbarsNode()
      *
      * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition The node.
      */
-    protected function createNode($name)
+    private function createNode($name)
     {
         return $this->createTreeBuilder()->root($name);
     }
@@ -177,7 +177,7 @@ protected function createNode($name)
      *
      * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder.
      */
-    protected function createTreeBuilder()
+    private function createTreeBuilder()
     {
         return new TreeBuilder();
     }

diff --git a/DependencyInjection/IvoryCKEditorExtension.php b/DependencyInjection/IvoryCKEditorExtension.php
@@ -50,7 +50,7 @@ protected function loadInternal(array $config, ContainerBuilder $container)
      *
      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The container.
      */
-    protected function registerResources(ContainerBuilder $container)
+    private function registerResources(ContainerBuilder $container)
     {
         $templatingEngines = $container->getParameter('templating.engines');
 
@@ -81,7 +81,7 @@ protected function registerResources(ContainerBuilder $container)
      * @param array                                                   $config    The CKEditor configuration
      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The container.
      */
-    protected function registerConfig(array $config, ContainerBuilder $container)
+    private function registerConfig(array $config, ContainerBuilder $container)
     {
         $formType = $container->getDefinition('ivory_ck_editor.form.type');
 
@@ -114,7 +114,7 @@ protected function registerConfig(array $config, ContainerBuilder $container)
      *
      * @throws \Ivory\CKEditorBundle\Exception\DependencyInjectionException If the default config does not exist.
      */
-    protected function registerConfigs(array $config, ContainerBuilder $container)
+    private function registerConfigs(array $config, ContainerBuilder $container)
     {
         if (empty($config['configs'])) {
             return;
@@ -142,7 +142,7 @@ protected function registerConfigs(array $config, ContainerBuilder $container)
      * @param array                                                   $config    The CKEditor configuration.
      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The container.
      */
-    protected function registerPlugins(array $config, ContainerBuilder $container)
+    private function registerPlugins(array $config, ContainerBuilder $container)
     {
         if (empty($config['plugins'])) {
             return;
@@ -161,7 +161,7 @@ protected function registerPlugins(array $config, ContainerBuilder $container)
      * @param array                                                   $config    The CKEditor configuration.
      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The container.
      */
-    protected function registerStylesSet(array $config, ContainerBuilder $container)
+    private function registerStylesSet(array $config, ContainerBuilder $container)
     {
         if (empty($config['styles'])) {
             return;
@@ -180,7 +180,7 @@ protected function registerStylesSet(array $config, ContainerBuilder $container)
      * @param array                                                   $config    The CKEditor configuration.
      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The container.
      */
-    protected function registerTemplates(array $config, ContainerBuilder $container)
+    private function registerTemplates(array $config, ContainerBuilder $container)
     {
         if (empty($config['templates'])) {
             return;
@@ -202,7 +202,7 @@ protected function registerTemplates(array $config, ContainerBuilder $container)
      *
      * @return array The CKEditor configuration with merged toolbars.
      */
-    protected function mergeToolbars(array $config)
+    private function mergeToolbars(array $config)
     {
         $resolvedToolbars = $this->resolveToolbars($config);
         unset($config['toolbars']);
@@ -229,7 +229,7 @@ protected function mergeToolbars(array $config)
      *
      * @return array The resolved CKEditor toolbars.
      */
-    protected function resolveToolbars(array $config)
+    private function resolveToolbars(array $config)
     {
         $resolvedToolbars = array();
 
@@ -252,9 +252,9 @@ protected function resolveToolbars(array $config)
      *
      * @throws \Ivory\CKEditorBundle\Exception\DependencyInjectionException If the toolbar item does not exist.
      *
-     * @return array The resolved CKEditor toolbar item.
+     * @return array|string The resolved CKEditor toolbar item.
      */
-    protected function resolveToolbarItem($item, array $items)
+    private function resolveToolbarItem($item, array $items)
     {
         if (is_string($item) && ($item[0] === '@')) {
             $itemName = substr($item, 1);
@@ -276,7 +276,7 @@ protected function resolveToolbarItem($item, array $items)
      *
      * @return array The fixed CKEditor styles set.
      */
-    protected function fixStylesSet(array $stylesSet)
+    private function fixStylesSet(array $stylesSet)
     {
         foreach ($stylesSet as &$value) {
             $value = array_filter($value);
@@ -290,7 +290,7 @@ protected function fixStylesSet(array $stylesSet)
      *
      * @return array The default CKEditor toolbars.
      */
-    protected function getDefaultToolbars()
+    private function getDefaultToolbars()
     {
         return array(
             'full'     => $this->getFullToolbar(),
@@ -304,7 +304,7 @@ protected function getDefaultToolbars()
      *
      * @return array The full CKEditor toolbar.
      */
-    protected function getFullToolbar()
+    private function getFullToolbar()
     {
         return array(
             array('Source', '-', 'NewPage', 'Preview', 'Print', '-', 'Templates'),
@@ -334,7 +334,7 @@ protected function getFullToolbar()
      *
      * @return array The standard CKEditor toolbar.
      */
-    protected function getStandardToolbar()
+    private function getStandardToolbar()
     {
         return array(
             array('Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord', '-', 'Undo', 'Redo'),
@@ -355,7 +355,7 @@ protected function getStandardToolbar()
      *
      * @return array The basic CKEditor toolbar.
      */
-    protected function getBasicToolbar()
+    private function getBasicToolbar()
     {
         return array(
             array('Bold', 'Italic'),

diff --git a/Form/Type/CKEditorType.php b/Form/Type/CKEditorType.php
@@ -29,31 +29,31 @@
 class CKEditorType extends AbstractType
 {
     /** @var boolean */
-    protected $enable = true;
+    private $enable = true;
 
     /** @var boolean */
-    protected $autoload = true;
+    private $autoload = true;
 
     /** @var boolean */
-    protected $inputSync = false;
+    private $inputSync = false;
 
     /** @var string */
-    protected $basePath = 'bundles/ivoryckeditor/';
+    private $basePath = 'bundles/ivoryckeditor/';
 
     /** @var string */
-    protected $jsPath = 'bundles/ivoryckeditor/ckeditor.js';
+    private $jsPath = 'bundles/ivoryckeditor/ckeditor.js';
 
     /** @var \Ivory\CKEditorBundle\Model\ConfigManagerInterface */
-    protected $configManager;
+    private $configManager;
 
     /** @var \Ivory\CKEditorBundle\Model\PluginManagerInterface */
-    protected $pluginManager;
+    private $pluginManager;
 
     /** @var \Ivory\CKEditorBundle\Model\StylesSetManagerInterface */
-    protected $stylesSetManager;
+    private $stylesSetManager;
 
-    /** @var \Ivory\CKEditorBundle\Model\TemplateManager*/
-    protected $templateManager;
+    /** @var \Ivory\CKEditorBundle\Model\TemplateManagerInterface */
+    private $templateManager;
 
     /**
      * Creates a CKEditor type.

diff --git a/Model/ConfigManager.php b/Model/ConfigManager.php
@@ -21,10 +21,10 @@
 class ConfigManager implements ConfigManagerInterface
 {
     /** @var string */
-    protected $defaultConfig;
+    private $defaultConfig;
 
     /** @var array */
-    protected $configs = array();
+    private $configs = array();
 
     /**
      * Creates a CKEditor config manager.

diff --git a/Model/PluginManager.php b/Model/PluginManager.php
@@ -21,7 +21,7 @@
 class PluginManager implements PluginManagerInterface
 {
     /** @var array */
-    protected $plugins = array();
+    private $plugins = array();
 
     /**
      * Creates a plugin manager.

diff --git a/Model/StylesSetManager.php b/Model/StylesSetManager.php
@@ -21,7 +21,7 @@
 class StylesSetManager implements StylesSetManagerInterface
 {
     /** @var array */
-    protected $stylesSets = array();
+    private $stylesSets = array();
 
     /**
      * Creates a styles set manager.

diff --git a/Model/TemplateManager.php b/Model/TemplateManager.php
@@ -21,7 +21,7 @@
 class TemplateManager implements TemplateManagerInterface
 {
     /** @var array */
-    protected $templates = array();
+    private $templates = array();
 
     /**
      * Creates a plugin manager.

diff --git a/Templating/CKEditorHelper.php b/Templating/CKEditorHelper.php
@@ -23,10 +23,10 @@
 class CKEditorHelper extends Helper
 {
     /** @var \Ivory\JsonBuilder\JsonBuilder */
-    protected $jsonBuilder;
+    private $jsonBuilder;
 
     /** @var \Symfony\Component\DependencyInjection\ContainerInterface */
-    protected $container;
+    private $container;
 
     /**
      * Creates a CKEditor template helper.
@@ -206,7 +206,7 @@ protected function fixConfigLanguage(array $config)
      *
      * @return array The fixed config.
      */
-    protected function fixConfigContentsCss(array $config)
+    private function fixConfigContentsCss(array $config)
     {
         if (isset($config['contentsCss'])) {
             $cssContents = (array) $config['contentsCss'];
@@ -227,7 +227,7 @@ protected function fixConfigContentsCss(array $config)
      *
      * @return array The fixed config.
      */
-    protected function fixConfigFilebrowsers(array $config)
+    private function fixConfigFilebrowsers(array $config)
     {
         $filebrowserKeys = array(
             'Browse',
@@ -270,7 +270,7 @@ protected function fixConfigFilebrowsers(array $config)
      *
      * @param array $config The config.
      */
-    protected function fixConfigEscapedValues(array $config)
+    private function fixConfigEscapedValues(array $config)
     {
         if (isset($config['protectedSource'])) {
             foreach ($config['protectedSource'] as $key => $value) {
@@ -297,7 +297,7 @@ protected function fixConfigEscapedValues(array $config)
      *
      * @return string The fixed config.
      */
-    protected function fixConfigConstants($json)
+    private function fixConfigConstants($json)
     {
         return preg_replace('/"(CKEDITOR\.[A-Z_]+)"/', '$1', $json);
     }
@@ -309,7 +309,7 @@ protected function fixConfigConstants($json)
      *
      * @return string The fixed path.
      */
-    protected function fixPath($path)
+    private function fixPath($path)
     {
         if (($position = strpos($path, '?')) !== false) {
             return substr($path, 0, $position);
@@ -323,7 +323,7 @@ protected function fixPath($path)
      *
      * @return \Symfony\Component\Templating\Helper\CoreAssetsHelper The assets helper.
      */
-    protected function getAssetsHelper()
+    private function getAssetsHelper()
     {
         return $this->container->get('templating.helper.assets');
     }
@@ -333,7 +333,7 @@ protected function getAssetsHelper()
      *
      * @return \Symfony\Component\Routing\RouterInterface The router.
      */
-    protected function getRouter()
+    private function getRouter()
     {
         return $this->container->get('router');
     }

diff --git a/Tests/DependencyInjection/AbstractIvoryCKEditorExtensionTest.php b/Tests/DependencyInjection/AbstractIvoryCKEditorExtensionTest.php
@@ -23,13 +23,13 @@
 abstract class AbstractIvoryCKEditorExtensionTest extends \PHPUnit_Framework_TestCase
 {
     /** @var \Symfony\Component\DependencyInjection\ContainerBuilder */
-    protected $container;
+    private $container;
 
     /** @var \Symfony\Component\Templating\Helper\CoreAssetsHelper|\PHPUnit_Framework_MockObject_MockObject */
-    protected $assetsHelperMock;
+    private $assetsHelperMock;
 
     /** @var \Symfony\Component\Routing\RouterInterface|\PHPUnit_Framework_MockObject_MockObject */
-    protected $routerMock;
+    private $routerMock;
 
     /**
      * {@inheritdoc}