Merge branch 'MAGETWO-32624' of https://github.corp.ebay.com/magento-extensibility/magento2ce into MAGETWO-32624

Maksym Savich · Maksym Savich · commit d4ca5b814ea3 · 2015-03-30T14:59:37.000-05:00
diff --git a/app/code/Magento/Backend/Model/Locale/Manager.php b/app/code/Magento/Backend/Model/Locale/Manager.php
@@ -4,6 +4,7 @@
  * See COPYING.txt for license details.
  */
 namespace Magento\Backend\Model\Locale;
+use Magento\Framework\Locale\Resolver;
 
 /**
  * Locale manager model
@@ -68,7 +69,7 @@ public function switchBackendInterfaceLocale($localeCode)
      */
     public function getUserInterfaceLocale()
     {
-        $interfaceLocale = \Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE;
+        $interfaceLocale = Resolver::DEFAULT_LOCALE;
 
         $userData = $this->_authSession->getUser();
         if ($userData && $userData->getInterfaceLocale()) {
diff --git a/app/code/Magento/Backend/Test/Unit/Model/Locale/ManagerTest.php b/app/code/Magento/Backend/Test/Unit/Model/Locale/ManagerTest.php
@@ -5,6 +5,8 @@
  */
 namespace Magento\Backend\Test\Unit\Model\Locale;
 
+use Magento\Framework\Locale\Resolver;
+
 class ManagerTest extends \PHPUnit_Framework_TestCase
 {
     /**
@@ -87,7 +89,7 @@ public function testGetUserInterfaceLocaleDefault()
     {
         $locale = $this->_model->getUserInterfaceLocale();
 
-        $this->assertEquals($locale, \Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);
+        $this->assertEquals($locale, Resolver::DEFAULT_LOCALE);
     }
 
     /**
diff --git a/app/code/Magento/Customer/Test/Unit/Block/Widget/DobTest.php b/app/code/Magento/Customer/Test/Unit/Block/Widget/DobTest.php
@@ -10,6 +10,7 @@
 
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Customer\Block\Widget\Dob;
+use Magento\Framework\Locale\Resolver;
 
 class DobTest extends \PHPUnit_Framework_TestCase
 {
@@ -69,7 +70,7 @@ public function setUp()
         $localeResolver = $this->getMock('\Magento\Framework\Locale\ResolverInterface');
         $localeResolver->expects($this->any())
             ->method('getLocale')
-            ->willReturn(\Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);
+            ->willReturn(Resolver::DEFAULT_LOCALE);
         $timezone = $objectManager->getObject(
             'Magento\Framework\Stdlib\DateTime\Timezone',
             ['localeResolver' => $localeResolver]
diff --git a/app/code/Magento/Store/Model/Config/Reader/DefaultReader.php b/app/code/Magento/Store/Model/Config/Reader/DefaultReader.php
@@ -7,6 +7,8 @@
  */
 namespace Magento\Store\Model\Config\Reader;
 
+use Magento\Framework\App\Config\ScopeConfigInterface;
+
 class DefaultReader implements \Magento\Framework\App\Config\Scope\ReaderInterface
 {
     /**
@@ -42,14 +44,21 @@ public function __construct(
     /**
      * Read configuration data
      *
+     * @param null|string $scope
+     * @throws \Magento\Framework\Exception Exception is thrown when scope other than default is given
      * @return array
      */
-    public function read()
+    public function read($scope = ScopeConfigInterface::SCOPE_DEFAULT)
     {
-        $config = $this->_initialConfig->getData(\Magento\Framework\App\ScopeInterface::SCOPE_DEFAULT);
+        $scope = $scope === null ? ScopeConfigInterface::SCOPE_DEFAULT : $scope;
+        if ($scope !== ScopeConfigInterface::SCOPE_DEFAULT) {
+            throw new \Magento\Framework\Exception("Only default scope allowed");
+        }
+
+        $config = $this->_initialConfig->getData($scope);
 
         $collection = $this->_collectionFactory->create(
-            ['scope' => \Magento\Framework\App\ScopeInterface::SCOPE_DEFAULT]
+            ['scope' => $scope]
         );
         $dbDefaultConfig = [];
         foreach ($collection as $item) {
diff --git a/app/code/Magento/Store/Model/Config/Reader/Store.php b/app/code/Magento/Store/Model/Config/Reader/Store.php
@@ -66,7 +66,7 @@ public function __construct(
     /**
      * Read configuration by code
      *
-     * @param string $code
+     * @param null|string $code
      * @return array
      * @throws NoSuchEntityException
      */
diff --git a/app/code/Magento/User/Controller/Adminhtml/User/Edit.php b/app/code/Magento/User/Controller/Adminhtml/User/Edit.php
@@ -6,6 +6,8 @@
  */
 namespace Magento\User\Controller\Adminhtml\User;
 
+use Magento\Framework\Locale\Resolver;
+
 class Edit extends \Magento\User\Controller\Adminhtml\User
 {
     /**
@@ -25,7 +27,7 @@ public function execute()
                 return;
             }
         } else {
-            $model->setInterfaceLocale(\Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);
+            $model->setInterfaceLocale(Resolver::DEFAULT_LOCALE);
         }
 
         // Restore previously entered form data from session
diff --git a/dev/tests/integration/testsuite/Magento/Backend/Model/Locale/ResolverTest.php b/dev/tests/integration/testsuite/Magento/Backend/Model/Locale/ResolverTest.php
@@ -4,6 +4,7 @@
  * See COPYING.txt for license details.
  */
 namespace Magento\Backend\Model\Locale;
+use Magento\Framework\Locale\Resolver;
 
 /**
  * @magentoAppArea adminhtml
@@ -28,7 +29,7 @@ protected function setUp()
      */
     public function testSetLocaleWithDefaultLocale()
     {
-        $this->_checkSetLocale(\Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);
+        $this->_checkSetLocale(Resolver::DEFAULT_LOCALE);
     }
 
     /**
diff --git a/lib/internal/Magento/Framework/App/Config/Initial.php b/lib/internal/Magento/Framework/App/Config/Initial.php
@@ -50,8 +50,10 @@ public function __construct(
     /**
      * Get initial data by given scope
      *
-     * @param string $scope
+     * @param string $scope Format is scope type and scope code separated by pipe: e.g. "type|code"
      * @return array
+     *
+     * @api
      */
     public function getData($scope)
     {
@@ -69,6 +71,8 @@ public function getData($scope)
      * Get configuration metadata
      *
      * @return array
+     *
+     * @api
      */
     public function getMetadata()
     {
diff --git a/lib/internal/Magento/Framework/App/Config/MutableScopeConfigInterface.php b/lib/internal/Magento/Framework/App/Config/MutableScopeConfigInterface.php
@@ -8,6 +8,9 @@
 
 namespace Magento\Framework\App\Config;
 
+/**
+ * @api
+ */
 interface MutableScopeConfigInterface extends \Magento\Framework\App\Config\ScopeConfigInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/App/Config/ReinitableConfigInterface.php b/lib/internal/Magento/Framework/App/Config/ReinitableConfigInterface.php
@@ -8,6 +8,9 @@
 
 namespace Magento\Framework\App\Config;
 
+/**
+ * @api
+ */
 interface ReinitableConfigInterface extends \Magento\Framework\App\Config\MutableScopeConfigInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php b/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php
@@ -4,15 +4,22 @@
  *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
+ *
+ * @api
  */
 namespace Magento\Framework\App\Config\Scope;
 
+/**
+ * @api
+ */
 interface ReaderInterface
 {
     /**
      * Read configuration scope
      *
+     * @param string|null $scope
+     * @throws \Exception May throw an exception if the given scope is invalid
      * @return array
      */
-    public function read();
+    public function read($scope = null);
 }
diff --git a/lib/internal/Magento/Framework/App/Config/ScopeConfigInterface.php b/lib/internal/Magento/Framework/App/Config/ScopeConfigInterface.php
@@ -8,25 +8,33 @@
 
 namespace Magento\Framework\App\Config;
 
+/**
+ * @api
+ */
 interface ScopeConfigInterface
 {
     /**
-     * Retrieve config value by path and scope
+     * Default scope type
+     */
+    const SCOPE_DEFAULT = 'default';
+
+    /**
+     * Retrieve config value by path and scope.
      *
-     * @param string $path
-     * @param string $scope
+     * @param string $path The path through the tree of configuration values, e.g., 'general/store_information/name'
+     * @param string $scope The scope to use to determine config value, e.g., 'store' or 'default'
      * @param null|string $scopeCode
      * @return mixed
      */
-    public function getValue($path, $scope = \Magento\Framework\App\ScopeInterface::SCOPE_DEFAULT, $scopeCode = null);
+    public function getValue($path, $scope = \Magento\Framework\App\Config\ScopeConfigInterface::SCOPE_DEFAULT, $scopeCode = null);
 
     /**
      * Retrieve config flag by path and scope
      *
-     * @param string $path
-     * @param string $scope
+     * @param string $path The path through the tree of configuration values, e.g., 'general/store_information/name'
+     * @param string $scope The scope to use to determine config value, e.g., 'store' or 'default'
      * @param null|string $scopeCode
      * @return bool
      */
-    public function isSetFlag($path, $scope = \Magento\Framework\App\ScopeInterface::SCOPE_DEFAULT, $scopeCode = null);
+    public function isSetFlag($path, $scope = \Magento\Framework\App\Config\ScopeConfigInterface::SCOPE_DEFAULT, $scopeCode = null);
 }
diff --git a/lib/internal/Magento/Framework/App/Config/ValueFactory.php b/lib/internal/Magento/Framework/App/Config/ValueFactory.php
@@ -44,6 +44,8 @@ public function __construct(
      * @param array $data
      * @return \Magento\Framework\App\Config\ValueInterface
      * @throws \InvalidArgumentException
+     *
+     * @api
      */
     public function create(array $data = [])
     {
diff --git a/lib/internal/Magento/Framework/App/ScopeInterface.php b/lib/internal/Magento/Framework/App/ScopeInterface.php
@@ -9,6 +9,8 @@ interface ScopeInterface
 {
     /**
      * Default scope type
+     *
+     * @deprecated Use \Magento\Framework\App\Config\ScopeConfigInterface::SCOPE_DEFAULT
      */
     const SCOPE_DEFAULT = 'default';
 
diff --git a/lib/internal/Magento/Framework/Locale/ConfigInterface.php b/lib/internal/Magento/Framework/Locale/ConfigInterface.php
@@ -5,19 +5,24 @@
  */
 namespace Magento\Framework\Locale;
 
+/**
+ * Provides access to locale-related config information
+ *
+ * @api
+ */
 interface ConfigInterface
 {
     /**
      * Get list pre-configured allowed locales
      *
-     * @return array
+     * @return string[]
      */
     public function getAllowedLocales();
 
     /**
      * Get list pre-configured allowed currencies
      *
-     * @return array
+     * @return string[]
      */
     public function getAllowedCurrencies();
 }
diff --git a/lib/internal/Magento/Framework/Locale/Currency.php b/lib/internal/Magento/Framework/Locale/Currency.php
@@ -7,6 +7,10 @@
 
 class Currency implements \Magento\Framework\Locale\CurrencyInterface
 {
+    /**
+     * Default currency
+     */
+    const DEFAULT_CURRENCY = 'USD';
     /**
      * @var array
      */
@@ -51,7 +55,7 @@ public function __construct(
      */
     public function getDefaultCurrency()
     {
-        return \Magento\Framework\Locale\CurrencyInterface::DEFAULT_CURRENCY;
+        return self::DEFAULT_CURRENCY;
     }
 
     /**
diff --git a/lib/internal/Magento/Framework/Locale/CurrencyInterface.php b/lib/internal/Magento/Framework/Locale/CurrencyInterface.php
@@ -5,18 +5,13 @@
  */
 namespace Magento\Framework\Locale;
 
+/**
+ * Provides access to currency config information
+ *
+ * @api
+ */
 interface CurrencyInterface
 {
-    /**
-     * Default currency
-     */
-    const DEFAULT_CURRENCY = 'USD';
-
-    /**
-     * XML path to installed currencies
-     */
-    const XML_PATH_ALLOW_CURRENCIES_INSTALLED = 'system/currency/installed';
-
     /**
      * Retrieve currency code
      *
diff --git a/lib/internal/Magento/Framework/Locale/Resolver.php b/lib/internal/Magento/Framework/Locale/Resolver.php
@@ -9,6 +9,10 @@
 
 class Resolver implements ResolverInterface
 {
+    /**
+     * Default locale
+     */
+    const DEFAULT_LOCALE = 'en_US';
     /**
      * Default locale code
      *
@@ -85,7 +89,7 @@ public function getDefaultLocale()
         if (!$this->defaultLocale) {
             $locale = $this->scopeConfig->getValue($this->getDefaultLocalePath(), $this->scopeType);
             if (!$locale) {
-                $locale = ResolverInterface::DEFAULT_LOCALE;
+                $locale = self::DEFAULT_LOCALE;
             }
             $this->defaultLocale = $locale;
         }
diff --git a/lib/internal/Magento/Framework/Locale/ResolverInterface.php b/lib/internal/Magento/Framework/Locale/ResolverInterface.php
@@ -5,13 +5,13 @@
  */
 namespace Magento\Framework\Locale;
 
+/**
+ * Manages locale config information
+ *
+ * @api
+ */
 interface ResolverInterface
 {
-    /**
-     * Default locale
-     */
-    const DEFAULT_LOCALE = 'en_US';
-
     /**
      * Return path to default locale
      *
diff --git a/lib/internal/Magento/Framework/Locale/Test/Unit/CurrencyTest.php b/lib/internal/Magento/Framework/Locale/Test/Unit/CurrencyTest.php
@@ -8,6 +8,7 @@
 
 namespace Magento\Framework\Locale\Test\Unit;
 
+use Magento\Framework\Locale\Currency;
 use Magento\Framework\Locale\CurrencyInterface;
 
 class CurrencyTest extends \PHPUnit_Framework_TestCase
@@ -68,7 +69,7 @@ public function setUp()
 
     public function testGetDefaultCurrency()
     {
-        $expectedDefaultCurrency = CurrencyInterface::DEFAULT_CURRENCY;
+        $expectedDefaultCurrency = Currency::DEFAULT_CURRENCY;
         $retrievedDefaultCurrency = $this->testCurrencyObject->getDefaultCurrency();
         $this->assertEquals($expectedDefaultCurrency, $retrievedDefaultCurrency);
     }
diff --git a/lib/internal/Magento/Framework/Locale/Validator.php b/lib/internal/Magento/Framework/Locale/Validator.php
@@ -29,10 +29,12 @@ public function __construct(\Magento\Framework\Locale\ConfigInterface $localeCon
     }
 
     /**
-     * Validate locale code
+     * Validate locale code. Code must be in the list of allowed locales.
      *
      * @param string $localeCode
      * @return bool
+     *
+     * @api
      */
     public function isValid($localeCode)
     {
diff --git a/lib/internal/Magento/Framework/Message/Manager.php b/lib/internal/Magento/Framework/Message/Manager.php
diff --git a/lib/internal/Magento/Framework/Message/ManagerInterface.php b/lib/internal/Magento/Framework/Message/ManagerInterface.php
diff --git a/lib/internal/Magento/Framework/Message/MessageInterface.php b/lib/internal/Magento/Framework/Message/MessageInterface.php
diff --git a/lib/internal/Magento/Framework/Message/Test/Unit/ManagerTest.php b/lib/internal/Magento/Framework/Message/Test/Unit/ManagerTest.php
diff --git a/lib/internal/Magento/Framework/View/Test/Unit/Element/MessagesTest.php b/lib/internal/Magento/Framework/View/Test/Unit/Element/MessagesTest.php
diff --git a/setup/src/Magento/Setup/Model/Lists.php b/setup/src/Magento/Setup/Model/Lists.php

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Backend\Test\Unit\Model\Locale;`
`7`	`7`
	`8`	`+use Magento\Framework\Locale\Resolver;`
	`9`	`+`
`8`	`10`	`class ManagerTest extends \PHPUnit_Framework_TestCase`
`9`	`11`	`{`
`10`	`12`	`/**`
`@@ -87,7 +89,7 @@ public function testGetUserInterfaceLocaleDefault()`
`87`	`89`	`{`
`88`	`90`	`$locale = $this->_model->getUserInterfaceLocale();`
`89`	`91`
`90`		`- $this->assertEquals($locale, \Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);`
	`92`	`+ $this->assertEquals($locale, Resolver::DEFAULT_LOCALE);`
`91`	`93`	`}`
`92`	`94`
`93`	`95`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function __construct(`
`66`	`66`	`/**`
`67`	`67`	`* Read configuration by code`
`68`	`68`	`*`
`69`		`- * @param string $code`
	`69`	`+ * @param null\|string $code`
`70`	`70`	`* @return array`
`71`	`71`	`* @throws NoSuchEntityException`
`72`	`72`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@`
`6`	`6`	`*/`
`7`	`7`	`namespace Magento\User\Controller\Adminhtml\User;`
`8`	`8`
	`9`	`+use Magento\Framework\Locale\Resolver;`
	`10`	`+`
`9`	`11`	`class Edit extends \Magento\User\Controller\Adminhtml\User`
`10`	`12`	`{`
`11`	`13`	`/**`
`@@ -25,7 +27,7 @@ public function execute()`
`25`	`27`	`return;`
`26`	`28`	`}`
`27`	`29`	`} else {`
`28`		`- $model->setInterfaceLocale(\Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);`
	`30`	`+ $model->setInterfaceLocale(Resolver::DEFAULT_LOCALE);`
`29`	`31`	`}`
`30`	`32`
`31`	`33`	`// Restore previously entered form data from session`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Backend\Model\Locale;`
	`7`	`+use Magento\Framework\Locale\Resolver;`
`7`	`8`
`8`	`9`	`/**`
`9`	`10`	`* @magentoAppArea adminhtml`
`@@ -28,7 +29,7 @@ protected function setUp()`
`28`	`29`	`*/`
`29`	`30`	`public function testSetLocaleWithDefaultLocale()`
`30`	`31`	`{`
`31`		`- $this->_checkSetLocale(\Magento\Framework\Locale\ResolverInterface::DEFAULT_LOCALE);`
	`32`	`+ $this->_checkSetLocale(Resolver::DEFAULT_LOCALE);`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,10 @@ public function __construct(`
`50`	`50`	`/**`
`51`	`51`	`* Get initial data by given scope`
`52`	`52`	`*`
`53`		`- * @param string $scope`
	`53`	`+ * @param string $scope Format is scope type and scope code separated by pipe: e.g. "type\|code"`
`54`	`54`	`* @return array`
	`55`	`+ *`
	`56`	`+ * @api`
`55`	`57`	`*/`
`56`	`58`	`public function getData($scope)`
`57`	`59`	`{`
`@@ -69,6 +71,8 @@ public function getData($scope)`
`69`	`71`	`* Get configuration metadata`
`70`	`72`	`*`
`71`	`73`	`* @return array`
	`74`	`+ *`
	`75`	`+ * @api`
`72`	`76`	`*/`
`73`	`77`	`public function getMetadata()`
`74`	`78`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@`
`8`	`8`
`9`	`9`	`namespace Magento\Framework\App\Config;`
`10`	`10`
	`11`	`+/**`
	`12`	`+ * @api`
	`13`	`+ */`
`11`	`14`	`interface MutableScopeConfigInterface extends \Magento\Framework\App\Config\ScopeConfigInterface`
`12`	`15`	`{`
`13`	`16`	`/**`