README.md

Subscribe Pro Magento 2 Integration Extension

This is the official Magento 2 extension for Subscribe Pro.

To learn more about Subscribe Pro you can visit us at https://www.subscribepro.com/.

Getting Started

Please visit our documentation website and start with our step by step integration guide for Magento 2: https://docs.subscribepro.com/display/spd/Install+Subscribe+Pro+for+Magento+2

Installation via Composer

You can install our Subscribe Pro Magento 2 extension via Composer. Please run these commands at the root of your Magento install:

composer require subscribepro/subscribepro-magento2-ext
php bin/magento module:enable Swarming_SubscribePro
php bin/magento setup:upgrade

Coding Standards

Subscribe Pro team follows the standards described in https://devdocs.magento.com

• https://devdocs.magento.com/guides/v2.4/coding-standards/bk-coding-standards.html - this document's purpose is to explain how the code should be formatted and the main idea for PHP developers is "use codesniffer". Helpful and concise instructions on how to set it up are provided. The rules imposed by codesniffer are based on PSR12 standard (see https://www.php-fig.org/psr/psr-1/ https://www.php-fig.org/psr/psr-2/ https://www.php-fig.org/psr/psr-12/) and are arguably too numerous for humans to remember and consistently apply, so official Magento team does not provide a human-readable description anyway
• https://devdocs.magento.com/guides/v2.4/coding-standards/technical-guidelines.html - this document describes semantic requirements and best coding practices
• https://devdocs.magento.com/guides/v2.4/coding-standards/code-standard-javascript.html - JS coding standard
• https://devdocs.magento.com/guides/v2.4/coding-standards/code-standard-less.html - less coding standard
• https://devdocs.magento.com/guides/v2.4/coding-standards/code-standard-html.html - HTML coding standard

Subscribe Pro's internal coding standards

• Use fully-qualified class names in PHPDoc, e.g.,

  /**
   * @param \Magento\Framework\App\RequestInterface $request
   * @return bool
   */
  

  This is expected to make the code more clear when skimming through, leaves less ambiguity when dealing with classes that are named similarly but belong to different namespaces, in IDE there is no need to ctrl+click twice to actually see the class if an alias is used. This also eradicates the situations when an unnecessary use operator is included only for the sake of writing a phpdoc/comment.
• No space after type cast, e.g.,

  (int)$variable
  

  None of the existing PHP standards stipulates this at the moment of writing, so "no space" was elected.

To confirm project is compliant with standards PHP_CodeSniffer (phpcs)

Run PHP_CodeSniffer:

vendor/bin/phpcs -s \
  --standard=Magento2 app/code/Swarming/SubscribePro \
  --extensions=phtml \
  --error-severity=10 \
  --ignore-annotations \
  --exclude=Magento2.Annotation.MethodAnnotationStructure \
  app/code/Swarming/SubscribePro

To automatically fix certain issues with PHP Code Beautifier and Fixer:

bin/phpcbf --standard=Magento2 \
  --extensions=phtml \
  --error-severity=10 \
  --ignore-annotations \
  --exclude=Magento2.Annotation.MethodAnnotationStructure \
  app/code/Swarming/SubscribePro

Run phpstan

bin/analyse app/code/Swarming/SubscribePro --level=1 -c app/code/Swarming/SubscribePro/phpstan.neon

Run PHP Coding Standards Fixer (php-cs-fixer)

php-cs-fixer fix src/app/code/Swarming/SubscribePro