(fix) (UMCS-426) Adjust phpDoc comments.

Ryouzanpaku · Ryouzanpaku · commit 51ffff334f9a · 2022-04-06T16:07:32.000+02:00
diff --git a/src/Resources/Basket.php b/src/Resources/Basket.php
@@ -34,21 +34,21 @@ class Basket extends AbstractUnzerResource
     /**
      * @var float $amountTotalGross
      *
-     * @deprecated 1.1.5.0 @see $totalValueGross.
+     * @deprecated since 1.1.5.0 @see $totalValueGross.
      */
     protected $amountTotalGross = 0.0;
 
     /**
      * @var float $amountTotalDiscount
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 @see Please set $amountDiscountPerUnitGross for each element of $basketItems instead.
      */
     protected $amountTotalDiscount = 0.0;
 
     /**
      * @var float $amountTotalVat
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0  Please set the $vat in percent for each element of $basketItems instead, if not already happened. The actual amount is not required anymore.
      */
     protected $amountTotalVat = 0.0;
 
@@ -70,7 +70,7 @@ class Basket extends AbstractUnzerResource
     /**
      * Basket constructor.
      *
-     * @deprecated 1.1.5.0 Please call constructor without parameters and use setter functions instead.
+     * @deprecated since 1.1.5.0 Please call constructor without parameters and use setter functions instead.
      *
      * @param float  $amountTotalGross
      * @param string $currencyCode
@@ -94,7 +94,7 @@ public function __construct(
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 @see $getTotalValueGross.
+     * @deprecated since 1.1.5.0 @see $getTotalValueGross.
      */
     public function getAmountTotalGross(): float
     {
@@ -104,7 +104,7 @@ public function getAmountTotalGross(): float
     /**
      * @param float $amountTotalGross
      *
-     * @deprecated 1.1.5.0 @see $getTotalValueGross.
+     * @deprecated since 1.1.5.0 @see $getTotalValueGross.
      *
      * @return Basket
      */
@@ -136,7 +136,7 @@ public function setTotalValueGross(float $totalValueGross): Basket
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountTotalDiscount(): float
     {
@@ -146,7 +146,7 @@ public function getAmountTotalDiscount(): float
     /**
      * @param float $amountTotalDiscount
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      *
      * @return Basket
      */
@@ -159,7 +159,7 @@ public function setAmountTotalDiscount(float $amountTotalDiscount): Basket
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountTotalVat(): float
     {
@@ -169,7 +169,7 @@ public function getAmountTotalVat(): float
     /**
      * @param float $amountTotalVat
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      *
      * @return Basket
      */
@@ -320,7 +320,7 @@ public function expose(): array
     /**
      * {@inheritDoc}
      */
-    public function getApiVersion() :string
+    public function getApiVersion(): string
     {
         if (!empty($this->getTotalValueGross())) {
             return 'v2';
diff --git a/src/Resources/EmbeddedResources/BasketItem.php b/src/Resources/EmbeddedResources/BasketItem.php
@@ -40,7 +40,7 @@ class BasketItem extends AbstractUnzerResource
     /**
      * @var float $amountDiscount
      *
-     * @deprecated 1.1.5.0 @see $amountDiscountPerUnitGross.
+     * @deprecated since 1.1.5.0 @see $amountDiscountPerUnitGross.
      */
     protected $amountDiscount = 0.0;
 
@@ -50,21 +50,21 @@ class BasketItem extends AbstractUnzerResource
     /**
      * @var float $amountGross
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     protected $amountGross = 0.0;
 
     /**
      * @var float $amountVat
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     protected $amountVat = 0.0;
 
     /**
      * @var float $amountPerUnit
      *
-     * @deprecated 1.1.5.0 @see amountPerUnitGross
+     * @deprecated since 1.1.5.0 @see amountPerUnitGross
      */
     protected $amountPerUnit = 0.0;
 
@@ -74,7 +74,7 @@ class BasketItem extends AbstractUnzerResource
     /**
      * @var float $amountNet
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     protected $amountNet = 0.0;
 
@@ -96,7 +96,7 @@ class BasketItem extends AbstractUnzerResource
     /**
      * BasketItem constructor.
      *
-     * @deprecated 1.1.5.0 Please call constructor without parameters and use setter functions instead.
+     * @deprecated since 1.1.5.0 Please call constructor without parameters and use setter functions instead.
      *
      * @param string $title
      * @param float  $amountNet
@@ -177,7 +177,7 @@ public function setVat(float $vat): BasketItem
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0  @see $getAmountDiscountPerUnitGross.
+     * @deprecated since 1.1.5.0  @see $getAmountDiscountPerUnitGross.
      */
     public function getAmountDiscount(): float
     {
@@ -187,7 +187,7 @@ public function getAmountDiscount(): float
     /**
      * @param float $amountDiscount
      *
-     * @deprecated 1.1.5.0  @see $setAmountDiscountPerUnitGross.
+     * @deprecated since 1.1.5.0  @see $setAmountDiscountPerUnitGross.
      *
      * @return BasketItem
      */
@@ -200,7 +200,7 @@ public function setAmountDiscount(float $amountDiscount): BasketItem
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountGross(): float
     {
@@ -210,7 +210,7 @@ public function getAmountGross(): float
     /**
      * @param float $amountGross
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      *
      * @return BasketItem
      */
@@ -261,7 +261,7 @@ public function setAmountPerUnitGross(float $amountPerUnitGross): BasketItem
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountVat(): float
     {
@@ -271,7 +271,7 @@ public function getAmountVat(): float
     /**
      * @param float $amountVat
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      *
      * @return BasketItem
      */
@@ -284,7 +284,7 @@ public function setAmountVat(float $amountVat): BasketItem
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountPerUnit(): float
     {
@@ -294,7 +294,7 @@ public function getAmountPerUnit(): float
     /**
      * @param float $amountPerUnit
      *
-     * @deprecated 1.1.5.0 @see setAmountPerUnitGross
+     * @deprecated since 1.1.5.0 @see setAmountPerUnitGross
      *
      * @return BasketItem
      */
@@ -307,7 +307,7 @@ public function setAmountPerUnit(float $amountPerUnit): BasketItem
     /**
      * @return float
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountNet(): float
     {
@@ -317,7 +317,7 @@ public function getAmountNet(): float
     /**
      * @param float $amountNet
      *
-     * @deprecated 1.1.5.0 Property is redundant and is no longer needed.
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      *
      * @return BasketItem
      */

Original file line number	Diff line number	Diff line change
`@@ -34,21 +34,21 @@ class Basket extends AbstractUnzerResource`
`34`	`34`	`/**`
`35`	`35`	`* @var float $amountTotalGross`
`36`	`36`	`*`
`37`		`- * @deprecated 1.1.5.0 @see $totalValueGross.`
	`37`	`+ * @deprecated since 1.1.5.0 @see $totalValueGross.`
`38`	`38`	`*/`
`39`	`39`	`protected $amountTotalGross = 0.0;`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* @var float $amountTotalDiscount`
`43`	`43`	`*`
`44`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`44`	`+ * @deprecated since 1.1.5.0 @see Please set $amountDiscountPerUnitGross for each element of $basketItems instead.`
`45`	`45`	`*/`
`46`	`46`	`protected $amountTotalDiscount = 0.0;`
`47`	`47`
`48`	`48`	`/**`
`49`	`49`	`* @var float $amountTotalVat`
`50`	`50`	`*`
`51`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`51`	`+ * @deprecated since 1.1.5.0 Please set the $vat in percent for each element of $basketItems instead, if not already happened. The actual amount is not required anymore.`
`52`	`52`	`*/`
`53`	`53`	`protected $amountTotalVat = 0.0;`
`54`	`54`
`@@ -70,7 +70,7 @@ class Basket extends AbstractUnzerResource`
`70`	`70`	`/**`
`71`	`71`	`* Basket constructor.`
`72`	`72`	`*`
`73`		`- * @deprecated 1.1.5.0 Please call constructor without parameters and use setter functions instead.`
	`73`	`+ * @deprecated since 1.1.5.0 Please call constructor without parameters and use setter functions instead.`
`74`	`74`	`*`
`75`	`75`	`* @param float $amountTotalGross`
`76`	`76`	`* @param string $currencyCode`
`@@ -94,7 +94,7 @@ public function __construct(`
`94`	`94`	`/**`
`95`	`95`	`* @return float`
`96`	`96`	`*`
`97`		`- * @deprecated 1.1.5.0 @see $getTotalValueGross.`
	`97`	`+ * @deprecated since 1.1.5.0 @see $getTotalValueGross.`
`98`	`98`	`*/`
`99`	`99`	`public function getAmountTotalGross(): float`
`100`	`100`	`{`
`@@ -104,7 +104,7 @@ public function getAmountTotalGross(): float`
`104`	`104`	`/**`
`105`	`105`	`* @param float $amountTotalGross`
`106`	`106`	`*`
`107`		`- * @deprecated 1.1.5.0 @see $getTotalValueGross.`
	`107`	`+ * @deprecated since 1.1.5.0 @see $getTotalValueGross.`
`108`	`108`	`*`
`109`	`109`	`* @return Basket`
`110`	`110`	`*/`
`@@ -136,7 +136,7 @@ public function setTotalValueGross(float $totalValueGross): Basket`
`136`	`136`	`/**`
`137`	`137`	`* @return float`
`138`	`138`	`*`
`139`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`139`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`140`	`140`	`*/`
`141`	`141`	`public function getAmountTotalDiscount(): float`
`142`	`142`	`{`
`@@ -146,7 +146,7 @@ public function getAmountTotalDiscount(): float`
`146`	`146`	`/**`
`147`	`147`	`* @param float $amountTotalDiscount`
`148`	`148`	`*`
`149`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`149`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`150`	`150`	`*`
`151`	`151`	`* @return Basket`
`152`	`152`	`*/`
`@@ -159,7 +159,7 @@ public function setAmountTotalDiscount(float $amountTotalDiscount): Basket`
`159`	`159`	`/**`
`160`	`160`	`* @return float`
`161`	`161`	`*`
`162`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`162`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`163`	`163`	`*/`
`164`	`164`	`public function getAmountTotalVat(): float`
`165`	`165`	`{`
`@@ -169,7 +169,7 @@ public function getAmountTotalVat(): float`
`169`	`169`	`/**`
`170`	`170`	`* @param float $amountTotalVat`
`171`	`171`	`*`
`172`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`172`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`173`	`173`	`*`
`174`	`174`	`* @return Basket`
`175`	`175`	`*/`
`@@ -320,7 +320,7 @@ public function expose(): array`
`320`	`320`	`/**`
`321`	`321`	`* {@inheritDoc}`
`322`	`322`	`*/`
`323`		`- public function getApiVersion() :string`
	`323`	`+ public function getApiVersion(): string`
`324`	`324`	`{`
`325`	`325`	`if (!empty($this->getTotalValueGross())) {`
`326`	`326`	`return 'v2';`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ class BasketItem extends AbstractUnzerResource`
`40`	`40`	`/**`
`41`	`41`	`* @var float $amountDiscount`
`42`	`42`	`*`
`43`		`- * @deprecated 1.1.5.0 @see $amountDiscountPerUnitGross.`
	`43`	`+ * @deprecated since 1.1.5.0 @see $amountDiscountPerUnitGross.`
`44`	`44`	`*/`
`45`	`45`	`protected $amountDiscount = 0.0;`
`46`	`46`
`@@ -50,21 +50,21 @@ class BasketItem extends AbstractUnzerResource`
`50`	`50`	`/**`
`51`	`51`	`* @var float $amountGross`
`52`	`52`	`*`
`53`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`53`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`54`	`54`	`*/`
`55`	`55`	`protected $amountGross = 0.0;`
`56`	`56`
`57`	`57`	`/**`
`58`	`58`	`* @var float $amountVat`
`59`	`59`	`*`
`60`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`60`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`61`	`61`	`*/`
`62`	`62`	`protected $amountVat = 0.0;`
`63`	`63`
`64`	`64`	`/**`
`65`	`65`	`* @var float $amountPerUnit`
`66`	`66`	`*`
`67`		`- * @deprecated 1.1.5.0 @see amountPerUnitGross`
	`67`	`+ * @deprecated since 1.1.5.0 @see amountPerUnitGross`
`68`	`68`	`*/`
`69`	`69`	`protected $amountPerUnit = 0.0;`
`70`	`70`
`@@ -74,7 +74,7 @@ class BasketItem extends AbstractUnzerResource`
`74`	`74`	`/**`
`75`	`75`	`* @var float $amountNet`
`76`	`76`	`*`
`77`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`77`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`78`	`78`	`*/`
`79`	`79`	`protected $amountNet = 0.0;`
`80`	`80`
`@@ -96,7 +96,7 @@ class BasketItem extends AbstractUnzerResource`
`96`	`96`	`/**`
`97`	`97`	`* BasketItem constructor.`
`98`	`98`	`*`
`99`		`- * @deprecated 1.1.5.0 Please call constructor without parameters and use setter functions instead.`
	`99`	`+ * @deprecated since 1.1.5.0 Please call constructor without parameters and use setter functions instead.`
`100`	`100`	`*`
`101`	`101`	`* @param string $title`
`102`	`102`	`* @param float $amountNet`
`@@ -177,7 +177,7 @@ public function setVat(float $vat): BasketItem`
`177`	`177`	`/**`
`178`	`178`	`* @return float`
`179`	`179`	`*`
`180`		`- * @deprecated 1.1.5.0 @see $getAmountDiscountPerUnitGross.`
	`180`	`+ * @deprecated since 1.1.5.0 @see $getAmountDiscountPerUnitGross.`
`181`	`181`	`*/`
`182`	`182`	`public function getAmountDiscount(): float`
`183`	`183`	`{`
`@@ -187,7 +187,7 @@ public function getAmountDiscount(): float`
`187`	`187`	`/**`
`188`	`188`	`* @param float $amountDiscount`
`189`	`189`	`*`
`190`		`- * @deprecated 1.1.5.0 @see $setAmountDiscountPerUnitGross.`
	`190`	`+ * @deprecated since 1.1.5.0 @see $setAmountDiscountPerUnitGross.`
`191`	`191`	`*`
`192`	`192`	`* @return BasketItem`
`193`	`193`	`*/`
`@@ -200,7 +200,7 @@ public function setAmountDiscount(float $amountDiscount): BasketItem`
`200`	`200`	`/**`
`201`	`201`	`* @return float`
`202`	`202`	`*`
`203`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`203`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`204`	`204`	`*/`
`205`	`205`	`public function getAmountGross(): float`
`206`	`206`	`{`
`@@ -210,7 +210,7 @@ public function getAmountGross(): float`
`210`	`210`	`/**`
`211`	`211`	`* @param float $amountGross`
`212`	`212`	`*`
`213`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`213`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`214`	`214`	`*`
`215`	`215`	`* @return BasketItem`
`216`	`216`	`*/`
`@@ -261,7 +261,7 @@ public function setAmountPerUnitGross(float $amountPerUnitGross): BasketItem`
`261`	`261`	`/**`
`262`	`262`	`* @return float`
`263`	`263`	`*`
`264`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`264`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`265`	`265`	`*/`
`266`	`266`	`public function getAmountVat(): float`
`267`	`267`	`{`
`@@ -271,7 +271,7 @@ public function getAmountVat(): float`
`271`	`271`	`/**`
`272`	`272`	`* @param float $amountVat`
`273`	`273`	`*`
`274`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`274`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`275`	`275`	`*`
`276`	`276`	`* @return BasketItem`
`277`	`277`	`*/`
`@@ -284,7 +284,7 @@ public function setAmountVat(float $amountVat): BasketItem`
`284`	`284`	`/**`
`285`	`285`	`* @return float`
`286`	`286`	`*`
`287`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`287`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`288`	`288`	`*/`
`289`	`289`	`public function getAmountPerUnit(): float`
`290`	`290`	`{`
`@@ -294,7 +294,7 @@ public function getAmountPerUnit(): float`
`294`	`294`	`/**`
`295`	`295`	`* @param float $amountPerUnit`
`296`	`296`	`*`
`297`		`- * @deprecated 1.1.5.0 @see setAmountPerUnitGross`
	`297`	`+ * @deprecated since 1.1.5.0 @see setAmountPerUnitGross`
`298`	`298`	`*`
`299`	`299`	`* @return BasketItem`
`300`	`300`	`*/`
`@@ -307,7 +307,7 @@ public function setAmountPerUnit(float $amountPerUnit): BasketItem`
`307`	`307`	`/**`
`308`	`308`	`* @return float`
`309`	`309`	`*`
`310`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`310`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`311`	`311`	`*/`
`312`	`312`	`public function getAmountNet(): float`
`313`	`313`	`{`
`@@ -317,7 +317,7 @@ public function getAmountNet(): float`
`317`	`317`	`/**`
`318`	`318`	`* @param float $amountNet`
`319`	`319`	`*`
`320`		`- * @deprecated 1.1.5.0 Property is redundant and is no longer needed.`
	`320`	`+ * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.`
`321`	`321`	`*`
`322`	`322`	`* @return BasketItem`
`323`	`323`	`*/`