change methods names for consistency #1070

luyadev · Nov 1, 2016 · 646a81d · 646a81d
1 parent 724cc9c
commit 646a81d
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 30 deletions.
diff --git a/envs/dev/blocks/ConcreptImplementationBlock.php b/envs/dev/blocks/ConcreptImplementationBlock.php
@@ -131,7 +131,7 @@ public function setPlaceholderValues(array $placeholders)
      *
      * @return array
      */
-    public function getExtraVarsExport()
+    public function getExtraVarValues()
     {
         return ['foo' => 'bar'];
     }
@@ -141,7 +141,7 @@ public function getExtraVarsExport()
      *
      * @return array
      */
-    public function getVarsExport()
+    public function getConfigVarsExport()
     {
         return [];
     }
@@ -151,7 +151,7 @@ public function getVarsExport()
      *
      * @return array
      */
-    public function getCfgsExport()
+    public function getConfigCfgsExport()
     {
         return [];
     }
@@ -161,7 +161,7 @@ public function getCfgsExport()
      *
      * @return array
      */
-    public function getPlaceholdersExport()
+    public function getConfigPlaceholdersExport()
     {
         return [];
     }

diff --git a/modules/cms/src/base/BlockInterface.php b/modules/cms/src/base/BlockInterface.php
@@ -89,28 +89,28 @@ public function setPlaceholderValues(array $placeholders);
      * 
      * @return array
      */
-    public function getExtraVarsExport();
+    public function getExtraVarValues();
 
     /**
-     * Returns all config vars element of key value pairing to pass to the API and frontend.
+     * Returns all config vars element of key value pairing to pass to the Admin ANGULAR API
      * 
      * @return array
      */
-    public function getVarsExport();
+    public function getConfigVarsExport();
 
     /**
-     * Returns all config cfgs element of key value pairing to pass to the API and frontend.
+     * Returns all config cfgs element of key value pairing to pass to the Admin ANGULAR API
      *
      * @return array
      */
-    public function getCfgsExport();
+    public function getConfigCfgsExport();
 
     /**
-     * Returns all config placeholders element of key value pairing to pass to the API and frontend.
+     * Returns all config placeholders element of key value pairing to pass to the Admin ANGULAR API
      * 
      * @return array
      */
-    public function getPlaceholdersExport();
+    public function getConfigPlaceholdersExport();
 
     /**
      * Whether cache is enabled for this block or not.

diff --git a/modules/cms/src/base/InternalBaseBlock.php b/modules/cms/src/base/InternalBaseBlock.php
@@ -344,7 +344,7 @@ public function addExtraVar($key, $value)
     private $_extraVars = [];
 
     // access from outside
-    public function getExtraVarsExport()
+    public function getExtraVarValues()
     {
         $this->_extraVars = ArrayHelper::merge($this->_extraVars, $this->extraVars());
         return $this->_extraVars;
@@ -370,7 +370,7 @@ public function getFieldHelp()
     /**
      * @return array
      */
-    public function getVarsExport()
+    public function getConfigVarsExport()
     {
         $config = $this->config();
 
@@ -391,7 +391,7 @@ public function addVar(array $varConfig)
     /**
      * @return array
      */
-    public function getPlaceholdersExport()
+    public function getConfigPlaceholdersExport()
     {
         return (array_key_exists('placeholders', $this->config())) ? $this->config()['placeholders'] : [];
     }
@@ -401,7 +401,7 @@ public function getPlaceholdersExport()
     /**
      * @return array
      */
-    public function getCfgsExport()
+    public function getConfigCfgsExport()
     {
         $config = $this->config();
 

diff --git a/modules/cms/src/base/TwigBlock.php b/modules/cms/src/base/TwigBlock.php
@@ -24,7 +24,7 @@ public function renderFrontend()
             'vars' => $this->getVarValues(),
             'cfgs' => $this->getCfgValues(),
             'placeholders' => $this->getPlaceholderValues(),
-            'extras' => $this->getExtraVarsExport(),
+            'extras' => $this->getExtraVarValues(),
         ]);
     }
 

diff --git a/modules/cms/src/models/NavItemPage.php b/modules/cms/src/models/NavItemPage.php
@@ -227,7 +227,7 @@ private function renderPlaceholderRecursive($navItemPageId, $placeholderVar, $pr
 
                     // render sub placeholders and set into object
                     $insertedHolders = [];
-                    foreach ($blockObject->getPlaceholdersExport() as $item) {
+                    foreach ($blockObject->getConfigPlaceholdersExport() as $item) {
                         $insertedHolders[$item['var']] = $this->renderPlaceholderRecursive($navItemPageId, $item['var'], $placeholder['id']);
                     }
                     $blockObject->setPlaceholderValues($insertedHolders);
@@ -340,7 +340,7 @@ public static function getBlock($blockId)
 
         $placeholders = [];
 
-        foreach ($blockObject->getPlaceholdersExport() as $pk => $pv) {
+        foreach ($blockObject->getConfigPlaceholdersExport() as $pk => $pv) {
             $pv['nav_item_page_id'] = $blockItem['nav_item_page_id'];
             $pv['prev_id'] = $blockItem['id'];
             $placeholderVar = $pv['var'];
@@ -369,9 +369,9 @@ public static function getBlock($blockId)
             'icon' => $blockObject->icon(),
             'full_name' => ($blockObject->icon() === null) ? $blockObject->name() : '<i class="material-icons">'.$blockObject->icon().'</i> <span>'.$blockObject->name().'</span>',
             'twig_admin' => $blockObject->renderAdmin(),
-            'vars' => $blockObject->getVarsExport(),
-            'cfgs' => $blockObject->getCfgsExport(),
-            'extras' => $blockObject->getExtraVarsExport(),
+            'vars' => $blockObject->getConfigVarsExport(),
+            'cfgs' => $blockObject->getConfigCfgsExport(),
+            'extras' => $blockObject->getExtraVarValues(),
             'values' => $blockItem['json_config_values'],
             'field_help' => $blockObject->getFieldHelp(),
             'cfgvalues' => $blockItem['json_config_cfg_values'], // add: t1_json_config_cfg_values

diff --git a/modules/cms/tests/data/blocks/ConcretImplementationBlock.php b/modules/cms/tests/data/blocks/ConcretImplementationBlock.php
@@ -132,7 +132,7 @@ public function setPlaceholderValues(array $placeholders)
      *
      * @return array
      */
-    public function getExtraVarsExport()
+    public function getExtraVarValues()
     {
         return ['foo' => 'bar'];
     }
@@ -142,7 +142,7 @@ public function getExtraVarsExport()
      *
      * @return array
      */
-    public function getVarsExport()
+    public function getConfigVarsExport()
     {
         return [];
     }
@@ -152,7 +152,7 @@ public function getVarsExport()
      *
      * @return array
      */
-    public function getCfgsExport()
+    public function getConfigCfgsExport()
     {
         return [];
     }
@@ -162,7 +162,7 @@ public function getCfgsExport()
      *
      * @return array
      */
-    public function getPlaceholdersExport()
+    public function getConfigPlaceholdersExport()
     {
         return [];
     }

diff --git a/modules/cms/tests/src/base/BlockTest.php b/modules/cms/tests/src/base/BlockTest.php
@@ -57,7 +57,7 @@ public function testBlockSetup()
         $this->assertEquals('TestBlock.twig', $block->getViewFileName('twig'));
         $this->assertEquals('twig-frontend', $block->renderFrontend());
 
-        foreach ($block->getVarsExport() as $var) {
+        foreach ($block->getConfigVarsExport() as $var) {
             $this->assertArrayHasKey('id', $var);
             $this->assertArrayHasKey('var', $var);
             $this->assertArrayHasKey('label', $var);
@@ -67,7 +67,7 @@ public function testBlockSetup()
             $this->assertArrayHasKey('initvalue', $var);
         }
 
-        foreach ($block->getCfgsExport() as $var) {
+        foreach ($block->getConfigCfgsExport() as $var) {
             $this->assertArrayHasKey('id', $var);
             $this->assertArrayHasKey('var', $var);
             $this->assertArrayHasKey('label', $var);
@@ -99,7 +99,7 @@ public function testBlockConfigException()
     {
         $block = new FailureBlock();
         // will throw Exception:  Required attributes in config var element is missing. var, label and type are required.
-        $block->getVarsExport();
+        $block->getConfigVarsExport();
     }
 
     public function testGetterSetter()

diff --git a/modules/cms/tests/src/injectors/ActiveQueryCheckboxInjectorTest.php b/modules/cms/tests/src/injectors/ActiveQueryCheckboxInjectorTest.php
@@ -28,7 +28,7 @@ public function testBasicInjector()
         $injector = new ActiveQueryCheckboxInjector(['query' => NavItem::find(), 'varName' => 'test', 'varLabel' => 'test label', 'context' => $block]);
         $injector->setup();
 
-        $vars = $block->getVarsExport();
+        $vars = $block->getConfigVarsExport();
 
         $v = $vars[0];
 
@@ -50,7 +50,7 @@ public function testFieldSelectionBasicInjector()
         $injector = new ActiveQueryCheckboxInjector(['query' => NavItem::find()->select(['title']), 'varName' => 'test', 'varLabel' => 'test label', 'context' => $block]);
         $injector->setup();
 
-        $vars = $block->getVarsExport();
+        $vars = $block->getConfigVarsExport();
 
         $v = $vars[0];