pamil / Sylius

src/Sylius/Component/User/Model/UserInterface.php

Doc Comments +73 added lines

@@ -31,6 +31,9 @@ 
 
     public function getEmail(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmail(?string $email): void;
 
     /**
@@ -38,49 +41,110 @@ 
      */
     public function getEmailCanonical(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmailCanonical(?string $emailCanonical): void;
 
+    /**
+     * @return void
+     */
     public function setUsername(?string $username): void;
 
     /**
      * Gets normalized username (should be used in search and sort queries).
+     * @return string|null
      */
     public function getUsernameCanonical(): ?string;
 
+    /**
+     * @return void
+     */
     public function setUsernameCanonical(?string $usernameCanonical): void;
 
+    /**
+     * @return void
+     */
     public function setLocked(bool $locked): void;
 
+    /**
+     * @return string|null
+     */
     public function getEmailVerificationToken(): ?string;
 
+    /**
+     * @return void
+     */
     public function setEmailVerificationToken(?string $verificationToken): void;
 
+    /**
+     * @return string|null
+     */
     public function getPasswordResetToken(): ?string;
 
+    /**
+     * @param string|null $passwordResetToken
+     *
+     * @return void
+     */
     public function setPasswordResetToken(?string $passwordResetToken): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getPasswordRequestedAt(): ?\DateTimeInterface;
 
+    /**
+     * @param \DateTime|null $date
+     *
+     * @return void
+     */
     public function setPasswordRequestedAt(?\DateTimeInterface $date): void;
 
     public function isPasswordRequestNonExpired(\DateInterval $ttl): bool;
 
     public function isVerified(): bool;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getVerifiedAt(): ?\DateTimeInterface;
 
+    /**
+     * @param \DateTime|null $verifiedAt
+     *
+     * @return void
+     */
     public function setVerifiedAt(?\DateTimeInterface $verifiedAt): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getExpiresAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setExpiresAt(?\DateTimeInterface $date): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getCredentialsExpireAt(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setCredentialsExpireAt(?\DateTimeInterface $date): void;
 
+    /**
+     * @return \DateTimeInterface|null
+     */
     public function getLastLogin(): ?\DateTimeInterface;
 
+    /**
+     * @return void
+     */
     public function setLastLogin(?\DateTimeInterface $time): void;
 
     /**
@@ -93,8 +157,14 @@ 
      */
     public function hasRole(string $role): bool;
 
+    /**
+     * @return void
+     */
     public function addRole(string $role): void;
 
+    /**
+     * @return void
+     */
     public function removeRole(string $role): void;
 
     /**
@@ -104,5 +174,8 @@ 
 
     public function getOAuthAccount(string $provider): ?UserOAuthInterface;
 
+    /**
+     * @return void
+     */
     public function addOAuthAccount(UserOAuthInterface $oauth): void;
 }

src/Sylius/Component/User/Model/UserOAuthInterface.php

Doc Comments +32 added lines

@@ -17,19 +17,51 @@
 
 interface UserOAuthInterface extends UserAwareInterface, ResourceInterface
 {
+    /**
+     * @return string|null
+     */
     public function getProvider(): ?string;
 
+    /**
+     * @param string $provider
+     *
+     * @return void
+     */
     public function setProvider(?string $provider): void;
 
+    /**
+     * @return string|null
+     */
     public function getIdentifier(): ?string;
 
+    /**
+     * @param string $identifier
+     *
+     * @return void
+     */
     public function setIdentifier(?string $identifier): void;
 
+    /**
+     * @return string|null
+     */
     public function getAccessToken(): ?string;
 
+    /**
+     * @param string $accessToken
+     *
+     * @return void
+     */
     public function setAccessToken(?string $accessToken): void;
 
+    /**
+     * @return string|null
+     */
     public function getRefreshToken(): ?string;
 
+    /**
+     * @param null|string $refreshToken
+     *
+     * @return void
+     */
     public function setRefreshToken(?string $refreshToken): void;
 }

src/Sylius/Bundle/ResourceBundle/Form/Registry/FormTypeRegistryInterface.php

Doc Comments +6 added lines

@@ -15,8 +15,14 @@
 
 interface FormTypeRegistryInterface
 {
+    /**
+     * @return void
+     */
     public function add(string $identifier, string $typeIdentifier, string $formType): void;
 
+    /**
+     * @return string|null
+     */
     public function get(string $identifier, string $typeIdentifier): ?string;
 
     public function has(string $identifier, string $typeIdentifier): bool;

src/Sylius/Bundle/ResourceBundle/Validator/EnabledValidator.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         }
     }
 
+    /**
+     * @param ToggleableInterface $value
+     */
     private function ensureValueImplementsToggleableInterface($value): void
     {
         if (!($value instanceof ToggleableInterface)) {

src/Sylius/Behat/Page/Admin/Account/LoginPageInterface.php

Doc Comments +9 added lines

@@ -19,9 +19,18 @@
 {
     public function hasValidationErrorWith(string $message): bool;
 
+    /**
+     * @return void
+     */
     public function logIn(): void;
 
+    /**
+     * @return void
+     */
     public function specifyPassword(string $password): void;
 
+    /**
+     * @return void
+     */
     public function specifyUsername(string $username): void;
 }

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

Doc Comments +15 added lines

@@ -17,13 +17,28 @@
 
 interface CreatePageInterface extends BaseCreatePageInterface
 {
+    /**
+     * @return void
+     */
     public function enable(): void;
 
+    /**
+     * @return void
+     */
     public function specifyUsername(string $username): void;
 
+    /**
+     * @return void
+     */
     public function specifyEmail(string $email): void;
 
+    /**
+     * @return void
+     */
     public function specifyPassword(string $password): void;
 
+    /**
+     * @return void
+     */
     public function specifyLocale(string $localeCode): void;
 }

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

Doc Comments +12 added lines

@@ -17,11 +17,23 @@
 
 interface UpdatePageInterface extends BaseUpdatePageInterface
 {
+    /**
+     * @return void
+     */
     public function changeUsername(string $username): void;
 
+    /**
+     * @return void
+     */
     public function changeEmail(string $email): void;
 
+    /**
+     * @return void
+     */
     public function changePassword(string $password): void;
 
+    /**
+     * @return void
+     */
     public function changeLocale(string $localeCode): void;
 }

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

Doc Comments +48 added lines

@@ -17,35 +17,83 @@
 
 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;
 }

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

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
 
 interface IndexPageInterface extends BaseIndexPageInterface
 {
+    /**
+     * @return string
+     */
     public function getUsedThemeName(string $channelCode): ?string;
 }