pamil / Sylius

src/Sylius/Component/Core/Model/OrderInterface.php

Doc Comments +73 added lines

@@ -34,20 +34,46 @@ 
 {
     public function getUser(): ?UserInterface;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getShippingAddress(): ?AddressInterface;
 
+    /**
+     * @return void
+     */
     public function setShippingAddress(?AddressInterface $address): void;
 
+    /**
+     * @return AddressInterface|null
+     */
     public function getBillingAddress(): ?AddressInterface;
 
+    /**
+     * @param AddressInterface $address
+     *
+     * @return void
+     */
     public function setBillingAddress(?AddressInterface $address): void;
 
+    /**
+     * @return string
+     */
     public function getCheckoutState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCheckoutState(?string $checkoutState): void;
 
+    /**
+     * @return string
+     */
     public function getPaymentState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPaymentState(?string $paymentState): void;
 
     /**
@@ -69,28 +95,63 @@ 
 
     public function hasShipments(): bool;
 
+    /**
+     * @return void
+     */
     public function addShipment(ShipmentInterface $shipment): void;
 
+    /**
+     * @return void
+     */
     public function removeShipment(ShipmentInterface $shipment): void;
 
+    /**
+     * @return void
+     */
     public function removeShipments(): void;
 
     public function hasShipment(ShipmentInterface $shipment): bool;
 
+    /**
+     * @return string|null
+     */
     public function getCurrencyCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCurrencyCode(?string $currencyCode): void;
 
+    /**
+     * @return string|null
+     */
     public function getLocaleCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLocaleCode(?string $localeCode): void;
 
+    /**
+     * @param PromotionCouponInterface $coupon
+     *
+     * @return void
+     */
     public function setPromotionCoupon(?BaseCouponInterface $coupon): void;
 
+    /**
+     * @return string
+     */
     public function getShippingState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setShippingState(?string $state): void;
 
+    /**
+     * @return PaymentInterface
+     */
     public function getLastPayment(?string $state = null): ?PaymentInterface;
 
     public function getTaxTotal(): int;
@@ -99,12 +160,24 @@ 
 
     public function getOrderPromotionTotal(): int;
 
+    /**
+     * @return string|null
+     */
     public function getTokenValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTokenValue(?string $tokenValue): void;
 
+    /**
+     * @return string|null
+     */
     public function getCustomerIp(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCustomerIp(?string $customerIp): void;
 
     /**

src/Sylius/Component/Product/Model/ProductOptionValueInterface.php

Doc Comments +12 added lines

@@ -20,16 +20,28 @@
 
 interface ProductOptionValueInterface extends ResourceInterface, CodeAwareInterface, TranslatableInterface
 {
+    /**
+     * @return ProductOptionInterface|null
+     */
     public function getOption(): ?ProductOptionInterface;
 
+    /**
+     * @return void
+     */
     public function setOption(?ProductOptionInterface $option): void;
 
     public function getValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setValue(?string $value): void;
 
     public function getOptionCode(): ?string;
 
+    /**
+     * @return string
+     */
     public function getName(): ?string;
 
     /**

src/Sylius/Component/Promotion/Model/PromotionCouponAwarePromotionSubjectInterface.php

Doc Comments +3 added lines

@@ -15,5 +15,8 @@
 
 interface PromotionCouponAwarePromotionSubjectInterface extends PromotionSubjectInterface
 {
+    /**
+     * @return PromotionCouponInterface|null
+     */
     public function getPromotionCoupon(): ?PromotionCouponInterface;
 }

src/Sylius/Component/Shipping/Model/ShipmentInterface.php

Doc Comments +24 added lines

@@ -27,12 +27,24 @@ 
 
     public const STATE_CANCELLED = 'cancelled';
 
+    /**
+     * @return string
+     */
     public function getState(): ?string;
 
+    /**
+     * @return void
+     */
     public function setState(?string $state): void;
 
+    /**
+     * @return ShippingMethodInterface|null
+     */
     public function getMethod(): ?ShippingMethodInterface;
 
+    /**
+     * @return void
+     */
     public function setMethod(?ShippingMethodInterface $method): void;
 
     /**
@@ -40,14 +52,26 @@ 
      */
     public function getUnits(): Collection;
 
+    /**
+     * @return void
+     */
     public function addUnit(ShipmentUnitInterface $unit): void;
 
+    /**
+     * @return void
+     */
     public function removeUnit(ShipmentUnitInterface $unit): void;
 
     public function hasUnit(ShipmentUnitInterface $unit): bool;
 
+    /**
+     * @return string|null
+     */
     public function getTracking(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTracking(?string $tracking): void;
 
     public function isTracked(): bool;

src/Sylius/Component/Core/OrderProcessing/OrderShipmentProcessor.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 namespace Sylius\Component\Core\OrderProcessing;
 
 use Sylius\Component\Core\Model\OrderInterface;
-use Sylius\Component\Core\Model\OrderItemUnitInterface;
 use Sylius\Component\Core\Model\ShipmentInterface;
 use Sylius\Component\Order\Model\OrderInterface as BaseOrderInterface;
 use Sylius\Component\Order\Processor\OrderProcessorInterface;

etc/psalm/ZendPriorityQueueStub.php

Doc Comments +4 added lines, -4 removed lines

@@ -41,14 +41,14 @@ 
     /**
      * @param mixed $datum
      *
-     * @return bool False if the item was not found, true otherwise.
+     * @return boolean|null False if the item was not found, true otherwise.
      *
      * @psalm-param T $datum
      */
     public function remove($datum) { }
 
     /**
-     * @return bool
+     * @return boolean|null
      */
     public function isEmpty() { }
 
@@ -105,7 +105,7 @@ 
     /**
      * @param mixed $datum
      *
-     * @return bool
+     * @return boolean|null
      *
      * @psalm-param T $datum
      */
@@ -114,7 +114,7 @@ 
     /**
      * @param int $priority
      *
-     * @return bool
+     * @return boolean|null
      */
     public function hasPriority($priority) { }
 

Braces +42 added lines, -14 removed lines

@@ -36,7 +36,9 @@ 
      * @psalm-param T $data
      * @psalm-return PriorityQueue<T>
      */
-    public function insert($data, $priority = 1) { }
+    public function insert($data, $priority = 1)
+    {
+}
 
     /**
      * @param mixed $datum
@@ -45,53 +47,71 @@ 
      *
      * @psalm-param T $datum
      */
-    public function remove($datum) { }
+    public function remove($datum)
+    {
+}
 
     /**
      * @return bool
      */
-    public function isEmpty() { }
+    public function isEmpty()
+    {
+}
 
     /**
      * @return int
      */
-    public function count() { }
+    public function count()
+    {
+}
 
     /**
      * @return mixed
      */
-    public function top() { }
+    public function top()
+    {
+}
 
     /**
      * @return mixed
      */
-    public function extract() { }
+    public function extract()
+    {
+}
 
     /**
      * @return SplPriorityQueue
      *
      * @psalm-return SplPriorityQueue<T>
      */
-    public function getIterator() { }
+    public function getIterator()
+    {
+}
 
     /**
      * @return string
      */
-    public function serialize() { }
+    public function serialize()
+    {
+}
 
     /**
      * @param string $data
      *
      * @return void
      */
-    public function unserialize($data) { }
+    public function unserialize($data)
+    {
+}
 
     /**
      * @param int $flag
      *
      * @return array
      */
-    public function toArray($flag = self::EXTR_DATA) { }
+    public function toArray($flag = self::EXTR_DATA)
+    {
+}
 
     /**
      * @param string $class
@@ -100,7 +120,9 @@ 
      *
      * @psalm-return PriorityQueue<T>
      */
-    public function setInternalQueueClass($class) { }
+    public function setInternalQueueClass($class)
+    {
+}
 
     /**
      * @param mixed $datum
@@ -109,17 +131,23 @@ 
      *
      * @psalm-param T $datum
      */
-    public function contains($datum) { }
+    public function contains($datum)
+    {
+}
 
     /**
      * @param int $priority
      *
      * @return bool
      */
-    public function hasPriority($priority) { }
+    public function hasPriority($priority)
+    {
+}
 
     /**
      * @return void
      */
-    public function __clone() { }
+    public function __clone()
+    {
+}
 }

src/Sylius/Behat/Context/Setup/PromotionContext.php

Doc Comments +5 added lines

@@ -400,6 +400,7 @@ 
 
     /**
      * @Given /^([^"]+) gives ("[^"]+%") discount on shipping to every order$/
+     * @param integer $discount
      */
     public function itGivesPercentageDiscountOnShippingToEveryOrder(PromotionInterface $promotion, $discount)
     {
@@ -725,6 +726,7 @@ 
 
     /**
      * @Given /^([^"]+) gives ("[^"]+%") discount on shipping to every order over ("(?:€|£|\$)[^"]+")$/
+     * @param integer $discount
      */
     public function itGivesDiscountOnShippingToEveryOrderOver(
         PromotionInterface $promotion,
@@ -899,6 +901,9 @@ 
         return $coupon;
     }
 
+    /**
+     * @param string $prefix
+     */
     private function generateCoupons(
         int $amount,
         PromotionInterface $promotion,

src/Sylius/Behat/Page/Admin/PromotionCoupon/GeneratePageInterface.php

Doc Comments +21 added lines

@@ -23,17 +23,38 @@
 
     public function checkGenerationValidation(string $message): bool;
 
+    /**
+     * @return void
+     */
     public function generate(): void;
 
+    /**
+     * @return void
+     */
     public function specifyAmount(?int $amount): void;
 
+    /**
+     * @return void
+     */
     public function specifyCodeLength(?int $codeLength): void;
 
+    /**
+     * @return void
+     */
     public function setExpiresAt(\DateTimeInterface $date): void;
 
+    /**
+     * @return void
+     */
     public function setUsageLimit(int $limit): void;
 
+    /**
+     * @return void
+     */
     public function specifyPrefix(string $prefix): void;
 
+    /**
+     * @return void
+     */
     public function specifySuffix(string $suffix): void;
 }

src/Sylius/Behat/Page/Admin/Channel/CreatePageInterface.php

Doc Comments +51 added lines

@@ -17,37 +17,88 @@
 
 interface CreatePageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
+    /**
+     * @return void
+     */
     public function nameIt(string $name): void;
 
+    /**
+     * @return void
+     */
     public function specifyCode(string $code): void;
 
+    /**
+     * @return void
+     */
     public function describeItAs(string $description): void;
 
+    /**
+     * @return void
+     */
     public function setHostname(string $hostname): void;
 
+    /**
+     * @return void
+     */
     public function setContactEmail(string $contactEmail): void;
 
+    /**
+     * @return void
+     */
     public function defineColor(string $color): void;
 
+    /**
+     * @return void
+     */
     public function chooseLocale(string $language): void;
 
+    /**
+     * @return void
+     */
     public function chooseCurrency(string $currencyCode): void;
 
+    /**
+     * @return void
+     */
     public function chooseDefaultTaxZone(string $taxZone): void;
 
+    /**
+     * @return void
+     */
     public function chooseDefaultLocale(?string $locale): void;
 
+    /**
+     * @return void
+     */
     public function chooseBaseCurrency(?string $currency): void;
 
+    /**
+     * @return void
+     */
     public function chooseTaxCalculationStrategy(string $taxCalculationStrategy): void;
 
+    /**
+     * @return void
+     */
     public function allowToSkipShippingStep(): void;
 
+    /**
+     * @return void
+     */
     public function allowToSkipPaymentStep(): void;
 
+    /**
+     * @return void
+     */
     public function setType(string $type): void;
 }