Merge remote-tracking branch 'origin/MAGETWO-34653' into MAGETWO-34653

akaplya · akaplya · commit 49bce4132158 · 2015-04-02T17:40:23.000+03:00
diff --git a/app/code/Magento/MediaStorage/Model/File/Storage/Response.php b/app/code/Magento/MediaStorage/Model/File/Storage/Response.php
@@ -29,15 +29,17 @@ class Response extends Http implements \Magento\Framework\App\Response\FileInter
      * @param CookieManagerInterface $cookieManager
      * @param CookieMetadataFactory $cookieMetadataFactory
      * @param \Magento\Framework\App\Http\Context $context
+     * @param \Magento\Framework\Stdlib\DateTime $dateTime
      * @param \Magento\Framework\File\Transfer\Adapter\Http $transferAdapter
      */
     public function __construct(
         CookieManagerInterface $cookieManager,
         CookieMetadataFactory $cookieMetadataFactory,
         \Magento\Framework\App\Http\Context $context,
+        \Magento\Framework\Stdlib\DateTime $dateTime,
         \Magento\Framework\File\Transfer\Adapter\Http $transferAdapter
     ) {
-        parent::__construct($cookieManager, $cookieMetadataFactory, $context);
+        parent::__construct($cookieManager, $cookieMetadataFactory, $context, $dateTime);
         $this->_transferAdapter = $transferAdapter;
     }
 
diff --git a/app/code/Magento/Payment/Model/InfoInterface.php b/app/code/Magento/Payment/Model/InfoInterface.php
@@ -30,8 +30,8 @@ public function decrypt($data);
     /**
      * Set Additional information about payment into Payment model
      *
-     * @param mixed $key
-     * @param mixed|null $value
+     * @param string $key
+     * @param string|null $value
      * @return mixed
      */
     public function setAdditionalInformation($key, $value = null);
@@ -47,16 +47,16 @@ public function hasAdditionalInformation($key = null);
     /**
      * Unsetter for entire additional_information value or one of its element by key
      *
-     * @param string $key
+     * @param string|null $key
      * @return $this
      */
     public function unsAdditionalInformation($key = null);
 
     /**
      * Getter for entire additional_information value or one of its element by key
      *
-     * @param string $key
-     * @return array|null|mixed
+     * @param string|null $key
+     * @return mixed
      */
     public function getAdditionalInformation($key = null);
 
diff --git a/app/code/Magento/Payment/Test/Unit/Block/Info/CcTest.php b/app/code/Magento/Payment/Test/Unit/Block/Info/CcTest.php
@@ -135,11 +135,11 @@ public function testGetCcExpDate($ccExpMonth, $ccExpYear)
         $paymentInfo
             ->expects($this->any())
             ->method('getCcExpMonth')
-            ->will($this->returnValue($ccExpMonth));
+            ->willReturn($ccExpMonth);
         $paymentInfo
             ->expects($this->any())
             ->method('getCcExpYear')
-            ->will($this->returnValue($ccExpYear));
+            ->willReturn($ccExpYear);
         $this->model->setData('info', $paymentInfo);
 
         $this->localeDate
diff --git a/app/code/Magento/Sales/Block/Order/PrintOrder/Creditmemo.php b/app/code/Magento/Sales/Block/Order/PrintOrder/Creditmemo.php
@@ -127,6 +127,8 @@ public function getTotalsHtml($creditmemo)
     }
 
     /**
+     * Formats order address to html, pdf and etc. formats
+     *
      * @param \Magento\Sales\Model\Order\Address $address
      * @param string $format
      * @return null|string
diff --git a/app/code/Magento/Sales/Block/Order/PrintOrder/Invoice.php b/app/code/Magento/Sales/Block/Order/PrintOrder/Invoice.php
@@ -127,6 +127,8 @@ public function getInvoiceTotalsHtml($invoice)
     }
 
     /**
+     * Formats order address to html, pdf and etc. formats
+     *
      * @param \Magento\Sales\Model\Order\Address $address
      * @param string $format
      * @return null|string
diff --git a/app/code/Magento/Sales/Model/Order/Address/Renderer.php b/app/code/Magento/Sales/Model/Order/Address/Renderer.php
@@ -11,7 +11,7 @@
 use Magento\Sales\Model\Order\Address;
 
 /**
- * Class Renderer
+ * Class Renderer using for formatting of order address
  */
 class Renderer
 {
@@ -48,7 +48,8 @@ public function __construct(
      */
     public function format(Address $address, $type)
     {
-        if (!($formatType = $this->addressConfig->getFormatByCode($type)) || !$formatType->getRenderer()) {
+        $formatType = $this->addressConfig->getFormatByCode($type);
+        if (!$formatType || !$formatType->getRenderer()) {
             return null;
         }
         $this->eventManager->dispatch('customer_address_format', ['type' => $formatType, 'address' => $address]);
diff --git a/app/code/Magento/Sales/Model/Order/Pdf/AbstractPdf.php b/app/code/Magento/Sales/Model/Order/Pdf/AbstractPdf.php
@@ -404,7 +404,8 @@ protected function insertOrder(&$page, $obj, $putOrderId = true)
                     $order->getCreatedAt(),
                     true
                 ),
-                \IntlDateFormatter::MEDIUM, false
+                \IntlDateFormatter::MEDIUM,
+                false
             ),
             35,
             $top -= 15,
diff --git a/app/code/Magento/Sales/Model/Resource/EntityMetadata.php b/app/code/Magento/Sales/Model/Resource/EntityMetadata.php
@@ -8,7 +8,7 @@
 use Magento\Sales\Model\AbstractModel;
 
 /**
- * Class EntityMetadata
+ * Class EntityMetadata represents a list of entity fields that are applicable for persistence operations
  */
 class EntityMetadata
 {
diff --git a/app/code/Magento/Sales/Model/Resource/EntitySnapshot.php b/app/code/Magento/Sales/Model/Resource/EntitySnapshot.php
@@ -8,7 +8,7 @@
 use Magento\Framework\Model\AbstractModel;
 
 /**
- * Class EntitySnapshot
+ * Class EntitySnapshot register snapshot of entity data, for tracking changes
  */
 class EntitySnapshot
 {
diff --git a/app/code/Magento/Sales/view/adminhtml/templates/order/view/info.phtml b/app/code/Magento/Sales/view/adminhtml/templates/order/view/info.phtml
@@ -12,7 +12,8 @@
 <?php
 $orderAdminDate = $block->formatDate(
     $block->getOrderAdminDate($_order->getCreatedAt()),
-    \IntlDateFormatter::MEDIUM, true
+    \IntlDateFormatter::MEDIUM,
+    true
 );
 $orderStoreDate = $block->formatDate(
     $block->getCreatedAtStoreDate($_order->getStore(), $_order->getCreatedAt()),
diff --git a/app/code/Magento/SalesSequence/Model/Config.php b/app/code/Magento/SalesSequence/Model/Config.php
@@ -6,7 +6,7 @@
 namespace Magento\SalesSequence\Model;
 
 /**
- * Class Config
+ * Class Config - configuration container for sequence
  */
 class Config
 {
diff --git a/app/code/Magento/SalesSequence/Model/Resource/Meta.php b/app/code/Magento/SalesSequence/Model/Resource/Meta.php
@@ -14,7 +14,7 @@
 use Magento\Framework\DB\Ddl\Sequence as DdlSequence;
 
 /**
- * Class Meta
+ * Class Meta represents metadata for sequence as sequence table and store id
  */
 class Meta extends \Magento\Framework\Model\Resource\Db\AbstractDb
 {
@@ -39,7 +39,6 @@ class Meta extends \Magento\Framework\Model\Resource\Db\AbstractDb
      * @param DatabaseContext $context
      * @param MetaFactory $metaFactory
      * @param ResourceProfile $resourceProfile
-     * @param DdlSequence $ddlSequence
      * @param string $resourcePrefix
      */
     public function __construct(
@@ -64,6 +63,8 @@ protected function _construct()
     }
 
     /**
+     * Retrieves Metadata for entity by entity type and store id
+     *
      * @param string $entityType
      * @param int $storeId
      * @return \Magento\SalesSequence\Model\Meta
@@ -89,6 +90,8 @@ public function loadByEntityTypeAndStore($entityType, $storeId)
     }
 
     /**
+     * Using for load sequence profile and setting it into metadata
+     *
      * @param \Magento\Framework\Model\AbstractModel $object
      * @return $this
      */
diff --git a/app/code/Magento/SalesSequence/Model/Resource/Profile.php b/app/code/Magento/SalesSequence/Model/Resource/Profile.php
@@ -10,7 +10,7 @@
 use Magento\SalesSequence\Model\ProfileFactory;
 
 /**
- * Class Profile
+ * Class Profile represents profile data for sequence as prefix, suffix, start value etc.
  */
 class Profile extends \Magento\Framework\Model\Resource\Db\AbstractDb
 {
diff --git a/app/code/Magento/SalesSequence/Model/Sequence.php b/app/code/Magento/SalesSequence/Model/Sequence.php
@@ -9,7 +9,7 @@
 use Magento\Framework\DB\Sequence\SequenceInterface;
 
 /**
- * Class Sequence
+ * Class Sequence represents sequence in logic
  */
 class Sequence implements SequenceInterface
 {
@@ -85,6 +85,8 @@ public function getNextValue()
     }
 
     /**
+     * Calculate current value depends on start value
+     *
      * @return string
      */
     private function calculateCurrentValue()
diff --git a/dev/tests/integration/framework/tests/unit/testsuite/Magento/Test/TestCase/ControllerAbstractTest.php b/dev/tests/integration/framework/tests/unit/testsuite/Magento/Test/TestCase/ControllerAbstractTest.php
@@ -17,19 +17,11 @@ class ControllerAbstractTest extends \Magento\TestFramework\TestCase\AbstractCon
 
     protected function setUp()
     {
-        $this->messageManager = $this->getMock('\Magento\Framework\Message\Manager', [], [], '', false);
-        $request = new \Magento\TestFramework\Request(
-            $this->getMock('Magento\Framework\Stdlib\Cookie\CookieReaderInterface'),
-            $this->getMock('Magento\Framework\App\Route\ConfigInterface\Proxy', [], [], '', false),
-            $this->getMock('Magento\Framework\App\Request\PathInfoProcessorInterface'),
-            $this->getMock('Magento\Framework\ObjectManagerInterface')
-        );
-        $response = new \Magento\TestFramework\Response(
-            $this->getMock('Magento\Framework\Stdlib\CookieManagerInterface'),
-            $this->getMock('Magento\Framework\Stdlib\Cookie\CookieMetadataFactory', [], [], '', false),
-            $this->getMock('Magento\Framework\App\Http\Context', [], [], '', false)
-        );
+        $testObjectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
 
+        $this->messageManager = $this->getMock('\Magento\Framework\Message\Manager', [], [], '', false);
+        $request = $testObjectManager->getObject('Magento\TestFramework\Request');
+        $response = $testObjectManager->getObject('Magento\TestFramework\Response');
         $this->_objectManager = $this->getMock(
             'Magento\TestFramework\ObjectManager',
             ['get', 'create'],
diff --git a/lib/internal/Magento/Framework/App/Response/Http.php b/lib/internal/Magento/Framework/App/Response/Http.php
@@ -11,42 +11,44 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
 use Magento\Framework\Stdlib\CookieManagerInterface;
+use Magento\Framework\Stdlib\DateTime;
 
 class Http extends \Magento\Framework\HTTP\PhpEnvironment\Response
 {
-    /**
-     * Cookie to store page vary string
-     */
+    /** Cookie to store page vary string */
     const COOKIE_VARY_STRING = 'X-Magento-Vary';
 
-    /**
-     * @var \Magento\Framework\Stdlib\CookieManagerInterface
-     */
+    /** Format for expiration timestamp headers */
+    const EXPIRATION_TIMESTAMP_FORMAT = 'D, d M Y H:i:s T';
+
+    /** @var \Magento\Framework\Stdlib\CookieManagerInterface */
     protected $cookieManager;
 
-    /**
-     * @var \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory
-     */
+    /** @var \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory */
     protected $cookieMetadataFactory;
 
-    /**
-     * @var \Magento\Framework\App\Http\Context
-     */
+    /** @var \Magento\Framework\App\Http\Context */
     protected $context;
 
+    /** @var DateTime */
+    protected $dateTime;
+
     /**
      * @param CookieManagerInterface $cookieManager
      * @param CookieMetadataFactory $cookieMetadataFactory
      * @param Context $context
+     * @param DateTime $dateTime
      */
     public function __construct(
         CookieManagerInterface $cookieManager,
         CookieMetadataFactory $cookieMetadataFactory,
-        Context $context
+        Context $context,
+        DateTime $dateTime
     ) {
         $this->cookieManager = $cookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
         $this->context = $context;
+        $this->dateTime = $dateTime;
     }
 
     /**
@@ -97,7 +99,7 @@ public function setPublicHeaders($ttl)
         }
         $this->setHeader('pragma', 'cache', true);
         $this->setHeader('cache-control', 'public, max-age=' . $ttl . ', s-maxage=' . $ttl, true);
-        $this->setHeader('expires', gmdate('D, d M Y H:i:s T', strtotime('+' . $ttl . ' seconds')), true);
+        $this->setHeader('expires', $this->getExpirationHeader('+' . $ttl . ' seconds'), true);
     }
 
     /**
@@ -114,7 +116,7 @@ public function setPrivateHeaders($ttl)
         }
         $this->setHeader('pragma', 'cache', true);
         $this->setHeader('cache-control', 'private, max-age=' . $ttl, true);
-        $this->setHeader('expires', gmdate('D, d M Y H:i:s T', strtotime('+' . $ttl . ' seconds')), true);
+        $this->setHeader('expires', $this->getExpirationHeader('+' . $ttl . ' seconds'), true);
     }
 
     /**
@@ -126,7 +128,7 @@ public function setNoCacheHeaders()
     {
         $this->setHeader('pragma', 'no-cache', true);
         $this->setHeader('cache-control', 'no-store, no-cache, must-revalidate, max-age=0', true);
-        $this->setHeader('expires', gmdate('D, d M Y H:i:s T', strtotime('-1 year')), true);
+        $this->setHeader('expires', $this->getExpirationHeader('-1 year'), true);
     }
 
     /**
@@ -160,4 +162,15 @@ public function __wakeup()
         $this->cookieManager = $objectManager->create('Magento\Framework\Stdlib\CookieManagerInterface');
         $this->cookieMetadataFactory = $objectManager->get('Magento\Framework\Stdlib\Cookie\CookieMetadataFactory');
     }
+
+    /**
+     * Given a time input, returns the formatted header
+     *
+     * @param string $time
+     * @return string
+     */
+    protected function getExpirationHeader($time)
+    {
+        return $this->dateTime->gmDate(self::EXPIRATION_TIMESTAMP_FORMAT, $this->dateTime->strToTime($time));
+    }
 }
diff --git a/lib/internal/Magento/Framework/App/Test/Unit/Response/HttpTest.php b/lib/internal/Magento/Framework/App/Test/Unit/Response/HttpTest.php
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime.php b/lib/internal/Magento/Framework/Stdlib/DateTime.php
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime/DateTime.php b/lib/internal/Magento/Framework/Stdlib/DateTime/DateTime.php

Original file line number	Diff line number	Diff line change
`@@ -127,6 +127,8 @@ public function getTotalsHtml($creditmemo)`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`/**`
	`130`	`+ * Formats order address to html, pdf and etc. formats`
	`131`	`+ *`
`130`	`132`	`* @param \Magento\Sales\Model\Order\Address $address`
`131`	`133`	`* @param string $format`
`132`	`134`	`* @return null\|string`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`use Magento\Sales\Model\Order\Address;`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * Class Renderer`
	`14`	`+ * Class Renderer using for formatting of order address`
`15`	`15`	`*/`
`16`	`16`	`class Renderer`
`17`	`17`	`{`
`@@ -48,7 +48,8 @@ public function __construct(`
`48`	`48`	`*/`
`49`	`49`	`public function format(Address $address, $type)`
`50`	`50`	`{`
`51`		`- if (!($formatType = $this->addressConfig->getFormatByCode($type)) \|\| !$formatType->getRenderer()) {`
	`51`	`+ $formatType = $this->addressConfig->getFormatByCode($type);`
	`52`	`+ if (!$formatType \|\| !$formatType->getRenderer()) {`
`52`	`53`	`return null;`
`53`	`54`	`}`
`54`	`55`	`$this->eventManager->dispatch('customer_address_format', ['type' => $formatType, 'address' => $address]);`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Magento\Sales\Model\AbstractModel;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Class EntityMetadata`
	`11`	`+ * Class EntityMetadata represents a list of entity fields that are applicable for persistence operations`
`12`	`12`	`*/`
`13`	`13`	`class EntityMetadata`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Magento\Framework\Model\AbstractModel;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Class EntitySnapshot`
	`11`	`+ * Class EntitySnapshot register snapshot of entity data, for tracking changes`
`12`	`12`	`*/`
`13`	`13`	`class EntitySnapshot`
`14`	`14`	`{`