MAGETWO-67576: Add @api Annotation in Pricing Framework

buskamuza · buskamuza · commit a5f4f1ba32c7 · 2017-04-19T13:29:07.000-05:00
diff --git a/lib/internal/Magento/Framework/Pricing/Adjustment/Collection.php b/lib/internal/Magento/Framework/Pricing/Adjustment/Collection.php
@@ -8,6 +8,8 @@
 
 /**
  * Adjustment collection model
+ *
+ * @api
  */
 class Collection
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Adjustment/Pool.php b/lib/internal/Magento/Framework/Pricing/Adjustment/Pool.php
@@ -10,6 +10,8 @@
 
 /**
  * Global adjustment pool model
+ *
+ * @api
  */
 class Pool
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Amount/AmountFactory.php b/lib/internal/Magento/Framework/Pricing/Amount/AmountFactory.php
@@ -8,6 +8,8 @@
 
 /**
  * Class AmountFactory
+ *
+ * @api
  */
 class AmountFactory
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Helper/Data.php b/lib/internal/Magento/Framework/Pricing/Helper/Data.php
@@ -9,6 +9,8 @@
 
 /**
  * Pricing data helper
+ * 
+ * @api
  */
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php
@@ -14,6 +14,8 @@
 /**
  * Class AbstractPrice
  * Should be the base for creating any Price type class
+ *
+ * @api
  */
 abstract class AbstractPrice implements PriceInterface
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Price/Collection.php b/lib/internal/Magento/Framework/Pricing/Price/Collection.php
@@ -10,6 +10,8 @@
 
 /**
  * Class Collection
+ *
+ * @api
  */
 class Collection implements \Iterator
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Price/Pool.php b/lib/internal/Magento/Framework/Pricing/Price/Pool.php
@@ -8,6 +8,8 @@
 
 /**
  * Class Pool
+ *
+ * @api
  */
 class Pool implements \Iterator, \ArrayAccess
 {
diff --git a/lib/internal/Magento/Framework/Pricing/PriceComposite.php b/lib/internal/Magento/Framework/Pricing/PriceComposite.php
@@ -6,7 +6,6 @@
 
 namespace Magento\Framework\Pricing;
 
-use Magento\Framework\Pricing\SaleableInterface;
 use Magento\Framework\Pricing\Price\Factory as PriceFactory;
 use Magento\Framework\Pricing\Price\PriceInterface;
 
diff --git a/lib/internal/Magento/Framework/Pricing/PriceInfo/Base.php b/lib/internal/Magento/Framework/Pricing/PriceInfo/Base.php
@@ -15,6 +15,8 @@
 /**
  * Class Base
  * Price info base model
+ *
+ * @api
  */
 class Base implements PriceInfoInterface
 {
diff --git a/lib/internal/Magento/Framework/Pricing/PriceInfo/Factory.php b/lib/internal/Magento/Framework/Pricing/PriceInfo/Factory.php
@@ -14,6 +14,8 @@
 
 /**
  * Price info model factory
+ *
+ * @api
  */
 class Factory
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Render.php b/lib/internal/Magento/Framework/Pricing/Render.php
@@ -7,7 +7,6 @@
 namespace Magento\Framework\Pricing;
 
 use Magento\Framework\Pricing\Amount\AmountInterface;
-use Magento\Framework\Pricing\SaleableInterface;
 use Magento\Framework\Pricing\Price\PriceInterface;
 use Magento\Framework\Pricing\Render\Layout;
 use Magento\Framework\View\Element\AbstractBlock;
@@ -17,6 +16,8 @@
  * Base price render
  *
  * @method string getPriceRenderHandle()
+ *
+ * @api
  */
 class Render extends AbstractBlock
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php b/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php
@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Framework\Pricing\Render;
 
 use Magento\Framework\Pricing\Amount\AmountInterface;
@@ -15,6 +13,8 @@
 
 /**
  * RenderPool
+ *
+ * @api
  */
 class RendererPool extends AbstractBlock
 {
@@ -79,7 +79,8 @@ public function createPriceRender(
         $renderBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
         if (!$renderBlock instanceof PriceBoxRenderInterface) {
             throw new \InvalidArgumentException(
-                'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'
+                'Block "' . $renderClassName
+                . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'
             );
         }
         $renderBlock->setTemplate($this->getRenderBlockTemplate($type, $priceCode));
@@ -142,7 +143,8 @@ public function createAmountRender(
         $amountBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
         if (!$amountBlock instanceof AmountRenderInterface) {
             throw new \InvalidArgumentException(
-                'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'
+                'Block "' . $renderClassName
+                . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'
             );
         }
         $amountBlock->setTemplate($this->getAmountRenderBlockTemplate($type, $priceCode));
@@ -156,8 +158,8 @@ public function createAmountRender(
      */
     public function getAdjustmentRenders(SaleableInterface $saleableItem = null, PriceInterface $price = null)
     {
-        $itemType = is_null($saleableItem) ? 'default' : $saleableItem->getTypeId();
-        $priceType = is_null($price) ? 'default' : $price->getPriceCode();
+        $itemType = null == $saleableItem ? 'default' : $saleableItem->getTypeId();
+        $priceType = null == $price ? 'default' : $price->getPriceCode();
 
         $fallbackPattern = [
             "{$itemType}/adjustments/{$priceType}",

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Adjustment collection model`
	`11`	`+ *`
	`12`	`+ * @api`
`11`	`13`	`*/`
`12`	`14`	`class Collection`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Global adjustment pool model`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`class Pool`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Pricing data helper`
	`12`	`+ *`
	`13`	`+ * @api`
`12`	`14`	`*/`
`13`	`15`	`class Data extends \Magento\Framework\App\Helper\AbstractHelper`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`/**`
`15`	`15`	`* Class AbstractPrice`
`16`	`16`	`* Should be the base for creating any Price type class`
	`17`	`+ *`
	`18`	`+ * @api`
`17`	`19`	`*/`
`18`	`20`	`abstract class AbstractPrice implements PriceInterface`
`19`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`/**`
`16`	`16`	`* Class Base`
`17`	`17`	`* Price info base model`
	`18`	`+ *`
	`19`	`+ * @api`
`18`	`20`	`*/`
`19`	`21`	`class Base implements PriceInfoInterface`
`20`	`22`	`{`