pamil / Sylius

src/Sylius/Behat/Page/Admin/Taxon/UpdatePageInterface.php

Doc Comments +37 added lines

@@ -19,18 +19,31 @@ 
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function describeItAs(string $description, string $languageCode): void;
 
+    /**
+     * @return void
+     */
     public function chooseParent(TaxonInterface $taxon): void;
 
     public function isCodeDisabled(): bool;
 
+    /**
+     * @return void
+     */
     public function nameIt(string $name, string $languageCode): void;
 
+    /**
+     * @return void
+     */
     public function specifySlug(string $slug, string $languageCode): void;
 
     /**
      * @param string $type
+     * @return void
      */
     public function attachImage(string $path, string $type = null): void;
 
@@ -38,16 +51,31 @@ 
 
     public function isSlugReadonly(string $languageCode = 'en_US'): bool;
 
+    /**
+     * @return void
+     */
     public function removeImageWithType(string $type): void;
 
+    /**
+     * @return void
+     */
     public function removeFirstImage(): void;
 
+    /**
+     * @return void
+     */
     public function enableSlugModification(string $languageCode = 'en_US'): void;
 
     public function countImages(): int;
 
+    /**
+     * @return void
+     */
     public function changeImageWithType(string $type, string $path): void;
 
+    /**
+     * @return void
+     */
     public function modifyFirstImageType(string $type): void;
 
     public function getParent(): string;
@@ -64,10 +92,19 @@ 
      */
     public function getValidationMessageForImageAtPlace(int $place): string;
 
+    /**
+     * @return void
+     */
     public function activateLanguageTab(string $locale): void;
 
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function disable(): void;
 
     public function isEnabled(): bool;

src/Sylius/Bundle/AdminBundle/Controller/DashboardController.php

Doc Comments +3 added lines

@@ -88,6 +88,9 @@
         );
     }
 
+    /**
+     * @return ChannelInterface
+     */
     private function findChannelByCodeOrFindFirst(?string $channelCode): ?ChannelInterface
     {
         if (null !== $channelCode) {

src/Sylius/Bundle/ApiBundle/Command/OrderTokenValueAwareInterface.php

Doc Comments +6 added lines

@@ -16,7 +16,13 @@
 /** @experimental */
 interface OrderTokenValueAwareInterface extends CommandAwareDataTransformerInterface
 {
+    /**
+     * @return string|null
+     */
     public function getOrderTokenValue(): ?string;
 
+    /**
+     * @return void
+     */
     public function setOrderTokenValue(?string $orderTokenValue): void;
 }

src/Sylius/Bundle/ApiBundle/Command/ShopUserIdAwareInterface.php

Doc Comments +3 added lines

@@ -9,5 +9,8 @@
 {
     public function getShopUserId();
 
+    /**
+     * @return void
+     */
     public function setShopUserId($shopUserId): void;
 }

src/Sylius/Bundle/ApiBundle/Command/SubresourceIdAwareInterface.php

Doc Comments +6 added lines

@@ -16,8 +16,14 @@
 /** @experimental */
 interface SubresourceIdAwareInterface extends CommandAwareDataTransformerInterface
 {
+    /**
+     * @return string
+     */
     public function getSubresourceId(): ?string;
 
+    /**
+     * @return void
+     */
     public function setSubresourceId(?string $subresourceId): void;
 
     public function getSubresourceIdAttributeKey(): string;

src/Sylius/Bundle/ApiBundle/Context/UserContextInterface.php

Doc Comments +3 added lines

@@ -18,5 +18,8 @@
 /** @experimental */
 interface UserContextInterface
 {
+    /**
+     * @return null|UserInterface
+     */
     public function getUser(): ?UserInterface;
 }

src/Sylius/Bundle/CoreBundle/Fixture/OptionsResolver/LazyOption.php

Doc Comments +2 added lines, -2 removed lines

@@ -123,7 +123,7 @@ 
     public static function findOneBy(RepositoryInterface $repository, string $field, array $criteria = []): \Closure
     {
         return
-            /** @param mixed $previousValue */
+            /** @param string $previousValue */
             function (Options $options, $previousValue) use ($repository, $field, $criteria): ?object {
                 if (null === $previousValue || [] === $previousValue) {
                     return null;
@@ -141,7 +141,7 @@ 
     public static function getOneBy(RepositoryInterface $repository, string $field, array $criteria = []): \Closure
     {
         return
-            /** @param mixed $previousValue */
+            /** @param string $previousValue */
             function (Options $options, $previousValue) use ($repository, $field, $criteria): ?object {
                 if (null === $previousValue || [] === $previousValue) {
                     return null;

src/Sylius/Component/Channel/Context/ChannelNotFoundException.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 
 class ChannelNotFoundException extends \RuntimeException
 {
+    /**
+     * @param \UnexpectedValueException $previousException
+     */
     public function __construct($messageOrPreviousException = null, ?\Throwable $previousException = null)
     {
         $message = 'Channel could not be found! Tip: You can use the Web Debug Toolbar to switch between channels in development.';

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

Doc Comments +69 added lines

@@ -27,52 +27,115 @@ 
     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;
 
+    /**
+     * @return string|null
+     */
     public function getContactPhoneNumber(): ?string;
 
+    /**
+     * @return void
+     */
     public function setContactPhoneNumber(?string $contactPhoneNumber): 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;
 
+    /**
+     * @return ShopBillingDataInterface|null
+     */
     public function getShopBillingData(): ?ShopBillingDataInterface;
 
+    /**
+     * @return void
+     */
     public function setShopBillingData(ShopBillingDataInterface $shopBillingData): void;
 
+    /**
+     * @return TaxonInterface|null
+     */
     public function getMenuTaxon(): ?TaxonInterface;
 
+    /**
+     * @return void
+     */
     public function setMenuTaxon(?TaxonInterface $menuTaxon): void;
 
     /**
@@ -82,8 +145,14 @@ 
      */
     public function getCountries(): Collection;
 
+    /**
+     * @return void
+     */
     public function addCountry(CountryInterface $country): void;
 
+    /**
+     * @return void
+     */
     public function removeCountry(CountryInterface $country): void;
 
     public function hasCountry(CountryInterface $country): bool;