pamil / Sylius

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

Doc Comments +18 added lines

@@ -19,15 +19,33 @@
 {
     public const DEFAULT_ADMIN_ROLE = 'ROLE_ADMINISTRATION_ACCESS';
 
+    /**
+     * @return string
+     */
     public function getFirstName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setFirstName(?string $firstName): void;
 
+    /**
+     * @return string
+     */
     public function getLastName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLastName(?string $lastName): void;
 
+    /**
+     * @return string
+     */
     public function getLocaleCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLocaleCode(?string $code): void;
 }

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

Doc Comments +45 added lines

@@ -25,39 +25,84 @@
     CurrenciesAwareInterface,
     LocalesAwareInterface
 {
+    /**
+     * @return CurrencyInterface
+     */
     public function getBaseCurrency(): ?CurrencyInterface;
 
+    /**
+     * @return void
+     */
     public function setBaseCurrency(?CurrencyInterface $currency): void;
 
+    /**
+     * @return LocaleInterface
+     */
     public function getDefaultLocale(): ?LocaleInterface;
 
+    /**
+     * @return void
+     */
     public function setDefaultLocale(?LocaleInterface $locale): void;
 
+    /**
+     * @return ZoneInterface
+     */
     public function getDefaultTaxZone(): ?ZoneInterface;
 
+    /**
+     * @return void
+     */
     public function setDefaultTaxZone(?ZoneInterface $defaultTaxZone): void;
 
+    /**
+     * @return string
+     */
     public function getTaxCalculationStrategy(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTaxCalculationStrategy(?string $taxCalculationStrategy): void;
 
+    /**
+     * @return string
+     */
     public function getThemeName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setThemeName(?string $themeName): void;
 
+    /**
+     * @return string
+     */
     public function getContactEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setContactEmail(?string $contactEmail): void;
 
     public function isSkippingShippingStepAllowed(): bool;
 
+    /**
+     * @return void
+     */
     public function setSkippingShippingStepAllowed(bool $skippingShippingStepAllowed): void;
 
     public function isSkippingPaymentStepAllowed(): bool;
 
+    /**
+     * @return void
+     */
     public function setSkippingPaymentStepAllowed(bool $skippingPaymentStepAllowed): void;
 
     public function isAccountVerificationRequired(): bool;
 
+    /**
+     * @return void
+     */
     public function setAccountVerificationRequired(bool $accountVerificationRequired): void;
 }

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

Doc Comments +23 added lines

@@ -17,12 +17,26 @@ 
 
 interface ChannelPricingInterface extends ResourceInterface
 {
+    /**
+     * @return ProductVariantInterface
+     */
     public function getProductVariant(): ?ProductVariantInterface;
 
+    /**
+     * @return void
+     */
     public function setProductVariant(?ProductVariantInterface $productVariant): void;
 
+    /**
+     * @return integer
+     */
     public function getPrice(): ?int;
 
+    /**
+     * @param integer $price
+     *
+     * @return void
+     */
     public function setPrice(?int $price): void;
 
     /**
@@ -30,10 +44,19 @@ 
      */
     public function getChannelCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setChannelCode(?string $channelCode): void;
 
+    /**
+     * @return integer
+     */
     public function getOriginalPrice(): ?int;
 
+    /**
+     * @return void
+     */
     public function setOriginalPrice(?int $originalPrice): void;
 
     public function isPriceReduced(): bool;

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

Doc Comments +15 added lines

@@ -25,12 +25,26 @@ 
      */
     public function getOrders(): Collection;
 
+    /**
+     * @return AddressInterface
+     */
     public function getDefaultAddress(): ?AddressInterface;
 
+    /**
+     * @param AddressInterface $defaultAddress
+     *
+     * @return void
+     */
     public function setDefaultAddress(?AddressInterface $defaultAddress): void;
 
+    /**
+     * @return void
+     */
     public function addAddress(AddressInterface $address): void;
 
+    /**
+     * @return void
+     */
     public function removeAddress(AddressInterface $address): void;
 
     public function hasAddress(AddressInterface $address): bool;
@@ -49,6 +63,7 @@ 
 
     /**
      * @param ShopUserInterface|UserInterface|null $user
+     * @return void
      */
     public function setUser(?UserInterface $user);
 }

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

Doc Comments +18 added lines

@@ -22,16 +22,33 @@ 
      */
     public function getType(): ?string;
 
+    /**
+     * @return void
+     */
     public function setType(?string $type): void;
 
+    /**
+     * @return \SplFileInfo
+     */
     public function getFile(): ?\SplFileInfo;
 
+    /**
+     * @param \Symfony\Component\HttpFoundation\File\UploadedFile $file
+     *
+     * @return void
+     */
     public function setFile(?\SplFileInfo $file): void;
 
     public function hasFile(): bool;
 
+    /**
+     * @return string
+     */
     public function getPath(): ?string;
 
+    /**
+     * @return void
+     */
     public function setPath(?string $path): void;
 
     /**
@@ -41,6 +58,7 @@ 
 
     /**
      * @param object|null $owner
+     * @return void
      */
     public function setOwner($owner): void;
 }

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

Doc Comments +6 added lines

@@ -31,7 +31,13 @@
 
     public function hasImage(ImageInterface $image): bool;
 
+    /**
+     * @return void
+     */
     public function addImage(ImageInterface $image): void;
 
+    /**
+     * @return void
+     */
     public function removeImage(ImageInterface $image): void;
 }

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

Doc Comments +78 added lines

@@ -32,22 +32,51 @@ 
     CustomerAwareInterface,
     ChannelAwareInterface
 {
+    /**
+     * @return null|UserInterface
+     */
     public function getUser(): ?UserInterface;
 
+    /**
+     * @return AddressInterface
+     */
     public function getShippingAddress(): ?AddressInterface;
 
+    /**
+     * @return void
+     */
     public function setShippingAddress(?AddressInterface $address): void;
 
+    /**
+     * @return AddressInterface
+     */
     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 +98,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
+     */
     public function getCurrencyCode(): ?string;
 
+    /**
+     * @return void
+     */
     public function setCurrencyCode(?string $currencyCode): void;
 
+    /**
+     * @return string
+     */
     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 +163,26 @@ 
 
     public function getOrderPromotionTotal(): int;
 
+    /**
+     * @return string
+     */
     public function getTokenValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setTokenValue(?string $tokenValue): void;
 
+    /**
+     * @return string
+     */
     public function getCustomerIp(): ?string;
 
+    /**
+     * @param string|null $customerIp
+     *
+     * @return void
+     */
     public function setCustomerIp(?string $customerIp): void;
 
     /**

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

Doc Comments +16 added lines

@@ -19,16 +19,32 @@
 {
     public function getProduct(): ?ProductInterface;
 
+    /**
+     * @return ProductVariantInterface
+     */
     public function getVariant(): ?ProductVariantInterface;
 
+    /**
+     * @return void
+     */
     public function setVariant(?ProductVariantInterface $variant): void;
 
     public function getProductName(): ?string;
 
+    /**
+     * @param string $productName
+     *
+     * @return void
+     */
     public function setProductName(?string $productName): void;
 
     public function getVariantName(): ?string;
 
+    /**
+     * @param string $variantName
+     *
+     * @return void
+     */
     public function setVariantName(?string $variantName): void;
 
     public function getTaxTotal(): int;

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

Doc Comments +8 added lines

@@ -19,7 +19,15 @@
 
 interface PaymentMethodInterface extends BasePaymentMethodInterface, ChannelsAwareInterface
 {
+    /**
+     * @param GatewayConfigInterface $gateway
+     *
+     * @return void
+     */
     public function setGatewayConfig(?GatewayConfigInterface $gateway): void;
 
+    /**
+     * @return GatewayConfigInterface
+     */
     public function getGatewayConfig(): ?GatewayConfigInterface;
 }