OP-476 - Add phpStan

.github/workflows/build.yml

@@ -26,13 +26,12 @@ jobs:
  sylius: ["~1.12.0", "~1.13.0"]
  node: ["^18.0", "^20.0"]
  mysql: ["8.0"]
-
  exclude:
- - sylius: ^1.13
- php: 8.0
- - sylius: ^1.12
- php: 8.0
- symfony: ^6.4
+ - sylius: "~1.13.0"
+ php: "8.0"
+ - sylius: "~1.12.0"
+ php: "8.0"
+ symfony: "^6.4"
 
  env:
  APP_ENV: test

phpstan.neon

@@ -1,14 +1,28 @@
 parameters:
  reportUnmatchedIgnoredErrors: false
  checkMissingIterableValueType: false
+ checkGenericClassInNonGenericObjectType: false
 
  excludes_analyse:
  # Makes PHPStan crash
  - 'src/DependencyInjection/Configuration.php'
+ - 'src/Repository'
+ - 'src/Processor/AutomaticBlacklistingRulesProcessor.php'
+ - 'src/Factory/FraudSuspicionFactory.php'
 
  # Test dependencies
  - 'tests/Application/app/**.php'
  - 'tests/Application/src/**.php'
 
  ignoreErrors:
  - '/Parameter #1 \$configuration of method Symfony\\Component\\DependencyInjection\\Extension\\Extension::processConfiguration\(\) expects Symfony\\Component\\Config\\Definition\\ConfigurationInterface, Symfony\\Component\\Config\\Definition\\ConfigurationInterface\|null given\./'
+ - '/Parameter #1 \$customer of method BitBag\\SyliusBlacklistPlugin\\Model\\FraudSuspicionCommonModelInterface::setCustomer\(\) expects Sylius\\Component\\Customer\\Model\\CustomerInterface, Sylius\\Component\\Customer\\Model\\CustomerInterface\|null given\./'
+ - '/Parameter #1 \$customer of method BitBag\\SyliusBlacklistPlugin\\StateResolver\\CustomerStateResolverInterface::changeStateOnBlacklisted\(\) expects Sylius\\Component\\Customer\\Model\\CustomerInterface, Sylius\\Component\\Customer\\Model\\CustomerInterface\|null given\./'
+ - '#Access to an undefined property Symfony\\Component\\Validator\\Constraint::\$.+#'
+ - '#Call to an undefined method .+::[a-zA-Z]+\(\).#'
+ - '#Argument of an invalid type array\|null supplied for foreach, only iterables are supported.#'
+ - '#Cannot call method [a-zA-Z]+\(.*\) on .+\\?null#'
+ - '#Property .+::\$[a-zA-Z]+ is never read, only written.#'
+ - '#Call to an undefined method .+::[a-zA-Z]+\(\).#'
+
+

src/Checker/BlacklistingRule/Address/CompanyBlacklistingRuleChecker.php

@@ -22,7 +22,7 @@ class CompanyBlacklistingRuleChecker implements BlacklistingRuleCheckerInterface
 
  public function checkIfCustomerIsBlacklisted(QueryBuilder $builder, FraudSuspicionCommonModelInterface $fraudSuspicionCommonModel): void
  {
- if (!empty($fraudSuspicionCommonModel->getCompany())) {
+ if (null !== $fraudSuspicionCommonModel->getCompany() && '' !== $fraudSuspicionCommonModel->getCompany()) {
  $builder
  ->andWhere('o.company = :company')
  ->setParameter('company', $fraudSuspicionCommonModel->getCompany())

src/Checker/BlacklistingRule/Address/PhoneNumberBlacklistingRuleChecker.php

@@ -22,7 +22,8 @@ class PhoneNumberBlacklistingRuleChecker implements BlacklistingRuleCheckerInter
 
  public function checkIfCustomerIsBlacklisted(QueryBuilder $builder, FraudSuspicionCommonModelInterface $fraudSuspicionCommonModel): void
  {
- if (!empty($fraudSuspicionCommonModel->getPhoneNumber())) {
+ if (null !== $fraudSuspicionCommonModel->getPhoneNumber() &&
+ '' !== $fraudSuspicionCommonModel->getPhoneNumber()) {
  $builder
  ->andWhere('o.phoneNumber = :phoneNumber')
  ->setParameter('phoneNumber', $fraudSuspicionCommonModel->getPhoneNumber())

src/Checker/BlacklistingRule/Address/ProvinceBlacklistingRuleChecker.php

@@ -22,7 +22,7 @@ class ProvinceBlacklistingRuleChecker implements BlacklistingRuleCheckerInterfac
 
  public function checkIfCustomerIsBlacklisted(QueryBuilder $builder, FraudSuspicionCommonModelInterface $fraudSuspicionCommonModel): void
  {
- if (!empty($fraudSuspicionCommonModel->getProvince())) {
+ if (null !== $fraudSuspicionCommonModel->getProvince() && '' !== $fraudSuspicionCommonModel->getProvince()) {
  $builder
  ->andWhere('o.province = :province')
  ->setParameter('province', $fraudSuspicionCommonModel->getProvince())

src/Checker/BlacklistingRule/BlacklistingRuleEligibilityChecker.php

@@ -16,8 +16,12 @@
 
 final class BlacklistingRuleEligibilityChecker implements BlacklistingRuleEligibilityCheckerInterface
 {
- public function isEligible(BlacklistingRuleInterface $blacklistingRule, CustomerInterface $customer): bool
+ public function isEligible(BlacklistingRuleInterface $blacklistingRule, ?CustomerInterface $customer): bool
  {
+ if (null === $customer) {
+ return false;
+ }
+
  if ($blacklistingRule->isOnlyForGuests() && null !== $customer->getUser()) {
  return false;
  }

src/Checker/BlacklistingRule/BlacklistingRuleEligibilityCheckerInterface.php

@@ -16,5 +16,5 @@
 
 interface BlacklistingRuleEligibilityCheckerInterface
 {
- public function isEligible(BlacklistingRuleInterface $blacklistingRule, CustomerInterface $customer): bool;
+ public function isEligible(BlacklistingRuleInterface $blacklistingRule, ?CustomerInterface $customer): bool;
 }

src/Checker/BlacklistingRule/Customer/CustomerIpBlacklistingRuleChecker.php

@@ -22,7 +22,8 @@ class CustomerIpBlacklistingRuleChecker implements BlacklistingRuleCheckerInterf
 
  public function checkIfCustomerIsBlacklisted(QueryBuilder $builder, FraudSuspicionCommonModelInterface $fraudSuspicionCommonModel): void
  {
- if (!empty($fraudSuspicionCommonModel->getCustomerIp())) {
+ if (null !== $fraudSuspicionCommonModel->getCustomerIp() &&
+ '' !== $fraudSuspicionCommonModel->getCustomerIp()) {
  $builder
  ->andWhere('o.customerIp = :customerIp')
  ->setParameter('customerIp', $fraudSuspicionCommonModel->getCustomerIp())

src/DependencyInjection/Compiler/SyliusBehatPolyfillCompilerPass.php

@@ -24,7 +24,7 @@ final class SyliusBehatPolyfillCompilerPass implements CompilerPassInterface
 
  private const TEST = 'test';
 
- public function process(ContainerBuilder $container)
+ public function process(ContainerBuilder $container): void
  {
  /** @var string $environment */
  $environment = $container->getParameter(self::KERNEL_ENVIRONMENT_KEY);

src/Entity/FraudPrevention/AutomaticBlacklistingConfiguration.php

@@ -25,7 +25,7 @@ class AutomaticBlacklistingConfiguration implements AutomaticBlacklistingConfigu
  /** @var int|null */
  protected $id;
 
- /** @var string */
+ /** @var string|null */
  protected $name;
 
  /**
@@ -43,10 +43,10 @@ class AutomaticBlacklistingConfiguration implements AutomaticBlacklistingConfigu
  /** @var bool */
  protected $addFraudSuspicion = false;
 
- /** @var int */
+ /** @var int|null */
  protected $permittedFraudSuspicionsNumber;
 
- /** @var string */
+ /** @var string|null */
  protected $permittedFraudSuspicionsTime;
 
  public function __construct()

src/Entity/FraudPrevention/BlacklistingRule.php

@@ -26,13 +26,13 @@ class BlacklistingRule implements BlacklistingRuleInterface
  /** @var int|null */
  protected $id;
 
- /** @var string */
+ /** @var string|null */
  protected $name;
 
  /** @var array */
  protected $attributes = [];
 
- /** @var int */
+ /** @var int|null */
  protected $permittedStrikes;
 
  /** @var bool */
@@ -86,7 +86,7 @@ public function addAttribute(string $attribute): void
 
  public function removeAttribute(string $attribute): void
  {
- $index = array_search($attribute, $this->attributes);
+ $index = array_search($attribute, $this->attributes, true);
 
  if (false !== $index) {
  unset($this->attributes[$index]);

src/Entity/FraudPrevention/FraudSuspicion.php

@@ -31,28 +31,28 @@ class FraudSuspicion implements FraudSuspicionInterface
  /** @var string|null */
  protected $company;
 
- /** @var string */
+ /** @var string|null */
  protected $firstName;
 
- /** @var string */
+ /** @var string|null */
  protected $lastName;
 
- /** @var string */
+ /** @var string|null */
  protected $email;
 
- /** @var string */
+ /** @var string|null */
  protected $phoneNumber;
 
- /** @var string */
+ /** @var string|null */
  protected $street;
 
- /** @var string */
+ /** @var string|null */
  protected $city;
 
- /** @var string */
+ /** @var string|null */
  protected $province;
 
- /** @var string */
+ /** @var string|null */
  protected $country;
 
  /** @var string|null */
@@ -100,7 +100,7 @@ public function getCompany(): ?string
  return $this->company;
  }
 
- public function setCompany(?string $company)
+ public function setCompany(?string $company): void
  {
  $this->company = $company;
  }
@@ -110,7 +110,7 @@ public function getFirstName(): ?string
  return $this->firstName;
  }
 
- public function setFirstName(?string $firstName)
+ public function setFirstName(?string $firstName): void
  {
  $this->firstName = $firstName;
  }
@@ -120,7 +120,7 @@ public function getLastName(): ?string
  return $this->lastName;
  }
 
- public function setLastName(?string $lastName)
+ public function setLastName(?string $lastName): void
  {
  $this->lastName = $lastName;
  }
@@ -130,7 +130,7 @@ public function getEmail(): ?string
  return $this->email;
  }
 
- public function setEmail(?string $email)
+ public function setEmail(?string $email): void
  {
  $this->email = $email;
  }
@@ -140,7 +140,7 @@ public function getPhoneNumber(): ?string
  return $this->phoneNumber;
  }
 
- public function setPhoneNumber(?string $phoneNumber)
+ public function setPhoneNumber(?string $phoneNumber): void
  {
  $this->phoneNumber = $phoneNumber;
  }
@@ -150,7 +150,7 @@ public function getStreet(): ?string
  return $this->street;
  }
 
- public function setStreet(?string $street)
+ public function setStreet(?string $street): void
  {
  $this->street = $street;
  }
@@ -160,7 +160,7 @@ public function getCity(): ?string
  return $this->city;
  }
 
- public function setCity(?string $city)
+ public function setCity(?string $city): void
  {
  $this->city = $city;
  }
@@ -170,7 +170,7 @@ public function getProvince(): ?string
  return $this->province;
  }
 
- public function setProvince(?string $province)
+ public function setProvince(?string $province): void
  {
  $this->province = $province;
  }
@@ -180,7 +180,7 @@ public function getCountry(): ?string
  return $this->country;
  }
 
- public function setCountry(?string $country)
+ public function setCountry(?string $country): void
  {
  $this->country = $country;
  }
@@ -210,7 +210,7 @@ public function getAddressType(): ?string
  return $this->addressType;
  }
 
- public function setAddressType(string $addressType)
+ public function setAddressType(string $addressType): void
  {
  $this->addressType = $addressType;
  }

src/Entity/FraudPrevention/FraudSuspicionInterface.php

@@ -42,39 +42,39 @@ public function setCustomer(CustomerInterface $customer): void;
 
  public function getCompany(): ?string;
 
- public function setCompany(?string $company);
+ public function setCompany(?string $company): void;
 
  public function getFirstName(): ?string;
 
- public function setFirstName(?string $firstName);
+ public function setFirstName(?string $firstName): void;
 
  public function getLastName(): ?string;
 
- public function setLastName(?string $lastName);
+ public function setLastName(?string $lastName): void;
 
  public function getEmail(): ?string;
 
- public function setEmail(?string $email);
+ public function setEmail(?string $email): void;
 
  public function getPhoneNumber(): ?string;
 
- public function setPhoneNumber(?string $phoneNumber);
+ public function setPhoneNumber(?string $phoneNumber): void;
 
  public function getStreet(): ?string;
 
- public function setStreet(?string $street);
+ public function setStreet(?string $street): void;
 
  public function getCity(): ?string;
 
- public function setCity(?string $city);
+ public function setCity(?string $city): void;
 
  public function getProvince(): ?string;
 
- public function setProvince(?string $province);
+ public function setProvince(?string $province): void;
 
  public function getCountry(): ?string;
 
- public function setCountry(?string $country);
+ public function setCountry(?string $country): void;
 
  public function getPostcode(): ?string;
 
@@ -86,7 +86,7 @@ public function setCustomerIp(?string $customerIp): void;
 
  public function getAddressType(): ?string;
 
- public function setAddressType(string $addressType);
+ public function setAddressType(string $addressType): void;
 
  public function getComment(): ?string;
 

src/EntityListener/FraudSuspicionEntityListener.php

@@ -38,7 +38,7 @@ public function __construct(
  $this->fraudSuspicionCommonModelConverter = $fraudSuspicionCommonModelConverter;
  }
 
- public function prePersist(FraudSuspicionInterface $newFraudSuspicion, LifecycleEventArgs $event)
+ public function prePersist(FraudSuspicionInterface $newFraudSuspicion, LifecycleEventArgs $event): void
  {
  $fraudSuspicionCommonModel = $this->fraudSuspicionCommonModelConverter->convertFraudSuspicionObject($newFraudSuspicion);
 

src/Form/Type/AbstractConfigurableAutomaticBlacklistingConfigurationElementType.php

@@ -78,15 +78,17 @@ public function configureOptions(OptionsResolver $resolver): void
  ;
  }
 
- protected function addConfigurationFields(FormInterface $form, string $configurationType): void
+ protected function addConfigurationFields(FormInterface $form, ?string $configurationType): void
  {
  $form->add('settings', $configurationType, [
  'label' => false,
  ]);
  }
 
- protected function getRegistryIdentifier(FormInterface $form, $data = null): ?string
- {
+ protected function getRegistryIdentifier(
+ FormInterface $form,
+ AutomaticBlacklistingRuleInterface $data = null,
+ ): ?string {
  if ($data instanceof AutomaticBlacklistingRuleInterface && null !== $data->getType()) {
  return $data->getType();
  }

src/Form/Type/BlacklistingRuleType.php

@@ -25,7 +25,7 @@ final class BlacklistingRuleType extends AbstractResourceType
  /** @var array */
  private $attributeChoices;
 
- /* @var string */
+ /** @var string */
  private $customerGroupClass;
 
  public function __construct(