Merge branch 'netz98:develop' into phpstan-l1

netz98 · Jul 20, 2024 · df4c893 · df4c893
2 parents e953305 + 5236884
commit df4c893
Show file tree

Hide file tree

Showing 218 changed files with 1,266 additions and 351 deletions.
diff --git a/.gitignore b/.gitignore
@@ -25,3 +25,5 @@ act.secrets
 # Local Magento src
 /magento
 
+# phpDocumentor
+/docs/
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+        configVersion="3"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="https://www.phpdoc.org"
+        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd"
+>
+    <setting name="template.color" value="blue"/>
+    <paths>
+        <output>docs/api</output>
+        <cache>docs/cache</cache>
+    </paths>
+    <version number="3.0.0">
+        <api>
+            <source dsn=".">
+                <path>src</path>
+            </source>
+        </api>
+    </version>
+</phpdocumentor>
diff --git a/readme.rst b/readme.rst
@@ -92,7 +92,7 @@ The command should execute successfully and show you the version number of N98-M
 
 .. code-block:: sh
 
-    n98-magerun version 1.97.0 by netz98 new media GmbH
+    n98-magerun version 2.3.0 by valantic CEC
 
 You now have successfully installed Magerun! You can tailor the installation further like installing it system-wide and
 enable autocomplete - read on for more information about these and other features.

diff --git a/src/N98/Magento/Application.php b/src/N98/Magento/Application.php
@@ -29,6 +29,11 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use UnexpectedValueException;
 
+/**
+ * Class Application
+ *
+ * @package N98\Magento
+ */
 class Application extends BaseApplication
 {
     /**
@@ -480,7 +485,7 @@ public function getHelp()
 
     public function getLongVersion()
     {
-        return parent::getLongVersion() . ' by <info>netz98 GmbH</info>';
+        return parent::getLongVersion() . ' by <info>valantic CEC</info>';
     }
 
     /**

diff --git a/src/N98/Magento/Command/AbstractMagentoStoreConfigCommand.php b/src/N98/Magento/Command/AbstractMagentoStoreConfigCommand.php
@@ -16,6 +16,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Class AbstractMagentoStoreConfigCommand
+ *
+ * @package N98\Magento\Command
+ */
 abstract class AbstractMagentoStoreConfigCommand extends AbstractMagentoCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Admin/DisableNotificationsCommand.php b/src/N98/Magento/Command/Admin/DisableNotificationsCommand.php
@@ -4,6 +4,11 @@
 
 use N98\Magento\Command\AbstractMagentoStoreConfigCommand;
 
+/**
+ * Toggle admin notification command
+ *
+ * @package N98\Magento\Command\Admin
+ */
 class DisableNotificationsCommand extends AbstractMagentoStoreConfigCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Admin/User/AbstractAdminUserCommand.php b/src/N98/Magento/Command/Admin/User/AbstractAdminUserCommand.php
@@ -4,6 +4,11 @@
 
 use N98\Magento\Command\AbstractMagentoCommand;
 
+/**
+ * Class AbstractAdminUserCommand
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 abstract class AbstractAdminUserCommand extends AbstractMagentoCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Admin/User/ChangePasswordCommand.php b/src/N98/Magento/Command/Admin/User/ChangePasswordCommand.php
@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Change admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class ChangePasswordCommand extends AbstractAdminUserCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Admin/User/ChangeStatusCommand.php b/src/N98/Magento/Command/Admin/User/ChangeStatusCommand.php
@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Change admin user status command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class ChangeStatusCommand extends AbstractAdminUserCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Admin/User/CreateUserCommand.php b/src/N98/Magento/Command/Admin/User/CreateUserCommand.php
@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Create admin user command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class CreateUserCommand extends AbstractAdminUserCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Admin/User/DeleteUserCommand.php b/src/N98/Magento/Command/Admin/User/DeleteUserCommand.php
@@ -11,7 +11,9 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
 /**
- * Class DeleteUserCommand
+ * Delete admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
  */
 class DeleteUserCommand extends AbstractAdminUserCommand
 {

diff --git a/src/N98/Magento/Command/Admin/User/ListCommand.php b/src/N98/Magento/Command/Admin/User/ListCommand.php
@@ -6,6 +6,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * List admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class ListCommand extends AbstractAdminUserCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Admin/User/LockCommand.php b/src/N98/Magento/Command/Admin/User/LockCommand.php
@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Lock admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class LockCommand extends AbstractAdminUserCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Admin/User/LockdownCommand.php b/src/N98/Magento/Command/Admin/User/LockdownCommand.php
@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
+/**
+ * Lockdown admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class LockdownCommand extends LockCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Admin/User/UnlockCommand.php b/src/N98/Magento/Command/Admin/User/UnlockCommand.php
@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
+/**
+ * Unlock admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class UnlockCommand extends AbstractAdminUserCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Cache/AbstractCacheCommand.php b/src/N98/Magento/Command/Cache/AbstractCacheCommand.php
@@ -9,6 +9,11 @@
 use N98\Magento\Command\AbstractMagentoCommand;
 use RuntimeException;
 
+/**
+ * Class AbstractCacheCommand
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class AbstractCacheCommand extends AbstractMagentoCommand
 {
     /**

diff --git a/src/N98/Magento/Command/Cache/CleanCommand.php b/src/N98/Magento/Command/Cache/CleanCommand.php
@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Clean cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class CleanCommand extends AbstractCacheCommand
 {
     protected function configure()
@@ -30,8 +35,14 @@ protected function configure()
             )
             ->setDescription('Clean magento cache')
         ;
+    }
 
-        $help = <<<HELP
+    /**
+     * {@inheritdoc}
+     */
+    public function getHelp(): string
+    {
+        return <<<HELP
 Cleans expired cache entries.
 
 If you would like to clean only one cache type use like:
@@ -48,7 +59,6 @@ protected function configure()
     --reinit Reinitialise the config cache after cleaning (Default)
     --no-reinit Don't reinitialise the config cache after cleaning
 HELP;
-        $this->setHelp($help);
     }
 
     /**

diff --git a/src/N98/Magento/Command/Cache/Dir/FlushCommand.php b/src/N98/Magento/Command/Cache/Dir/FlushCommand.php
@@ -1,9 +1,4 @@
 <?php
-/**
- * this file is part of magerun
- *
- * @author Tom Klingenberg <https://github.com/ktomk>
- */
 
 namespace N98\Magento\Command\Cache\Dir;
 
@@ -15,9 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Class FlushCommand
+ * Flush cache directory command
+ *
+ * @package N98\Magento\Command\Cache\Dir
  *
- * @package N98\Magento\Command\Cache
+ * @author Tom Klingenberg (https://github.com/ktomk)
  */
 class FlushCommand extends AbstractMagentoCommand
 {

diff --git a/src/N98/Magento/Command/Cache/DisableCommand.php b/src/N98/Magento/Command/Cache/DisableCommand.php
@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Disable cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class DisableCommand extends AbstractCacheCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Cache/EnableCommand.php b/src/N98/Magento/Command/Cache/EnableCommand.php
@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Enable cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class EnableCommand extends AbstractCacheCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Cache/FlushCommand.php b/src/N98/Magento/Command/Cache/FlushCommand.php
@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Flush cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class FlushCommand extends AbstractCacheCommand
 {
     protected function configure()
@@ -29,8 +34,14 @@ protected function configure()
             )
             ->setDescription('Flush magento cache storage')
         ;
+    }
 
-        $help = <<<HELP
+    /**
+     * {@inheritdoc}
+     */
+    public function getHelp(): string
+    {
+        return <<<HELP
 Flush the entire cache.
 
    $ n98-magerun.phar cache:flush [--reinit --no-reinit]
@@ -39,7 +50,6 @@ protected function configure()
     --reinit Reinitialise the config cache after flushing (Default)
     --no-reinit Don't reinitialise the config cache after flushing
 HELP;
-        $this->setHelp($help);
     }
 
     /**

diff --git a/src/N98/Magento/Command/Cache/ListCommand.php b/src/N98/Magento/Command/Cache/ListCommand.php
@@ -6,6 +6,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * List cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class ListCommand extends AbstractCacheCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Cache/ReportCommand.php b/src/N98/Magento/Command/Cache/ReportCommand.php
@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Report cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class ReportCommand extends AbstractCacheCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Cache/ViewCommand.php b/src/N98/Magento/Command/Cache/ViewCommand.php
@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Validator\Exception\RuntimeException;
 
+/**
+ * View cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class ViewCommand extends AbstractCacheCommand
 {
     protected function configure()

diff --git a/src/N98/Magento/Command/Category/Create/DummyCommand.php b/src/N98/Magento/Command/Category/Create/DummyCommand.php
@@ -13,6 +13,11 @@
 use Symfony\Component\Console\Question\ChoiceQuestion;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Create category dummy command
+ *
+ * @package N98\Magento\Command\Category\Create
+ */
 class DummyCommand extends AbstractMagentoCommand
 {
     public const DEFAULT_CATEGORY_NAME = "My Awesome Category";

diff --git a/src/N98/Magento/Command/Cms/Banner/ToggleCommand.php b/src/N98/Magento/Command/Cms/Banner/ToggleCommand.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Class ToggleCommand
+ * Toggle CMS banner command
  *
  * Only testable with closed source enterprise edition
  *

diff --git a/src/N98/Magento/Command/Cms/Block/ListCommand.php b/src/N98/Magento/Command/Cms/Block/ListCommand.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * CMS Block ListCommand
+ * List CMS block command
  *
  * @package N98\Magento\Command\Cms\Block
  */

diff --git a/src/N98/Magento/Command/Cms/Block/ToggleCommand.php b/src/N98/Magento/Command/Cms/Block/ToggleCommand.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * CMS Block ToggleCommand
+ * Toggle CMS block command
  *
  * @package N98\Magento\Command\Cms\Block
  */