From 85a3b8849cae44d3702889d1537d28917cdfcd70 Mon Sep 17 00:00:00 2001 From: Sven Reichel Date: Sun, 14 Jul 2024 05:31:06 +0200 Subject: [PATCH 1/5] Moved help from commands `configure()` to `getHelp()` --- .../Magento/Command/Cache/CleanCommand.php | 9 +++- .../Magento/Command/Cache/FlushCommand.php | 9 +++- .../Magento/Command/Config/DeleteCommand.php | 9 +++- .../Magento/Command/Config/DumpCommand.php | 9 +++- src/N98/Magento/Command/Config/GetCommand.php | 28 +++++------ .../Magento/Command/Config/SearchCommand.php | 15 ++++-- src/N98/Magento/Command/Config/SetCommand.php | 10 ++-- .../Customer/ChangePasswordCommand.php | 11 +++-- .../Command/Customer/CreateDummyCommand.php | 39 ++++++++------- .../Command/Customer/DeleteCommand.php | 11 +++-- .../Magento/Command/Customer/ListCommand.php | 9 +++- .../Command/Database/CreateCommand.php | 9 +++- .../Magento/Command/Database/DropCommand.php | 9 +++- .../Magento/Command/Database/DumpCommand.php | 21 +++++---- .../Command/Database/ImportCommand.php | 9 +++- .../Magento/Command/Database/InfoCommand.php | 9 +++- .../Database/Maintain/CheckTablesCommand.php | 47 ++++++++++--------- .../Magento/Command/Database/QueryCommand.php | 10 ++-- .../Command/Database/StatusCommand.php | 9 +++- .../Command/Database/VariablesCommand.php | 9 +++- .../Module/Rewrite/ConflictsCommand.php | 9 +++- .../Developer/Theme/DuplicatesCommand.php | 9 +++- .../Eav/Attribute/Create/DummyCommand.php | 21 ++++++--- .../Magento/Command/Indexer/ListCommand.php | 9 +++- .../Command/Indexer/ListMviewCommand.php | 9 +++- .../Command/Indexer/ReindexAllCommand.php | 10 +++- .../Command/Indexer/ReindexCommand.php | 9 +++- .../Command/Indexer/ReindexMviewCommand.php | 9 +++- .../Command/Installer/InstallCommand.php | 12 +++-- .../Command/Installer/UninstallCommand.php | 9 +++- .../Command/LocalConfig/GenerateCommand.php | 9 +++- .../Command/Script/Repository/ListCommand.php | 9 +++- .../Command/Script/Repository/RunCommand.php | 25 ++++++---- src/N98/Magento/Command/ScriptCommand.php | 9 +++- src/N98/Magento/Command/SelfUpdateCommand.php | 21 +++++---- .../Magento/Command/System/CheckCommand.php | 9 +++- .../Command/System/Cron/RunCommand.php | 12 +++-- .../System/Setup/CompareVersionsCommand.php | 10 +++- .../System/Setup/IncrementalCommand.php | 17 +++++-- .../Command/System/Setup/RunCommand.php | 10 +++- .../Command/System/Url/ListCommand.php | 9 +++- 41 files changed, 369 insertions(+), 168 deletions(-) diff --git a/src/N98/Magento/Command/Cache/CleanCommand.php b/src/N98/Magento/Command/Cache/CleanCommand.php index 0fd03d32f..94e659483 100644 --- a/src/N98/Magento/Command/Cache/CleanCommand.php +++ b/src/N98/Magento/Command/Cache/CleanCommand.php @@ -30,8 +30,14 @@ protected function configure() ) ->setDescription('Clean magento cache') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Cache/FlushCommand.php b/src/N98/Magento/Command/Cache/FlushCommand.php index c89be2be7..ddf68904b 100644 --- a/src/N98/Magento/Command/Cache/FlushCommand.php +++ b/src/N98/Magento/Command/Cache/FlushCommand.php @@ -29,8 +29,14 @@ protected function configure() ) ->setDescription('Flush magento cache storage') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Config/DeleteCommand.php b/src/N98/Magento/Command/Config/DeleteCommand.php index 360eb0efc..9927f6be4 100644 --- a/src/N98/Magento/Command/Config/DeleteCommand.php +++ b/src/N98/Magento/Command/Config/DeleteCommand.php @@ -33,11 +33,16 @@ protected function configure() ) ->addOption('all', null, InputOption::VALUE_NONE, 'Delete all entries by path') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Config/DumpCommand.php b/src/N98/Magento/Command/Config/DumpCommand.php index d58cb80c2..8ae198268 100644 --- a/src/N98/Magento/Command/Config/DumpCommand.php +++ b/src/N98/Magento/Command/Config/DumpCommand.php @@ -18,8 +18,14 @@ protected function configure() ->addArgument('xpath', InputArgument::OPTIONAL, 'XPath to filter XML output', null) ->setDescription('Dump merged xml config') ; + } - $help = << extern_file.xml HELP; - $this->setHelp($help); } /** diff --git a/src/N98/Magento/Command/Config/GetCommand.php b/src/N98/Magento/Command/Config/GetCommand.php index 8ec70b86b..20c01c16d 100644 --- a/src/N98/Magento/Command/Config/GetCommand.php +++ b/src/N98/Magento/Command/Config/GetCommand.php @@ -17,17 +17,6 @@ protected function configure() $this ->setName('config:get') ->setDescription('Get a core config item') - ->setHelp( - <<path is not set, all available config items will be listed. -The path may contain wildcards (*). -If path ends with a trailing slash, all child items will be listed. E.g. - - config:get web/ -is the same as - config:get web/* -EOT - ) ->addArgument('path', InputArgument::OPTIONAL, 'The config path') ->addOption( 'scope', @@ -45,11 +34,22 @@ protected function configure() ->addOption('update-script', null, InputOption::VALUE_NONE, 'Output as update script lines') ->addOption('magerun-script', null, InputOption::VALUE_NONE, 'Output for usage with config:set') ->addFormatOption(); + } - $help = <<path is not set, all available config items will be listed. +The path may contain wildcards (*). +If path ends with a trailing slash, all child items will be listed. E.g. + + config:get web/ +is the same as + config:get web/* HELP; - $this->setHelp($help); } /** diff --git a/src/N98/Magento/Command/Config/SearchCommand.php b/src/N98/Magento/Command/Config/SearchCommand.php index 760f165a0..61313e9cf 100644 --- a/src/N98/Magento/Command/Config/SearchCommand.php +++ b/src/N98/Magento/Command/Config/SearchCommand.php @@ -16,14 +16,19 @@ protected function configure() $this ->setName('config:search') ->setDescription('Search system configuration descriptions.') - ->setHelp( - << and for the indicated text. -EOT - ) ->addArgument('text', InputArgument::REQUIRED, 'The text to search for'); } + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return << and for the indicated text. +HELP; + } + /** * @param InputInterface $input * @param OutputInterface $output diff --git a/src/N98/Magento/Command/Config/SetCommand.php b/src/N98/Magento/Command/Config/SetCommand.php index 9dac9db47..335abc1ac 100644 --- a/src/N98/Magento/Command/Config/SetCommand.php +++ b/src/N98/Magento/Command/Config/SetCommand.php @@ -44,13 +44,17 @@ protected function configure() "Do not treat value NULL as " . self::DISPLAY_NULL_UNKNOWN_VALUE . " value" ) ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Customer/ChangePasswordCommand.php b/src/N98/Magento/Command/Customer/ChangePasswordCommand.php index 66132e53d..89e6061bf 100644 --- a/src/N98/Magento/Command/Customer/ChangePasswordCommand.php +++ b/src/N98/Magento/Command/Customer/ChangePasswordCommand.php @@ -22,11 +22,16 @@ protected function configure() ->addArgument('website', InputArgument::OPTIONAL, 'Website of the customer') ->setDescription('Changes the password of a customer.') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Customer/CreateDummyCommand.php b/src/N98/Magento/Command/Customer/CreateDummyCommand.php index 5dab97493..8d107bc17 100644 --- a/src/N98/Magento/Command/Customer/CreateDummyCommand.php +++ b/src/N98/Magento/Command/Customer/CreateDummyCommand.php @@ -16,7 +16,28 @@ class CreateDummyCommand extends AbstractCustomerCommand { protected function configure() { - $help = <<setName('customer:create:dummy') + ->addArgument('count', InputArgument::REQUIRED, 'Count') + ->addArgument('locale', InputArgument::REQUIRED, Locale::class) + ->addArgument('website', InputArgument::OPTIONAL, 'Website') + ->addOption( + 'with-addresses', + null, + InputOption::VALUE_NONE, + 'Create dummy billing/shipping addresses for each customers' + ) + ->setDescription('Generate dummy customers. You can specify a count and a locale.') + ->addFormatOption() + ; + } + + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return <<setName('customer:create:dummy') - ->addArgument('count', InputArgument::REQUIRED, 'Count') - ->addArgument('locale', InputArgument::REQUIRED, Locale::class) - ->addArgument('website', InputArgument::OPTIONAL, 'Website') - ->addOption( - 'with-addresses', - null, - InputOption::VALUE_NONE, - 'Create dummy billing/shipping addresses for each customers' - ) - ->setDescription('Generate dummy customers. You can specify a count and a locale.') - ->addFormatOption() - ->setHelp($help) - ; } /** diff --git a/src/N98/Magento/Command/Customer/DeleteCommand.php b/src/N98/Magento/Command/Customer/DeleteCommand.php index 5d6ee4da3..cc3d68aab 100644 --- a/src/N98/Magento/Command/Customer/DeleteCommand.php +++ b/src/N98/Magento/Command/Customer/DeleteCommand.php @@ -49,8 +49,14 @@ protected function configure() ->addOption('force', 'f', InputOption::VALUE_NONE, 'Force delete') ->addOption('range', '-r', InputOption::VALUE_NONE, 'Delete a range of customers by Id') ->setDescription('Delete Customer/s'); + } - $help = <<Example Usage: @@ -59,10 +65,7 @@ protected function configure() n98-magerun customer:delete mike@example.com # Will delete customer with that email n98-magerun customer:delete --all # Will delete all customers n98-magerun customer:delete --range # Will prompt for start and end Ids for batch deletion - HELP; - - $this->setHelp($help); } /** diff --git a/src/N98/Magento/Command/Customer/ListCommand.php b/src/N98/Magento/Command/Customer/ListCommand.php index cc60a8592..2eafea8a9 100644 --- a/src/N98/Magento/Command/Customer/ListCommand.php +++ b/src/N98/Magento/Command/Customer/ListCommand.php @@ -17,12 +17,17 @@ protected function configure() ->addFormatOption() ->setDescription('Lists customers') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/CreateCommand.php b/src/N98/Magento/Command/Database/CreateCommand.php index 3572573ae..9b187e3f9 100644 --- a/src/N98/Magento/Command/Database/CreateCommand.php +++ b/src/N98/Magento/Command/Database/CreateCommand.php @@ -13,13 +13,18 @@ protected function configure() ->setName('db:create') ->setDescription('Create currently configured database') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/DropCommand.php b/src/N98/Magento/Command/Database/DropCommand.php index 469f80bd7..e0d2ddaeb 100644 --- a/src/N98/Magento/Command/Database/DropCommand.php +++ b/src/N98/Magento/Command/Database/DropCommand.php @@ -19,13 +19,18 @@ protected function configure() ->addOption('force', 'f', InputOption::VALUE_NONE, 'Force') ->setDescription('Drop current database') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/DumpCommand.php b/src/N98/Magento/Command/Database/DumpCommand.php index 30958be8e..0628baa50 100644 --- a/src/N98/Magento/Command/Database/DumpCommand.php +++ b/src/N98/Magento/Command/Database/DumpCommand.php @@ -138,7 +138,13 @@ protected function configure() 'Specify local.xml connection node, default to default_setup' ) ->setDescription('Dumps database with mysqldump cli client'); + } + /** + * {@inheritdoc} + */ + public function getHelp(): string + { $help = <<setHelp($help); + return + $help . PHP_EOL + . $this->getCompressionHelp() . PHP_EOL + . $this->getTableDefinitionHelp(); } /** @@ -238,14 +247,6 @@ public function getTableDefinitionHelp() return $messages; } - public function getHelp() - { - return - parent::getHelp() . PHP_EOL - . $this->getCompressionHelp() . PHP_EOL - . $this->getTableDefinitionHelp(); - } - /** * @param InputInterface $input * @param OutputInterface $output diff --git a/src/N98/Magento/Command/Database/ImportCommand.php b/src/N98/Magento/Command/Database/ImportCommand.php index 6efc22e40..84a45509d 100644 --- a/src/N98/Magento/Command/Database/ImportCommand.php +++ b/src/N98/Magento/Command/Database/ImportCommand.php @@ -29,13 +29,18 @@ protected function configure() ->addOption('stdin', null, InputOption::VALUE_NONE, 'Import data from STDIN rather than file') ->addOption('drop-tables', null, InputOption::VALUE_NONE, 'Drop tables before import') ->setDescription('Imports database with mysql cli client according to database defined in local.xml'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/InfoCommand.php b/src/N98/Magento/Command/Database/InfoCommand.php index 0a62720ed..0cf686324 100644 --- a/src/N98/Magento/Command/Database/InfoCommand.php +++ b/src/N98/Magento/Command/Database/InfoCommand.php @@ -20,12 +20,17 @@ protected function configure() ->addFormatOption() ; $this->addDeprecatedAlias('database:info', 'Please use db:info'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php b/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php index 745e1763d..8fce099c5 100644 --- a/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php +++ b/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php @@ -44,7 +44,32 @@ class CheckTablesCommand extends AbstractMagentoCommand protected function configure() { - $help = <<<'HELP' + $this + ->setName('db:maintain:check-tables') + ->setDescription('Check database tables') + ->addOption( + 'type', + null, + InputOption::VALUE_OPTIONAL, + 'Check type (one of QUICK, FAST, MEDIUM, EXTENDED, CHANGED)', + 'MEDIUM' + ) + ->addOption('repair', null, InputOption::VALUE_NONE, 'Repair tables (only MyISAM)') + ->addOption( + 'table', + null, + InputOption::VALUE_OPTIONAL, + 'Process only given table (wildcards are supported)' + ) + ->addFormatOption(); + } + + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return <<TYPE OPTIONS QUICK @@ -71,26 +96,6 @@ protected function configure() InnoDB tables will be optimized with the ALTER TABLE ... ENGINE=InnoDB statement. The options above do not apply to them. HELP; - - $this - ->setName('db:maintain:check-tables') - ->setDescription('Check database tables') - ->addOption( - 'type', - null, - InputOption::VALUE_OPTIONAL, - 'Check type (one of QUICK, FAST, MEDIUM, EXTENDED, CHANGED)', - 'MEDIUM' - ) - ->addOption('repair', null, InputOption::VALUE_NONE, 'Repair tables (only MyISAM)') - ->addOption( - 'table', - null, - InputOption::VALUE_OPTIONAL, - 'Process only given table (wildcards are supported)' - ) - ->addFormatOption() - ->setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/QueryCommand.php b/src/N98/Magento/Command/Database/QueryCommand.php index 7583ba6c2..a76838516 100644 --- a/src/N98/Magento/Command/Database/QueryCommand.php +++ b/src/N98/Magento/Command/Database/QueryCommand.php @@ -18,8 +18,14 @@ protected function configure() ->addOption('only-command', null, InputOption::VALUE_NONE, 'Print only mysql command. Do not execute') ->setDescription('Executes an SQL query on the database defined in local.xml') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/StatusCommand.php b/src/N98/Magento/Command/Database/StatusCommand.php index 2e77efe2f..dec02132a 100644 --- a/src/N98/Magento/Command/Database/StatusCommand.php +++ b/src/N98/Magento/Command/Database/StatusCommand.php @@ -30,11 +30,16 @@ protected function configure() $this ->setName('db:status') ->setDescription('Shows important server status information or custom selected status values'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Database/VariablesCommand.php b/src/N98/Magento/Command/Database/VariablesCommand.php index eab485c3b..5f313be81 100644 --- a/src/N98/Magento/Command/Database/VariablesCommand.php +++ b/src/N98/Magento/Command/Database/VariablesCommand.php @@ -22,11 +22,16 @@ protected function configure() $this ->setName('db:variables') ->setDescription('Shows important variables or custom selected'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php b/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php index 15f2260d1..956a3814d 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php @@ -24,8 +24,14 @@ protected function configure() 'Log conflicts in JUnit XML format to defined file.' ) ->setDescription('Lists all magento rewrite conflicts'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php b/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php index 8809a17f7..b61e38427 100644 --- a/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php +++ b/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php @@ -32,11 +32,16 @@ protected function configure() ) ->setDescription('Find duplicate files (templates, layout, locale, etc.) between two themes.') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php b/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php index 469db9fa9..54b02c2a0 100644 --- a/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php +++ b/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php @@ -21,21 +21,28 @@ class DummyCommand extends AbstractMagentoCommand protected function configure() { - $help = <<setName('eav:attribute:create-dummy-values')->addArgument('locale', InputArgument::OPTIONAL, Locale::class) ->addArgument('attribute-id', InputArgument::OPTIONAL, 'Attribute ID to add values') ->addArgument('values-type', InputArgument::OPTIONAL, 'Types of Values to create (default int)') ->addArgument('values-number', InputArgument::OPTIONAL, 'Number of Values to create (default 1)') - ->setDescription('Create a dummy values for dropdown attributes')->setHelp($help) + ->setDescription('Create a dummy values for dropdown attributes') ; } + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return <<setDescription('Lists all magento indexes') ->addFormatOption() ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Indexer/ListMviewCommand.php b/src/N98/Magento/Command/Indexer/ListMviewCommand.php index 60c10fb58..799745848 100644 --- a/src/N98/Magento/Command/Indexer/ListMviewCommand.php +++ b/src/N98/Magento/Command/Indexer/ListMviewCommand.php @@ -15,11 +15,16 @@ protected function configure() ->setDescription('Lists all magento mview indexes') ->addFormatOption() ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Indexer/ReindexAllCommand.php b/src/N98/Magento/Command/Indexer/ReindexAllCommand.php index 238450b4e..81af22a2e 100644 --- a/src/N98/Magento/Command/Indexer/ReindexAllCommand.php +++ b/src/N98/Magento/Command/Indexer/ReindexAllCommand.php @@ -15,8 +15,16 @@ protected function configure() ->setName('index:reindex:all') ->setDescription('Reindex all magento indexes') ; + } - $this->setHelp('Loops all magento indexes and triggers reindex.'); + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return <<setName('index:reindex') ->addArgument('index_code', InputArgument::OPTIONAL, 'Code of indexer.') ->setDescription('Reindex a magento index by code'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php b/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php index bfe03b2e3..8dbb5ffd4 100644 --- a/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php +++ b/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php @@ -15,13 +15,18 @@ protected function configure() ->setName('index:reindex:mview') ->addArgument('table_name', InputArgument::REQUIRED, 'View table name"') ->setDescription('Reindex a magento index by code using the materialised view functionality'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Installer/InstallCommand.php b/src/N98/Magento/Command/Installer/InstallCommand.php index 3b772140c..f6890a51c 100644 --- a/src/N98/Magento/Command/Installer/InstallCommand.php +++ b/src/N98/Magento/Command/Installer/InstallCommand.php @@ -83,8 +83,14 @@ protected function configure() 'If --composer-use-same-php-binary passed, will invoke composer with the same PHP binary' ) ->setDescription('Install magento'); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Installer/UninstallCommand.php b/src/N98/Magento/Command/Installer/UninstallCommand.php index b5ee14a8b..b30fb1994 100644 --- a/src/N98/Magento/Command/Installer/UninstallCommand.php +++ b/src/N98/Magento/Command/Installer/UninstallCommand.php @@ -35,11 +35,16 @@ protected function configure() 'Uninstall magento (drops database and empties current folder or folder set via installationFolder)' ) ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/LocalConfig/GenerateCommand.php b/src/N98/Magento/Command/LocalConfig/GenerateCommand.php index 14087f317..7b13cc47d 100644 --- a/src/N98/Magento/Command/LocalConfig/GenerateCommand.php +++ b/src/N98/Magento/Command/LocalConfig/GenerateCommand.php @@ -26,15 +26,20 @@ protected function configure() ->addArgument('admin-frontname', InputArgument::OPTIONAL, 'Admin front name') ->addArgument('encryption-key', InputArgument::OPTIONAL, 'Encryption Key') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/Script/Repository/ListCommand.php b/src/N98/Magento/Command/Script/Repository/ListCommand.php index 5031c842e..a7f04f1df 100644 --- a/src/N98/Magento/Command/Script/Repository/ListCommand.php +++ b/src/N98/Magento/Command/Script/Repository/ListCommand.php @@ -17,8 +17,14 @@ protected function configure() ->setDescription('Lists all scripts in repository') ->addFormatOption() ; + } - $help = <</.n98-magerun/scripts*. @@ -30,7 +36,6 @@ protected function configure() $ n98-magerun.phar script:repo:list HELP; - $this->setHelp($help); } /** diff --git a/src/N98/Magento/Command/Script/Repository/RunCommand.php b/src/N98/Magento/Command/Script/Repository/RunCommand.php index 85f812a87..269ae4ed2 100644 --- a/src/N98/Magento/Command/Script/Repository/RunCommand.php +++ b/src/N98/Magento/Command/Script/Repository/RunCommand.php @@ -15,7 +15,21 @@ class RunCommand extends AbstractRepositoryCommand { protected function configure() { - $help = <<setName('script:repo:run') + ->addArgument('script', InputArgument::OPTIONAL, 'Name of script in repository') + ->addOption('define', 'd', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Defines a variable') + ->addOption('stop-on-error', null, InputOption::VALUE_NONE, 'Stops execution of script on error') + ->setDescription('Run script from repository') + ; + } + + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return << HELP; - - $this - ->setName('script:repo:run') - ->addArgument('script', InputArgument::OPTIONAL, 'Name of script in repository') - ->addOption('define', 'd', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Defines a variable') - ->addOption('stop-on-error', null, InputOption::VALUE_NONE, 'Stops execution of script on error') - ->setDescription('Run script from repository') - ->setHelp($help) - ; } protected function execute(InputInterface $input, OutputInterface $output): int diff --git a/src/N98/Magento/Command/ScriptCommand.php b/src/N98/Magento/Command/ScriptCommand.php index ce4aca091..8c0de9c66 100644 --- a/src/N98/Magento/Command/ScriptCommand.php +++ b/src/N98/Magento/Command/ScriptCommand.php @@ -42,8 +42,14 @@ protected function configure() ->addOption('stop-on-error', null, InputOption::VALUE_NONE, 'Stops execution of script on error') ->setDescription('Runs multiple n98-magerun commands') ; + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/SelfUpdateCommand.php b/src/N98/Magento/Command/SelfUpdateCommand.php index 3ae1bc646..81cb8fdfa 100644 --- a/src/N98/Magento/Command/SelfUpdateCommand.php +++ b/src/N98/Magento/Command/SelfUpdateCommand.php @@ -37,16 +37,21 @@ protected function configure() ->setAliases(['selfupdate']) ->addOption('unstable', null, InputOption::VALUE_NONE, 'Load unstable version from develop branch') ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Tests if there is a new version without any update.') - ->setDescription('Updates n98-magerun2.phar to the latest version.') - ->setHelp( - <<self-update command checks github for newer -versions of n98-magerun2 and if found, installs the latest. + ->setDescription('Updates n98-magerun2.phar to the latest version.'); + } + + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return <<self-update command checks GitHub for newer +versions of n98-magerun and if found, installs the latest. -php n98-magerun2.phar self-update +php n98-magerun.phar self-update -EOT - ); +HELP; } /** diff --git a/src/N98/Magento/Command/System/CheckCommand.php b/src/N98/Magento/Command/System/CheckCommand.php index 871f8599e..d99faf132 100644 --- a/src/N98/Magento/Command/System/CheckCommand.php +++ b/src/N98/Magento/Command/System/CheckCommand.php @@ -37,14 +37,19 @@ protected function configure() ->setName('sys:check') ->setDescription('Checks Magento System') ->addFormatOption(); + } - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/System/Cron/RunCommand.php b/src/N98/Magento/Command/System/Cron/RunCommand.php index 28684ca65..294333022 100644 --- a/src/N98/Magento/Command/System/Cron/RunCommand.php +++ b/src/N98/Magento/Command/System/Cron/RunCommand.php @@ -31,12 +31,18 @@ protected function configure() ->addArgument('job', InputArgument::OPTIONAL, 'Job code') ->addOption('schedule', 's', InputOption::VALUE_NONE, 'Schedule cron instead of run with current user') ->setDescription('Runs a cronjob by job code'); - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php b/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php index 9c442f984..659084426 100644 --- a/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php +++ b/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php @@ -28,10 +28,16 @@ protected function configure() ) ->addFormatOption() ->setDescription('Compare module version with core_resource table.'); - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/System/Setup/IncrementalCommand.php b/src/N98/Magento/Command/System/Setup/IncrementalCommand.php index 5c36195c2..acbad4613 100644 --- a/src/N98/Magento/Command/System/Setup/IncrementalCommand.php +++ b/src/N98/Magento/Command/System/Setup/IncrementalCommand.php @@ -59,11 +59,18 @@ protected function configure() $this ->setName('sys:setup:incremental') ->setDescription('List new setup scripts to run, then runs one script') - ->addOption('stop-on-error', null, InputOption::VALUE_NONE, 'Stops execution of script on error') - ->setHelp( - 'Examines an un-cached configuration tree and determines which ' . - 'structure and data setup resource scripts need to run, and then runs them.' - ); + ->addOption('stop-on-error', null, InputOption::VALUE_NONE, 'Stops execution of script on error'); + } + + /** + * {@inheritdoc} + */ + public function getHelp(): string + { + return <<setDescription('Runs all new setup scripts.'); - $help = <<setHelp($help); } /** diff --git a/src/N98/Magento/Command/System/Url/ListCommand.php b/src/N98/Magento/Command/System/Url/ListCommand.php index 94919d5cc..e335e8a53 100644 --- a/src/N98/Magento/Command/System/Url/ListCommand.php +++ b/src/N98/Magento/Command/System/Url/ListCommand.php @@ -40,8 +40,14 @@ protected function configure() ->addArgument('stores', InputArgument::OPTIONAL, 'Stores (comma-separated list of store ids)') ->addArgument('linetemplate', InputArgument::OPTIONAL, 'Line template', '{url}') ->setDescription('Get all urls.'); + } - $help = <<setHelp($help); } /** From 7dd4ede0a0def378c8bf057c51910e995eee8a33 Mon Sep 17 00:00:00 2001 From: Sven Reichel Date: Sun, 14 Jul 2024 04:10:18 +0200 Subject: [PATCH 2/5] Updated class DocBlocks --- src/N98/Magento/Application.php | 5 ++++ .../AbstractMagentoStoreConfigCommand.php | 5 ++++ .../Admin/DisableNotificationsCommand.php | 5 ++++ .../Admin/User/AbstractAdminUserCommand.php | 5 ++++ .../Admin/User/ChangePasswordCommand.php | 5 ++++ .../Admin/User/ChangeStatusCommand.php | 5 ++++ .../Command/Admin/User/CreateUserCommand.php | 5 ++++ .../Command/Admin/User/DeleteUserCommand.php | 4 ++- .../Command/Admin/User/ListCommand.php | 5 ++++ .../Command/Admin/User/LockCommand.php | 5 ++++ .../Command/Admin/User/LockdownCommand.php | 5 ++++ .../Command/Admin/User/UnlockCommand.php | 5 ++++ .../Command/Cache/AbstractCacheCommand.php | 5 ++++ .../Magento/Command/Cache/CleanCommand.php | 5 ++++ .../Command/Cache/Dir/FlushCommand.php | 11 +++----- .../Magento/Command/Cache/DisableCommand.php | 5 ++++ .../Magento/Command/Cache/EnableCommand.php | 5 ++++ .../Magento/Command/Cache/FlushCommand.php | 5 ++++ src/N98/Magento/Command/Cache/ListCommand.php | 5 ++++ .../Magento/Command/Cache/ReportCommand.php | 5 ++++ src/N98/Magento/Command/Cache/ViewCommand.php | 5 ++++ .../Command/Category/Create/DummyCommand.php | 5 ++++ .../Command/Cms/Banner/ToggleCommand.php | 2 +- .../Magento/Command/Cms/Block/ListCommand.php | 2 +- .../Command/Cms/Block/ToggleCommand.php | 2 +- .../Command/Cms/Page/PublishCommand.php | 2 +- src/N98/Magento/Command/CommandAware.php | 5 ++++ .../Magento/Command/CommandConfigAware.php | 5 ++++ .../ComposerWrapper/EventSubscriber.php | 5 ++++ .../Command/Config/AbstractConfigCommand.php | 5 ++++ .../Magento/Command/Config/DeleteCommand.php | 5 ++++ .../Magento/Command/Config/DumpCommand.php | 5 ++++ src/N98/Magento/Command/Config/GetCommand.php | 5 ++++ .../Magento/Command/Config/SearchCommand.php | 5 ++++ src/N98/Magento/Command/Config/SetCommand.php | 5 ++++ .../Customer/ChangePasswordCommand.php | 5 ++++ .../Command/Customer/CreateCommand.php | 5 ++++ .../Command/Customer/CreateDummyCommand.php | 5 ++++ .../Command/Customer/DeleteCommand.php | 3 ++- .../Magento/Command/Customer/InfoCommand.php | 5 ++++ .../Magento/Command/Customer/ListCommand.php | 5 ++++ .../Database/AbstractDatabaseCommand.php | 5 ++++ .../Command/Database/AbstractShowCommand.php | 5 ++++ .../Compressor/AbstractCompressor.php | 5 ++++ .../Database/Compressor/Compressor.php | 7 ++--- .../Command/Database/Compressor/Gzip.php | 5 ++++ .../Database/Compressor/Uncompressed.php | 5 ++++ .../Command/Database/ConsoleCommand.php | 5 ++++ .../Command/Database/CreateCommand.php | 5 ++++ .../Magento/Command/Database/DropCommand.php | 5 ++++ .../Magento/Command/Database/DumpCommand.php | 5 ++++ .../Command/Database/ImportCommand.php | 5 ++++ .../Magento/Command/Database/InfoCommand.php | 5 ++++ .../Database/Maintain/CheckTablesCommand.php | 5 ++++ .../Magento/Command/Database/QueryCommand.php | 5 ++++ .../Command/Database/StatusCommand.php | 5 ++++ .../Command/Database/VariablesCommand.php | 5 ++++ .../Command/Design/DemoNoticeCommand.php | 5 ++++ .../Command/Developer/ClassLookupCommand.php | 5 ++++ .../Developer/Code/Model/MethodCommand.php | 5 ++++ .../Command/Developer/Console/Psy/Shell.php | 5 ++++ .../Command/Developer/ConsoleCommand.php | 5 ++++ .../Developer/EmailTemplate/UsageCommand.php | 14 +++++----- .../Developer/Ide/PhpStorm/MetaCommand.php | 5 ++++ .../Developer/Log/AbstractLogCommand.php | 5 ++++ .../Command/Developer/Log/DbCommand.php | 5 ++++ .../Command/Developer/Log/LogCommand.php | 5 ++++ .../Command/Developer/Log/SizeCommand.php | 5 ++++ .../Command/Developer/MergeCssCommand.php | 5 ++++ .../Command/Developer/MergeJsCommand.php | 5 ++++ .../Developer/Module/CreateCommand.php | 4 ++- .../Module/Dependencies/AbstractCommand.php | 5 ++++ .../Module/Dependencies/FromCommand.php | 5 ++++ .../Module/Dependencies/OnCommand.php | 5 ++++ .../Module/Disableenable/AbstractCommand.php | 4 ++- .../Module/Disableenable/DisableCommand.php | 4 ++- .../Module/Disableenable/EnableCommand.php | 4 ++- .../Command/Developer/Module/ListCommand.php | 5 ++++ .../Developer/Module/Observer/ListCommand.php | 5 ++++ .../Module/Rewrite/AbstractRewriteCommand.php | 5 ++++ ...nNotAutoloadCollaboratorClassException.php | 7 ++--- .../Module/Rewrite/ClassExistsChecker.php | 7 ++--- .../Rewrite/ClassExistsThrownException.php | 7 ++--- .../Developer/Module/Rewrite/ClassUtil.php | 12 +++++---- .../Module/Rewrite/ConflictsCommand.php | 5 ++++ .../Developer/Module/Rewrite/ListCommand.php | 5 ++++ .../Developer/Module/UpdateCommand.php | 4 ++- .../Command/Developer/ProfilerCommand.php | 5 ++++ .../Command/Developer/Report/CountCommand.php | 5 ++++ .../Attribute/EntityType/CatalogProduct.php | 5 ++++ .../Attribute/EntityType/EntityType.php | 5 ++++ .../Script/Attribute/EntityType/Factory.php | 5 ++++ .../Setup/Script/AttributeCommand.php | 26 ++++++++++--------- .../Command/Developer/SymlinksCommand.php | 5 ++++ .../Developer/TemplateHintsBlocksCommand.php | 5 ++++ .../Developer/TemplateHintsCommand.php | 5 ++++ .../Developer/Theme/DuplicatesCommand.php | 5 ++++ .../Command/Developer/Theme/InfoCommand.php | 3 ++- .../Command/Developer/Theme/ListCommand.php | 5 ++++ .../Developer/Translate/ExportCommand.php | 5 ++++ .../Translate/InlineAdminCommand.php | 5 ++++ .../Developer/Translate/InlineShopCommand.php | 5 ++++ .../Developer/Translate/SetCommand.php | 5 ++++ .../Eav/Attribute/Create/DummyCommand.php | 5 ++++ .../Eav/Attribute/Create/DummyValues.php | 5 ++++ .../Command/Eav/Attribute/ListCommand.php | 5 ++++ .../Command/Eav/Attribute/RemoveCommand.php | 4 ++- .../Command/Eav/Attribute/ViewCommand.php | 5 ++++ .../GiftCard/AbstractGiftCardCommand.php | 5 ++++ .../Command/GiftCard/CreateCommand.php | 5 ++++ .../Magento/Command/GiftCard/InfoCommand.php | 5 ++++ .../Command/GiftCard/Pool/GenerateCommand.php | 5 ++++ .../Command/GiftCard/RemoveCommand.php | 5 ++++ .../Indexer/AbstractMviewIndexerCommand.php | 5 ++++ .../Magento/Command/Indexer/ListCommand.php | 5 ++++ .../Command/Indexer/ListMviewCommand.php | 5 ++++ .../Command/Indexer/ReindexAllCommand.php | 5 ++++ .../Command/Indexer/ReindexCommand.php | 5 ++++ .../Command/Indexer/ReindexMviewCommand.php | 5 ++++ .../Command/Installer/InstallCommand.php | 4 +-- .../SubCommand/ChooseInstallationFolder.php | 1 + .../Installer/SubCommand/CreateDatabase.php | 1 + .../Installer/SubCommand/DownloadMagento.php | 1 + .../Installer/SubCommand/InstallComposer.php | 1 + .../SubCommand/InstallComposerPackages.php | 1 + .../Installer/SubCommand/InstallMagento.php | 1 + .../SubCommand/InstallSampleData.php | 1 + .../Installer/SubCommand/PostInstallation.php | 5 ++++ .../Installer/SubCommand/PreCheckPhp.php | 1 + .../SubCommand/RemoveEmptyFolders.php | 1 + .../SubCommand/RewriteHtaccessFile.php | 1 + .../SubCommand/SelectMagentoVersion.php | 1 + .../SubCommand/SetDirectoryPermissions.php | 1 + .../Command/Installer/UninstallCommand.php | 2 +- .../Command/LocalConfig/GenerateCommand.php | 5 ++++ .../Media/Cache/Image/ClearCommand.php | 5 ++++ .../Media/Cache/JsCss/ClearCommand.php | 5 ++++ src/N98/Magento/Command/Media/DumpCommand.php | 5 ++++ .../Magento/Command/OpenBrowserCommand.php | 5 ++++ .../Repository/AbstractRepositoryCommand.php | 5 ++++ .../Command/Script/Repository/ListCommand.php | 5 ++++ .../Command/Script/Repository/RunCommand.php | 5 ++++ .../Script/Repository/ScriptLoader.php | 5 ++++ src/N98/Magento/Command/ScriptCommand.php | 5 ++++ src/N98/Magento/Command/SelfUpdateCommand.php | 4 +++ .../Command/SubCommand/AbstractSubCommand.php | 1 + .../Magento/Command/SubCommand/ConfigBag.php | 1 + .../Command/SubCommand/SubCommandFactory.php | 1 + .../SubCommand/SubCommandInterface.php | 1 + .../System/Check/Filesystem/FilesCheck.php | 5 ++++ .../System/Check/Filesystem/FoldersCheck.php | 5 ++++ .../System/Check/MySQL/EnginesCheck.php | 12 +++++---- .../System/Check/MySQL/ResourceCheck.php | 12 +++++---- .../System/Check/MySQL/VersionCheck.php | 12 +++++---- .../PHP/BytecodeCacheExtensionsCheck.php | 5 ++++ .../System/Check/PHP/ExtensionsCheck.php | 5 ++++ .../Magento/Command/System/Check/Result.php | 5 ++++ .../Security/LocalConfigAccessableCheck.php | 5 ++++ .../Check/Settings/BaseUrlCheckAbstract.php | 7 ++--- .../System/Check/Settings/CheckAbstract.php | 7 ++--- .../Settings/CookieDomainCheckAbstract.php | 7 ++--- .../Settings/SecureCookieDomainCheck.php | 5 ++++ .../Settings/UnsecureCookieDomainCheck.php | 5 ++++ .../Magento/Command/System/CheckCommand.php | 2 +- .../System/Cron/AbstractCronCommand.php | 5 ++++ .../Command/System/Cron/HistoryCommand.php | 5 ++++ .../Command/System/Cron/ListCommand.php | 5 ++++ .../Command/System/Cron/RunCommand.php | 5 ++++ .../Magento/Command/System/InfoCommand.php | 5 ++++ .../Command/System/MaintenanceCommand.php | 5 ++++ .../System/Setup/AbstractSetupCommand.php | 1 + .../System/Setup/ChangeVersionCommand.php | 3 ++- .../System/Setup/CompareVersionsCommand.php | 5 ++++ .../System/Setup/IncrementalCommand.php | 2 +- .../Command/System/Setup/RemoveCommand.php | 3 ++- .../Command/System/Setup/RunCommand.php | 5 ++++ .../Store/Config/BaseUrlListCommand.php | 5 ++++ .../Command/System/Store/ListCommand.php | 5 ++++ .../Command/System/Url/ListCommand.php | 4 ++- .../Command/System/Website/ListCommand.php | 5 ++++ src/N98/Magento/DbSettings.php | 7 ++--- src/N98/Magento/Initialiser.php | 4 ++- src/N98/Magento/Modules.php | 7 ++--- src/N98/MagerunBootstrap.php | 7 ++--- src/N98/Util/ArrayFunctions.php | 10 ++++--- src/N98/Util/AutoloadHandler.php | 7 ++--- src/N98/Util/AutoloadRestorer.php | 7 ++--- src/N98/Util/BinaryString.php | 5 ++++ src/N98/Util/Console/Enabler.php | 7 ++--- .../Util/Console/Helper/ComposerHelper.php | 1 + src/N98/Util/Console/Helper/IoHelper.php | 7 ++--- .../Util/Console/Helper/ParameterHelper.php | 2 ++ .../Helper/Table/Renderer/CsvRenderer.php | 5 ++++ .../Helper/Table/Renderer/JsonRenderer.php | 5 ++++ .../Helper/Table/Renderer/RendererFactory.php | 5 ++++ .../Table/Renderer/RendererInterface.php | 5 ++++ .../Helper/Table/Renderer/TextRenderer.php | 7 ++--- .../Helper/Table/Renderer/XmlRenderer.php | 7 ++--- src/N98/Util/Console/Helper/TableHelper.php | 6 +++-- src/N98/Util/Console/Helper/TwigHelper.php | 2 ++ src/N98/Util/DateTime.php | 5 ++++ src/N98/Util/Faker/Provider/Internet.php | 5 ++++ src/N98/Util/Filesystem.php | 7 ++--- src/N98/Util/Markdown/VersionFilePrinter.php | 1 + src/N98/Util/OperatingSystem.php | 7 ++--- src/N98/Util/ProcessArguments.php | 5 ++-- src/N98/Util/StringTyped.php | 7 ++--- src/N98/Util/Template/Twig.php | 5 ++++ src/N98/Util/Unicode/Charset.php | 1 + .../Util/Validator/FakeMetadataFactory.php | 1 + src/N98/Util/VerifyOrDie.php | 7 ++--- src/N98/Util/WindowsSystem.php | 7 ++--- src/N98/View/PhpView.php | 5 ++++ src/N98/View/View.php | 5 ++++ 214 files changed, 872 insertions(+), 180 deletions(-) diff --git a/src/N98/Magento/Application.php b/src/N98/Magento/Application.php index 843d75f26..fa1438503 100644 --- 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 { /** diff --git a/src/N98/Magento/Command/AbstractMagentoStoreConfigCommand.php b/src/N98/Magento/Command/AbstractMagentoStoreConfigCommand.php index e760d13f0..54ef16590 100644 --- 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 index 87f4087b7..021971b05 100644 --- 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 index 4e8c64eb1..699b5e471 100644 --- 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 index 8fa97d053..62a618b60 100644 --- 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 index e113d9df5..1bb02920d 100644 --- 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 index 860fbffe2..9181fcc93 100644 --- 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 index a161800f6..d2dfd0633 100644 --- 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 index 0366383f7..b75da3ae7 100644 --- 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 index 251325b65..c51fd4635 100644 --- 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 index fc1f57f3b..613a89c8b 100644 --- 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 index 3ae8db3da..850f57eeb 100644 --- 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 index 558160c94..fea8254d2 100644 --- 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 index 94e659483..1267ec00e 100644 --- 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() diff --git a/src/N98/Magento/Command/Cache/Dir/FlushCommand.php b/src/N98/Magento/Command/Cache/Dir/FlushCommand.php index 4ad025ce6..286c70528 100644 --- a/src/N98/Magento/Command/Cache/Dir/FlushCommand.php +++ b/src/N98/Magento/Command/Cache/Dir/FlushCommand.php @@ -1,9 +1,4 @@ - */ 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 index f1f835c6c..f4a2329cc 100644 --- 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 index a302ca298..c6d2bbb4e 100644 --- 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 index ddf68904b..9896e5fbb 100644 --- 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() diff --git a/src/N98/Magento/Command/Cache/ListCommand.php b/src/N98/Magento/Command/Cache/ListCommand.php index 95454cb27..a90359c94 100644 --- 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 index fc50665a2..a30b2724a 100644 --- 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 index 8c2c26a9a..3c788c125 100644 --- 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 index 54607255d..27e4d5cfb 100644 --- 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 index 9381f28de..d41ec1d7d 100644 --- 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 index ac235716f..5f961831b 100644 --- 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 index 50f9bf8cd..a228aa1a6 100644 --- 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 */ diff --git a/src/N98/Magento/Command/Cms/Page/PublishCommand.php b/src/N98/Magento/Command/Cms/Page/PublishCommand.php index 66ca3e9be..f26b91f81 100644 --- a/src/N98/Magento/Command/Cms/Page/PublishCommand.php +++ b/src/N98/Magento/Command/Cms/Page/PublishCommand.php @@ -8,7 +8,7 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class PublishCommand + * Publish CMS page command * * Only testable with closed source enterprise edition * diff --git a/src/N98/Magento/Command/CommandAware.php b/src/N98/Magento/Command/CommandAware.php index a0c205248..a11c529e0 100644 --- a/src/N98/Magento/Command/CommandAware.php +++ b/src/N98/Magento/Command/CommandAware.php @@ -4,6 +4,11 @@ use Symfony\Component\Console\Command\Command; +/** + * Interface CommandAware + * + * @package N98\Magento\Command + */ interface CommandAware { /** diff --git a/src/N98/Magento/Command/CommandConfigAware.php b/src/N98/Magento/Command/CommandConfigAware.php index 859ab9ff3..c0208991c 100644 --- a/src/N98/Magento/Command/CommandConfigAware.php +++ b/src/N98/Magento/Command/CommandConfigAware.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command; +/** + * Interface CommandConfigAware + * + * @package N98\Magento\Command + */ interface CommandConfigAware { /** diff --git a/src/N98/Magento/Command/ComposerWrapper/EventSubscriber.php b/src/N98/Magento/Command/ComposerWrapper/EventSubscriber.php index 1204958f2..4cd5aed02 100644 --- a/src/N98/Magento/Command/ComposerWrapper/EventSubscriber.php +++ b/src/N98/Magento/Command/ComposerWrapper/EventSubscriber.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Event\ConsoleEvent; use Symfony\Component\EventDispatcher\EventSubscriberInterface; +/** + * Class EventSubscriber + * + * @package N98\Magento\Command\ComposerWrapper + */ class EventSubscriber implements EventSubscriberInterface { /** diff --git a/src/N98/Magento/Command/Config/AbstractConfigCommand.php b/src/N98/Magento/Command/Config/AbstractConfigCommand.php index f644fa62d..1a11d929d 100644 --- a/src/N98/Magento/Command/Config/AbstractConfigCommand.php +++ b/src/N98/Magento/Command/Config/AbstractConfigCommand.php @@ -6,6 +6,11 @@ use Mage; use N98\Magento\Command\AbstractMagentoCommand; +/** + * Class AbstractConfigCommand + * + * @package N98\Magento\Command\Config + */ abstract class AbstractConfigCommand extends AbstractMagentoCommand { public const DISPLAY_NULL_UNKNOWN_VALUE = "NULL (NULL/\"unknown\" value)"; diff --git a/src/N98/Magento/Command/Config/DeleteCommand.php b/src/N98/Magento/Command/Config/DeleteCommand.php index 9927f6be4..8f288f0e4 100644 --- a/src/N98/Magento/Command/Config/DeleteCommand.php +++ b/src/N98/Magento/Command/Config/DeleteCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Delete config command + * + * @package N98\Magento\Command\Config + */ class DeleteCommand extends AbstractConfigCommand { protected function configure() diff --git a/src/N98/Magento/Command/Config/DumpCommand.php b/src/N98/Magento/Command/Config/DumpCommand.php index 8ae198268..f5ddd4c53 100644 --- a/src/N98/Magento/Command/Config/DumpCommand.php +++ b/src/N98/Magento/Command/Config/DumpCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Dump config command + * + * @package N98\Magento\Command\Config + */ class DumpCommand extends AbstractConfigCommand { protected function configure() diff --git a/src/N98/Magento/Command/Config/GetCommand.php b/src/N98/Magento/Command/Config/GetCommand.php index 20c01c16d..ac4733edd 100644 --- a/src/N98/Magento/Command/Config/GetCommand.php +++ b/src/N98/Magento/Command/Config/GetCommand.php @@ -10,6 +10,11 @@ use Symfony\Component\Console\Output\OutputInterface; use UnexpectedValueException; +/** + * Get config command + * + * @package N98\Magento\Command\Config + */ class GetCommand extends AbstractConfigCommand { protected function configure() diff --git a/src/N98/Magento/Command/Config/SearchCommand.php b/src/N98/Magento/Command/Config/SearchCommand.php index 61313e9cf..1e64d125a 100644 --- a/src/N98/Magento/Command/Config/SearchCommand.php +++ b/src/N98/Magento/Command/Config/SearchCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Search config command + * + * @package N98\Magento\Command\Config + */ class SearchCommand extends AbstractConfigCommand { protected function configure() diff --git a/src/N98/Magento/Command/Config/SetCommand.php b/src/N98/Magento/Command/Config/SetCommand.php index 335abc1ac..8a3c28131 100644 --- a/src/N98/Magento/Command/Config/SetCommand.php +++ b/src/N98/Magento/Command/Config/SetCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Set config command + * + * @package N98\Magento\Command\Config + */ class SetCommand extends AbstractConfigCommand { protected function configure() diff --git a/src/N98/Magento/Command/Customer/ChangePasswordCommand.php b/src/N98/Magento/Command/Customer/ChangePasswordCommand.php index 89e6061bf..05e0878ff 100644 --- a/src/N98/Magento/Command/Customer/ChangePasswordCommand.php +++ b/src/N98/Magento/Command/Customer/ChangePasswordCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\Question; +/** + * Change customer password command + * + * @package N98\Magento\Command\Customer + */ class ChangePasswordCommand extends AbstractCustomerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Customer/CreateCommand.php b/src/N98/Magento/Command/Customer/CreateCommand.php index d52ee176b..59b8b6ec0 100644 --- a/src/N98/Magento/Command/Customer/CreateCommand.php +++ b/src/N98/Magento/Command/Customer/CreateCommand.php @@ -10,6 +10,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\Question; +/** + * Create customer command + * + * @package N98\Magento\Command\Customer + */ class CreateCommand extends AbstractCustomerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Customer/CreateDummyCommand.php b/src/N98/Magento/Command/Customer/CreateDummyCommand.php index 8d107bc17..bcbccb2dc 100644 --- a/src/N98/Magento/Command/Customer/CreateDummyCommand.php +++ b/src/N98/Magento/Command/Customer/CreateDummyCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Create customer dummy command + * + * @package N98\Magento\Command\Customer + */ class CreateDummyCommand extends AbstractCustomerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Customer/DeleteCommand.php b/src/N98/Magento/Command/Customer/DeleteCommand.php index cc3d68aab..6ccb5b6c2 100644 --- a/src/N98/Magento/Command/Customer/DeleteCommand.php +++ b/src/N98/Magento/Command/Customer/DeleteCommand.php @@ -17,7 +17,8 @@ use Symfony\Component\Console\Question\Question; /** - * Class DeleteCommand + * Delete customer command + * * @package N98\Magento\Command\Customer */ class DeleteCommand extends AbstractCustomerCommand diff --git a/src/N98/Magento/Command/Customer/InfoCommand.php b/src/N98/Magento/Command/Customer/InfoCommand.php index e79bd5c29..8a541aee0 100644 --- a/src/N98/Magento/Command/Customer/InfoCommand.php +++ b/src/N98/Magento/Command/Customer/InfoCommand.php @@ -10,6 +10,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Customer info command + * + * @package N98\Magento\Command\Customer + */ class InfoCommand extends AbstractCustomerCommand { /** diff --git a/src/N98/Magento/Command/Customer/ListCommand.php b/src/N98/Magento/Command/Customer/ListCommand.php index 2eafea8a9..a5c2ac439 100644 --- a/src/N98/Magento/Command/Customer/ListCommand.php +++ b/src/N98/Magento/Command/Customer/ListCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List customer command + * + * @package N98\Magento\Command\Customer + */ class ListCommand extends AbstractCustomerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/AbstractDatabaseCommand.php b/src/N98/Magento/Command/Database/AbstractDatabaseCommand.php index 45ae4da1b..0fb8cb190 100644 --- a/src/N98/Magento/Command/Database/AbstractDatabaseCommand.php +++ b/src/N98/Magento/Command/Database/AbstractDatabaseCommand.php @@ -9,6 +9,11 @@ use N98\Util\Console\Helper\DatabaseHelper; use Symfony\Component\Console\Output\OutputInterface; +/** + * Class AbstractDatabaseCommand + * + * @package N98\Magento\Command\Database + */ abstract class AbstractDatabaseCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/Database/AbstractShowCommand.php b/src/N98/Magento/Command/Database/AbstractShowCommand.php index 815194199..a70efa618 100644 --- a/src/N98/Magento/Command/Database/AbstractShowCommand.php +++ b/src/N98/Magento/Command/Database/AbstractShowCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Class AbstractShowCommand + * + * @package N98\Magento\Command\Database + */ abstract class AbstractShowCommand extends AbstractDatabaseCommand { protected $showMethod = 'getGlobalVariables'; diff --git a/src/N98/Magento/Command/Database/Compressor/AbstractCompressor.php b/src/N98/Magento/Command/Database/Compressor/AbstractCompressor.php index 2ad59b10a..6196e1807 100644 --- a/src/N98/Magento/Command/Database/Compressor/AbstractCompressor.php +++ b/src/N98/Magento/Command/Database/Compressor/AbstractCompressor.php @@ -5,6 +5,11 @@ use InvalidArgumentException; use N98\Util\OperatingSystem; +/** + * Class AbstractCompressor + * + * @package N98\Magento\Command\Database\Compressor + */ abstract class AbstractCompressor implements Compressor { /** diff --git a/src/N98/Magento/Command/Database/Compressor/Compressor.php b/src/N98/Magento/Command/Database/Compressor/Compressor.php index 9d5af1b9f..01cb24013 100644 --- a/src/N98/Magento/Command/Database/Compressor/Compressor.php +++ b/src/N98/Magento/Command/Database/Compressor/Compressor.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\Database\Compressor; @@ -11,6 +6,8 @@ * Interface Compressor * * @package N98\Magento\Command\Database\Compressor + * + * @author Tom Klingenberg (https://github.com/ktomk) */ interface Compressor { diff --git a/src/N98/Magento/Command/Database/Compressor/Gzip.php b/src/N98/Magento/Command/Database/Compressor/Gzip.php index 9080da02e..db81ad25c 100644 --- a/src/N98/Magento/Command/Database/Compressor/Gzip.php +++ b/src/N98/Magento/Command/Database/Compressor/Gzip.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command\Database\Compressor; +/** + * Class Gzip + * + * @package N98\Magento\Command\Database\Compressor + */ class Gzip extends AbstractCompressor { /** diff --git a/src/N98/Magento/Command/Database/Compressor/Uncompressed.php b/src/N98/Magento/Command/Database/Compressor/Uncompressed.php index 1e3ca8ec4..6ac005299 100644 --- a/src/N98/Magento/Command/Database/Compressor/Uncompressed.php +++ b/src/N98/Magento/Command/Database/Compressor/Uncompressed.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command\Database\Compressor; +/** + * Class Uncompressed + * + * @package N98\Magento\Command\Database\Compressor + */ class Uncompressed extends AbstractCompressor { /** diff --git a/src/N98/Magento/Command/Database/ConsoleCommand.php b/src/N98/Magento/Command/Database/ConsoleCommand.php index 2a8b6fa25..9da04fcbc 100644 --- a/src/N98/Magento/Command/Database/ConsoleCommand.php +++ b/src/N98/Magento/Command/Database/ConsoleCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Database console command + * + * @package N98\Magento\Command\Database + */ class ConsoleCommand extends AbstractDatabaseCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/CreateCommand.php b/src/N98/Magento/Command/Database/CreateCommand.php index 9b187e3f9..75b089b32 100644 --- a/src/N98/Magento/Command/Database/CreateCommand.php +++ b/src/N98/Magento/Command/Database/CreateCommand.php @@ -5,6 +5,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Create database command + * + * @package N98\Magento\Command\Database + */ class CreateCommand extends AbstractDatabaseCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/DropCommand.php b/src/N98/Magento/Command/Database/DropCommand.php index e0d2ddaeb..745e0173c 100644 --- a/src/N98/Magento/Command/Database/DropCommand.php +++ b/src/N98/Magento/Command/Database/DropCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\ConfirmationQuestion; +/** + * Drop database command + * + * @package N98\Magento\Command\Database + */ class DropCommand extends AbstractDatabaseCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/DumpCommand.php b/src/N98/Magento/Command/Database/DumpCommand.php index 0628baa50..b3df070c3 100644 --- a/src/N98/Magento/Command/Database/DumpCommand.php +++ b/src/N98/Magento/Command/Database/DumpCommand.php @@ -15,6 +15,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\Question; +/** + * Dump database command + * + * @package N98\Magento\Command\Database + */ class DumpCommand extends AbstractDatabaseCommand { /** diff --git a/src/N98/Magento/Command/Database/ImportCommand.php b/src/N98/Magento/Command/Database/ImportCommand.php index 84a45509d..8cbc1258f 100644 --- a/src/N98/Magento/Command/Database/ImportCommand.php +++ b/src/N98/Magento/Command/Database/ImportCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Import database command + * + * @package N98\Magento\Command\Database + */ class ImportCommand extends AbstractDatabaseCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/InfoCommand.php b/src/N98/Magento/Command/Database/InfoCommand.php index 0cf686324..e9bfed1da 100644 --- a/src/N98/Magento/Command/Database/InfoCommand.php +++ b/src/N98/Magento/Command/Database/InfoCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Database info command + * + * @package N98\Magento\Command\Database + */ class InfoCommand extends AbstractDatabaseCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php b/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php index 8fce099c5..ea367a1d9 100644 --- a/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php +++ b/src/N98/Magento/Command/Database/Maintain/CheckTablesCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Check database command + * + * @package N98\Magento\Command\Database\Maintain + */ class CheckTablesCommand extends AbstractMagentoCommand { public const MESSAGE_CHECK_NOT_SUPPORTED = 'The storage engine for the table doesn\'t support check'; diff --git a/src/N98/Magento/Command/Database/QueryCommand.php b/src/N98/Magento/Command/Database/QueryCommand.php index a76838516..a336bc42b 100644 --- a/src/N98/Magento/Command/Database/QueryCommand.php +++ b/src/N98/Magento/Command/Database/QueryCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Query database command + * + * @package N98\Magento\Command\Database + */ class QueryCommand extends AbstractDatabaseCommand { protected function configure() diff --git a/src/N98/Magento/Command/Database/StatusCommand.php b/src/N98/Magento/Command/Database/StatusCommand.php index dec02132a..79d11f3ed 100644 --- a/src/N98/Magento/Command/Database/StatusCommand.php +++ b/src/N98/Magento/Command/Database/StatusCommand.php @@ -4,6 +4,11 @@ use DateTime; +/** + * Show database status command + * + * @package N98\Magento\Command\Database + */ class StatusCommand extends AbstractShowCommand { protected $showMethod = 'getGlobalStatus'; diff --git a/src/N98/Magento/Command/Database/VariablesCommand.php b/src/N98/Magento/Command/Database/VariablesCommand.php index 5f313be81..361911b4e 100644 --- a/src/N98/Magento/Command/Database/VariablesCommand.php +++ b/src/N98/Magento/Command/Database/VariablesCommand.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command\Database; +/** + * Show database variables command + * + * @package N98\Magento\Command\Database + */ class VariablesCommand extends AbstractShowCommand { /** diff --git a/src/N98/Magento/Command/Design/DemoNoticeCommand.php b/src/N98/Magento/Command/Design/DemoNoticeCommand.php index 9ebfc4f13..0d7c60c6a 100644 --- a/src/N98/Magento/Command/Design/DemoNoticeCommand.php +++ b/src/N98/Magento/Command/Design/DemoNoticeCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle demo notice command + * + * @package N98\Magento\Command\Design + */ class DemoNoticeCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/ClassLookupCommand.php b/src/N98/Magento/Command/Developer/ClassLookupCommand.php index 20126eb5a..bd2d4bbb5 100644 --- a/src/N98/Magento/Command/Developer/ClassLookupCommand.php +++ b/src/N98/Magento/Command/Developer/ClassLookupCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Class lookup command + * + * @package N98\Magento\Command\Developer + */ class ClassLookupCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Code/Model/MethodCommand.php b/src/N98/Magento/Command/Developer/Code/Model/MethodCommand.php index 3213e2439..0e264b3d4 100644 --- a/src/N98/Magento/Command/Developer/Code/Model/MethodCommand.php +++ b/src/N98/Magento/Command/Developer/Code/Model/MethodCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Create method annotation command + * + * @package N98\Magento\Command\Developer\Code\Model + */ class MethodCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/Developer/Console/Psy/Shell.php b/src/N98/Magento/Command/Developer/Console/Psy/Shell.php index 6c7dad18f..9ce128386 100644 --- a/src/N98/Magento/Command/Developer/Console/Psy/Shell.php +++ b/src/N98/Magento/Command/Developer/Console/Psy/Shell.php @@ -5,6 +5,11 @@ use Psy\Configuration; use Psy\Shell as BaseShell; +/** + * Shell command + * + * @package N98\Magento\Command\Developer\Console\Psy + */ class Shell extends BaseShell { public function __construct(Configuration $config = null) diff --git a/src/N98/Magento/Command/Developer/ConsoleCommand.php b/src/N98/Magento/Command/Developer/ConsoleCommand.php index 8ca6127df..4fba20c89 100644 --- a/src/N98/Magento/Command/Developer/ConsoleCommand.php +++ b/src/N98/Magento/Command/Developer/ConsoleCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Console command + * + * @package N98\Magento\Command\Developer + */ class ConsoleCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/EmailTemplate/UsageCommand.php b/src/N98/Magento/Command/Developer/EmailTemplate/UsageCommand.php index 9617d0b3c..8415bebf9 100644 --- a/src/N98/Magento/Command/Developer/EmailTemplate/UsageCommand.php +++ b/src/N98/Magento/Command/Developer/EmailTemplate/UsageCommand.php @@ -1,10 +1,4 @@ - * @author Tom Klingenberg - */ namespace N98\Magento\Command\Developer\EmailTemplate; @@ -17,6 +11,14 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List email template usage command + * + * @package N98\Magento\Command\Developer\EmailTemplate + * + * @author Mike Parkin (https://github.com/MikeParkin) + * @author Tom Klingenberg (https://github.com/ktomk) + */ class UsageCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Ide/PhpStorm/MetaCommand.php b/src/N98/Magento/Command/Developer/Ide/PhpStorm/MetaCommand.php index d8a54b43d..cbc991c6f 100644 --- a/src/N98/Magento/Command/Developer/Ide/PhpStorm/MetaCommand.php +++ b/src/N98/Magento/Command/Developer/Ide/PhpStorm/MetaCommand.php @@ -14,6 +14,11 @@ use UnexpectedValueException; use Varien_Simplexml_Element; +/** + * Create phpStorm meta-files command + * + * @package N98\Magento\Command\Developer\Ide\PhpStorm + */ class MetaCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/Developer/Log/AbstractLogCommand.php b/src/N98/Magento/Command/Developer/Log/AbstractLogCommand.php index ed5a46c79..63f13dfc1 100644 --- a/src/N98/Magento/Command/Developer/Log/AbstractLogCommand.php +++ b/src/N98/Magento/Command/Developer/Log/AbstractLogCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Question\Question; use Symfony\Component\Finder\Finder; +/** + * Class AbstractLogCommand + * + * @package N98\Magento\Command\Developer\Log + */ class AbstractLogCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/Developer/Log/DbCommand.php b/src/N98/Magento/Command/Developer/Log/DbCommand.php index 08410e814..51cce83ef 100644 --- a/src/N98/Magento/Command/Developer/Log/DbCommand.php +++ b/src/N98/Magento/Command/Developer/Log/DbCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Toggle database log command + * + * @package N98\Magento\Command\Developer\Log + */ class DbCommand extends AbstractLogCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Log/LogCommand.php b/src/N98/Magento/Command/Developer/Log/LogCommand.php index 82b939f9d..6b2ef8051 100644 --- a/src/N98/Magento/Command/Developer/Log/LogCommand.php +++ b/src/N98/Magento/Command/Developer/Log/LogCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle log command + * + * @package N98\Magento\Command\Developer\Log + */ class LogCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/Log/SizeCommand.php b/src/N98/Magento/Command/Developer/Log/SizeCommand.php index d8d1cafd1..d6349394a 100644 --- a/src/N98/Magento/Command/Developer/Log/SizeCommand.php +++ b/src/N98/Magento/Command/Developer/Log/SizeCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Get log size command + * + * @package N98\Magento\Command\Developer\Log + */ class SizeCommand extends AbstractLogCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/MergeCssCommand.php b/src/N98/Magento/Command/Developer/MergeCssCommand.php index fbc36b936..7dfe2e281 100644 --- a/src/N98/Magento/Command/Developer/MergeCssCommand.php +++ b/src/N98/Magento/Command/Developer/MergeCssCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle CSS merge command + * + * @package N98\Magento\Command\Developer + */ class MergeCssCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/MergeJsCommand.php b/src/N98/Magento/Command/Developer/MergeJsCommand.php index 8e7004aca..151393c51 100644 --- a/src/N98/Magento/Command/Developer/MergeJsCommand.php +++ b/src/N98/Magento/Command/Developer/MergeJsCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle JS merge command + * + * @package N98\Magento\Command\Developer + */ class MergeJsCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/Module/CreateCommand.php b/src/N98/Magento/Command/Developer/Module/CreateCommand.php index 7f444acd9..d625899e9 100644 --- a/src/N98/Magento/Command/Developer/Module/CreateCommand.php +++ b/src/N98/Magento/Command/Developer/Module/CreateCommand.php @@ -12,7 +12,9 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Create a magento module skeleton + * Create module skeleton command + * + * @package N98\Magento\Command\Developer\Module */ class CreateCommand extends AbstractMagentoCommand { diff --git a/src/N98/Magento/Command/Developer/Module/Dependencies/AbstractCommand.php b/src/N98/Magento/Command/Developer/Module/Dependencies/AbstractCommand.php index bef21e8b0..db715eed1 100644 --- a/src/N98/Magento/Command/Developer/Module/Dependencies/AbstractCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Dependencies/AbstractCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Class AbstractCommand + * + * @package N98\Magento\Command\Developer\Module\Dependencies + */ abstract class AbstractCommand extends AbstractMagentoCommand { /**#@+ diff --git a/src/N98/Magento/Command/Developer/Module/Dependencies/FromCommand.php b/src/N98/Magento/Command/Developer/Module/Dependencies/FromCommand.php index 8ada911a6..be0189dac 100644 --- a/src/N98/Magento/Command/Developer/Module/Dependencies/FromCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Dependencies/FromCommand.php @@ -5,6 +5,11 @@ use InvalidArgumentException; use Mage; +/** + * List dependencies from command + * + * @package N98\Magento\Command\Developer\Module\Dependencies + */ class FromCommand extends AbstractCommand { /**#@+ diff --git a/src/N98/Magento/Command/Developer/Module/Dependencies/OnCommand.php b/src/N98/Magento/Command/Developer/Module/Dependencies/OnCommand.php index 7e7833c58..8ff7e4280 100644 --- a/src/N98/Magento/Command/Developer/Module/Dependencies/OnCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Dependencies/OnCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * List dependencies on command + * + * @package N98\Magento\Command\Developer\Module\Dependencies + */ class OnCommand extends AbstractMagentoCommand { private $modules; diff --git a/src/N98/Magento/Command/Developer/Module/Disableenable/AbstractCommand.php b/src/N98/Magento/Command/Developer/Module/Disableenable/AbstractCommand.php index fec61e825..52a2c94af 100644 --- a/src/N98/Magento/Command/Developer/Module/Disableenable/AbstractCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Disableenable/AbstractCommand.php @@ -13,7 +13,9 @@ use Varien_Simplexml_Element; /** - * Enable disable Magento module(s) + * Class AbstractCommand + * + * @package N98\Magento\Command\Developer\Module\Disableenable */ class AbstractCommand extends AbstractMagentoCommand { diff --git a/src/N98/Magento/Command/Developer/Module/Disableenable/DisableCommand.php b/src/N98/Magento/Command/Developer/Module/Disableenable/DisableCommand.php index 377ea83fb..5f8936d20 100644 --- a/src/N98/Magento/Command/Developer/Module/Disableenable/DisableCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Disableenable/DisableCommand.php @@ -3,7 +3,9 @@ namespace N98\Magento\Command\Developer\Module\Disableenable; /** - * Disable Magento module(s) + * Disable module(s) command + * + * @package N98\Magento\Command\Developer\Module\Disableenable */ class DisableCommand extends AbstractCommand { diff --git a/src/N98/Magento/Command/Developer/Module/Disableenable/EnableCommand.php b/src/N98/Magento/Command/Developer/Module/Disableenable/EnableCommand.php index 36455c1c7..0fd59dda3 100644 --- a/src/N98/Magento/Command/Developer/Module/Disableenable/EnableCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Disableenable/EnableCommand.php @@ -3,7 +3,9 @@ namespace N98\Magento\Command\Developer\Module\Disableenable; /** - * Enable Magento module(s) + * Enable module(s) command + * + * @package N98\Magento\Command\Developer\Module\Disableenable */ class EnableCommand extends AbstractCommand { diff --git a/src/N98/Magento/Command/Developer/Module/ListCommand.php b/src/N98/Magento/Command/Developer/Module/ListCommand.php index 4447b510d..416dcf34a 100644 --- a/src/N98/Magento/Command/Developer/Module/ListCommand.php +++ b/src/N98/Magento/Command/Developer/Module/ListCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * List modules command + * + * @package N98\Magento\Command\Developer\Module + */ class ListCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Module/Observer/ListCommand.php b/src/N98/Magento/Command/Developer/Module/Observer/ListCommand.php index 73f4afe16..62e974c17 100644 --- a/src/N98/Magento/Command/Developer/Module/Observer/ListCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Observer/ListCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * List observer command + * + * @package N98\Magento\Command\Developer\Module\Observer + */ class ListCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/AbstractRewriteCommand.php b/src/N98/Magento/Command/Developer/Module/Rewrite/AbstractRewriteCommand.php index a0f4f9555..77efaeba5 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/AbstractRewriteCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/AbstractRewriteCommand.php @@ -6,6 +6,11 @@ use N98\Magento\Command\AbstractMagentoCommand; use Symfony\Component\Finder\Finder; +/** + * Class AbstractRewriteCommand + * + * @package N98\Magento\Command\Developer\Module\Rewrite + */ abstract class AbstractRewriteCommand extends AbstractMagentoCommand { protected $_rewriteTypes = ['blocks', 'helpers', 'models']; diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/CanNotAutoloadCollaboratorClassException.php b/src/N98/Magento/Command/Developer/Module/Rewrite/CanNotAutoloadCollaboratorClassException.php index 9e8fc38da..291547aa7 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/CanNotAutoloadCollaboratorClassException.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/CanNotAutoloadCollaboratorClassException.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\Developer\Module\Rewrite; @@ -13,6 +8,8 @@ * Class CanNotAutoloadParentClassException * * @package N98\Magento\Command\Developer\Module\Rewrite + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class CanNotAutoloadCollaboratorClassException extends Exception { diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsChecker.php b/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsChecker.php index 4acc8f9b4..b22d27cf6 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsChecker.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsChecker.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\Developer\Module\Rewrite; @@ -16,6 +11,8 @@ * More robust (against fatal errors in the inheritance chain) class_exists checker * * @package N98\Magento\Command\Developer\Module\Rewrite + * + * @author Tom Klingenberg (https://github.com/ktomk) */ final class ClassExistsChecker { diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsThrownException.php b/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsThrownException.php index ef07c5f98..d0461ff5f 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsThrownException.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/ClassExistsThrownException.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\Developer\Module\Rewrite; @@ -15,6 +10,8 @@ * The previous exception is the one that was thrown within the class exists check * * @package N98\Magento\Command\Developer\Module\Rewrite + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class ClassExistsThrownException extends RuntimeException { diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/ClassUtil.php b/src/N98/Magento/Command/Developer/Module/Rewrite/ClassUtil.php index 5aec5ef53..e4080a8b7 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/ClassUtil.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/ClassUtil.php @@ -1,12 +1,14 @@ - */ namespace N98\Magento\Command\Developer\Module\Rewrite; +/** + * Class ClassUtil + * + * @package N98\Magento\Command\Developer\Module\Rewrite + * + * @author Tom Klingenberg (https://github.com/ktomk) + */ final class ClassUtil { /** diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php b/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php index 956a3814d..62ec129c1 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/ConflictsCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Zend_Text_Table; +/** + * List module conflicts command + * + * @package N98\Magento\Command\Developer\Module\Rewrite + */ class ConflictsCommand extends AbstractRewriteCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Module/Rewrite/ListCommand.php b/src/N98/Magento/Command/Developer/Module/Rewrite/ListCommand.php index 912205015..876d7605c 100644 --- a/src/N98/Magento/Command/Developer/Module/Rewrite/ListCommand.php +++ b/src/N98/Magento/Command/Developer/Module/Rewrite/ListCommand.php @@ -6,6 +6,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List module rewrites command + * + * @package N98\Magento\Command\Developer\Module\Rewrite + */ class ListCommand extends AbstractRewriteCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Module/UpdateCommand.php b/src/N98/Magento/Command/Developer/Module/UpdateCommand.php index 5439a50a7..10eac14f0 100644 --- a/src/N98/Magento/Command/Developer/Module/UpdateCommand.php +++ b/src/N98/Magento/Command/Developer/Module/UpdateCommand.php @@ -18,7 +18,9 @@ use Symfony\Component\Validator\Constraints\Choice; /** - * Update a magento module + * Update module command + * + * @package N98\Magento\Command\Developer\Module */ class UpdateCommand extends AbstractMagentoCommand { diff --git a/src/N98/Magento/Command/Developer/ProfilerCommand.php b/src/N98/Magento/Command/Developer/ProfilerCommand.php index 4e34caa71..f5cdf7500 100644 --- a/src/N98/Magento/Command/Developer/ProfilerCommand.php +++ b/src/N98/Magento/Command/Developer/ProfilerCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle profiler command + * + * @package N98\Magento\Command\Developer + */ class ProfilerCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/Report/CountCommand.php b/src/N98/Magento/Command/Developer/Report/CountCommand.php index 0591f1ac9..e08b5c397 100644 --- a/src/N98/Magento/Command/Developer/Report/CountCommand.php +++ b/src/N98/Magento/Command/Developer/Report/CountCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Finder\Finder; +/** + * Count report command + * + * @package N98\Magento\Command\Developer\Report + */ class CountCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/CatalogProduct.php b/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/CatalogProduct.php index 8458dcb60..536578aea 100644 --- a/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/CatalogProduct.php +++ b/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/CatalogProduct.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command\Developer\Setup\Script\Attribute\EntityType; +/** + * Class CatalogProduct + * + * @package N98\Magento\Command\Developer\Setup\Script\Attribute\EntityType + */ class CatalogProduct extends AbstractEntityType implements EntityType { /** diff --git a/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/EntityType.php b/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/EntityType.php index 397fb9841..28c56ad17 100644 --- a/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/EntityType.php +++ b/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/EntityType.php @@ -4,6 +4,11 @@ use Mage_Eav_Model_Entity_Attribute; +/** + * EntityType interface + * + * @package N98\Magento\Command\Developer\Setup\Script\Attribute\EntityType + */ interface EntityType { /** diff --git a/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/Factory.php b/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/Factory.php index 8c3ba2390..6a870086a 100644 --- a/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/Factory.php +++ b/src/N98/Magento/Command/Developer/Setup/Script/Attribute/EntityType/Factory.php @@ -4,6 +4,11 @@ use RuntimeException; +/** + * Class Factory + * + * @package N98\Magento\Command\Developer\Setup\Script\Attribute\EntityType + */ class Factory { /** diff --git a/src/N98/Magento/Command/Developer/Setup/Script/AttributeCommand.php b/src/N98/Magento/Command/Developer/Setup/Script/AttributeCommand.php index c504f7a2a..ac337677d 100644 --- a/src/N98/Magento/Command/Developer/Setup/Script/AttributeCommand.php +++ b/src/N98/Magento/Command/Developer/Setup/Script/AttributeCommand.php @@ -1,16 +1,4 @@ - */ namespace N98\Magento\Command\Developer\Setup\Script; @@ -21,6 +9,20 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Creates attribute script for existing attribute command + * + * Ported attribute migration script from: + * + * https://github.com/astorm/Pulsestorm/blob/master/magento-create-setup.php + * https://github.com/astorm/Pulsestorm/blob/2863201b19367d02483e01b1c03b54b979d87278/_trash/magento-create-setup.php + * + * Originally created by Alan Storm + * + * @package N98\Magento\Command\Developer\Setup\Script + * + * @author Dusan Lukic + */ class AttributeCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/SymlinksCommand.php b/src/N98/Magento/Command/Developer/SymlinksCommand.php index 003c2ba31..c02632449 100644 --- a/src/N98/Magento/Command/Developer/SymlinksCommand.php +++ b/src/N98/Magento/Command/Developer/SymlinksCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle symlinks command + * + * @package N98\Magento\Command\Developer + */ class SymlinksCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/TemplateHintsBlocksCommand.php b/src/N98/Magento/Command/Developer/TemplateHintsBlocksCommand.php index f1dd11fd4..d0e848c7c 100644 --- a/src/N98/Magento/Command/Developer/TemplateHintsBlocksCommand.php +++ b/src/N98/Magento/Command/Developer/TemplateHintsBlocksCommand.php @@ -5,6 +5,11 @@ use Mage_Core_Model_Store; use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle template blocks hints command + * + * @package N98\Magento\Command\Developer + */ class TemplateHintsBlocksCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/TemplateHintsCommand.php b/src/N98/Magento/Command/Developer/TemplateHintsCommand.php index 00b10c102..896af9f66 100644 --- a/src/N98/Magento/Command/Developer/TemplateHintsCommand.php +++ b/src/N98/Magento/Command/Developer/TemplateHintsCommand.php @@ -5,6 +5,11 @@ use Mage_Core_Model_Store; use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle template hints command + * + * @package N98\Magento\Command\Developer + */ class TemplateHintsCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php b/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php index b61e38427..72565a8b2 100644 --- a/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php +++ b/src/N98/Magento/Command/Developer/Theme/DuplicatesCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Finder\Finder; +/** + * Find duplicate theme command + * + * @package N98\Magento\Command\Developer\Theme + */ class DuplicatesCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Theme/InfoCommand.php b/src/N98/Magento/Command/Developer/Theme/InfoCommand.php index beaa52194..a7e7679d4 100644 --- a/src/N98/Magento/Command/Developer/Theme/InfoCommand.php +++ b/src/N98/Magento/Command/Developer/Theme/InfoCommand.php @@ -12,7 +12,8 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class InfoCommand + * Theme info command + * * @package N98\Magento\Command\Developer\Theme */ class InfoCommand extends AbstractMagentoCommand diff --git a/src/N98/Magento/Command/Developer/Theme/ListCommand.php b/src/N98/Magento/Command/Developer/Theme/ListCommand.php index 18e50c58f..a6ea56bc8 100644 --- a/src/N98/Magento/Command/Developer/Theme/ListCommand.php +++ b/src/N98/Magento/Command/Developer/Theme/ListCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List theme command + * + * @package N98\Magento\Command\Developer\Theme + */ class ListCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Translate/ExportCommand.php b/src/N98/Magento/Command/Developer/Translate/ExportCommand.php index 812c4b058..b7e7f1b2e 100644 --- a/src/N98/Magento/Command/Developer/Translate/ExportCommand.php +++ b/src/N98/Magento/Command/Developer/Translate/ExportCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Export translation command + * + * @package N98\Magento\Command\Developer\Translate + */ class ExportCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Developer/Translate/InlineAdminCommand.php b/src/N98/Magento/Command/Developer/Translate/InlineAdminCommand.php index 9d10c2292..520bc655d 100644 --- a/src/N98/Magento/Command/Developer/Translate/InlineAdminCommand.php +++ b/src/N98/Magento/Command/Developer/Translate/InlineAdminCommand.php @@ -5,6 +5,11 @@ use Mage_Core_Model_Store; use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle admin inline translation command + * + * @package N98\Magento\Command\Developer\Translate + */ class InlineAdminCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/Translate/InlineShopCommand.php b/src/N98/Magento/Command/Developer/Translate/InlineShopCommand.php index 13bbe6805..840ff3cd0 100644 --- a/src/N98/Magento/Command/Developer/Translate/InlineShopCommand.php +++ b/src/N98/Magento/Command/Developer/Translate/InlineShopCommand.php @@ -5,6 +5,11 @@ use Mage_Core_Model_Store; use N98\Magento\Command\AbstractMagentoStoreConfigCommand; +/** + * Toggle shop inline translation command + * + * @package N98\Magento\Command\Developer\Translate + */ class InlineShopCommand extends AbstractMagentoStoreConfigCommand { /** diff --git a/src/N98/Magento/Command/Developer/Translate/SetCommand.php b/src/N98/Magento/Command/Developer/Translate/SetCommand.php index 68421dc4d..0a5c8b267 100644 --- a/src/N98/Magento/Command/Developer/Translate/SetCommand.php +++ b/src/N98/Magento/Command/Developer/Translate/SetCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\NullOutput; use Symfony\Component\Console\Output\OutputInterface; +/** + * Set translation command + * + * @package N98\Magento\Command\Developer\Translate + */ class SetCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php b/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php index 54b02c2a0..8777abef9 100644 --- a/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php +++ b/src/N98/Magento/Command/Eav/Attribute/Create/DummyCommand.php @@ -15,6 +15,11 @@ use Symfony\Component\Console\Question\ChoiceQuestion; use Symfony\Component\Console\Question\Question; +/** + * Create EAV attribute dummy command + * + * @package N98\Magento\Command\Eav\Attribute\Create + */ class DummyCommand extends AbstractMagentoCommand { private $supportedLocales = ['en_US', 'en_GB']; diff --git a/src/N98/Magento/Command/Eav/Attribute/Create/DummyValues.php b/src/N98/Magento/Command/Eav/Attribute/Create/DummyValues.php index 64641fdd0..956d7244d 100644 --- a/src/N98/Magento/Command/Eav/Attribute/Create/DummyValues.php +++ b/src/N98/Magento/Command/Eav/Attribute/Create/DummyValues.php @@ -4,6 +4,11 @@ use Faker\Factory; +/** + * Class DummyValues + * + * @package N98\Magento\Command\Eav\Attribute\Create + */ class DummyValues { private $faker; diff --git a/src/N98/Magento/Command/Eav/Attribute/ListCommand.php b/src/N98/Magento/Command/Eav/Attribute/ListCommand.php index a89441965..6db5e28b4 100644 --- a/src/N98/Magento/Command/Eav/Attribute/ListCommand.php +++ b/src/N98/Magento/Command/Eav/Attribute/ListCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * List EAV attributes command + * + * @package N98\Magento\Command\Eav\Attribute + */ class ListCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Eav/Attribute/RemoveCommand.php b/src/N98/Magento/Command/Eav/Attribute/RemoveCommand.php index a8cd93c0d..40f5507ac 100644 --- a/src/N98/Magento/Command/Eav/Attribute/RemoveCommand.php +++ b/src/N98/Magento/Command/Eav/Attribute/RemoveCommand.php @@ -12,8 +12,10 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class RemoveCommand + * Remove EAV attribute command + * * @package N98\Magento\Command\Eav\Attribute + * * @author Aydin Hassan */ class RemoveCommand extends AbstractMagentoCommand diff --git a/src/N98/Magento/Command/Eav/Attribute/ViewCommand.php b/src/N98/Magento/Command/Eav/Attribute/ViewCommand.php index e3c77fc5c..f9afc66e6 100644 --- a/src/N98/Magento/Command/Eav/Attribute/ViewCommand.php +++ b/src/N98/Magento/Command/Eav/Attribute/ViewCommand.php @@ -9,6 +9,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * View EAV attribute command + * + * @package N98\Magento\Command\Eav\Attribute + */ class ViewCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/GiftCard/AbstractGiftCardCommand.php b/src/N98/Magento/Command/GiftCard/AbstractGiftCardCommand.php index 1deaeb51e..b7a7031ad 100644 --- a/src/N98/Magento/Command/GiftCard/AbstractGiftCardCommand.php +++ b/src/N98/Magento/Command/GiftCard/AbstractGiftCardCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoCommand; +/** + * Class AbstractGiftCardCommand + * + * @package N98\Magento\Command\GiftCard + */ abstract class AbstractGiftCardCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/GiftCard/CreateCommand.php b/src/N98/Magento/Command/GiftCard/CreateCommand.php index 69d36767a..891ace802 100644 --- a/src/N98/Magento/Command/GiftCard/CreateCommand.php +++ b/src/N98/Magento/Command/GiftCard/CreateCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Create gift card command + * + * @package N98\Magento\Command\GiftCard + */ class CreateCommand extends AbstractGiftCardCommand { /** diff --git a/src/N98/Magento/Command/GiftCard/InfoCommand.php b/src/N98/Magento/Command/GiftCard/InfoCommand.php index fcb3948d4..2c06d0f21 100644 --- a/src/N98/Magento/Command/GiftCard/InfoCommand.php +++ b/src/N98/Magento/Command/GiftCard/InfoCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Gift card info command + * + * @package N98\Magento\Command\GiftCard + */ class InfoCommand extends AbstractGiftCardCommand { /** diff --git a/src/N98/Magento/Command/GiftCard/Pool/GenerateCommand.php b/src/N98/Magento/Command/GiftCard/Pool/GenerateCommand.php index 93ee4e441..4229551ed 100644 --- a/src/N98/Magento/Command/GiftCard/Pool/GenerateCommand.php +++ b/src/N98/Magento/Command/GiftCard/Pool/GenerateCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Generate gift card pool command + * + * @package N98\Magento\Command\GiftCard\Pool + */ class GenerateCommand extends AbstractGiftCardCommand { /** diff --git a/src/N98/Magento/Command/GiftCard/RemoveCommand.php b/src/N98/Magento/Command/GiftCard/RemoveCommand.php index 9b6a7c7af..33ed5d40c 100644 --- a/src/N98/Magento/Command/GiftCard/RemoveCommand.php +++ b/src/N98/Magento/Command/GiftCard/RemoveCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Remove gift card command + * + * @package N98\Magento\Command\GiftCard + */ class RemoveCommand extends AbstractGiftCardCommand { /** diff --git a/src/N98/Magento/Command/Indexer/AbstractMviewIndexerCommand.php b/src/N98/Magento/Command/Indexer/AbstractMviewIndexerCommand.php index 7ef89d658..d8862ad1f 100644 --- a/src/N98/Magento/Command/Indexer/AbstractMviewIndexerCommand.php +++ b/src/N98/Magento/Command/Indexer/AbstractMviewIndexerCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoCommand; +/** + * Class AbstractMviewIndexerCommand + * + * @package N98\Magento\Command\Indexer + */ class AbstractMviewIndexerCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/Indexer/ListCommand.php b/src/N98/Magento/Command/Indexer/ListCommand.php index 3a51657b9..fe2bac7f8 100644 --- a/src/N98/Magento/Command/Indexer/ListCommand.php +++ b/src/N98/Magento/Command/Indexer/ListCommand.php @@ -6,6 +6,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List index command + * + * @package N98\Magento\Command\Indexer + */ class ListCommand extends AbstractIndexerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Indexer/ListMviewCommand.php b/src/N98/Magento/Command/Indexer/ListMviewCommand.php index 799745848..944c23c78 100644 --- a/src/N98/Magento/Command/Indexer/ListMviewCommand.php +++ b/src/N98/Magento/Command/Indexer/ListMviewCommand.php @@ -6,6 +6,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List MView index command + * + * @package N98\Magento\Command\Indexer + */ class ListMviewCommand extends AbstractMviewIndexerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Indexer/ReindexAllCommand.php b/src/N98/Magento/Command/Indexer/ReindexAllCommand.php index 81af22a2e..872bc8607 100644 --- a/src/N98/Magento/Command/Indexer/ReindexAllCommand.php +++ b/src/N98/Magento/Command/Indexer/ReindexAllCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Reindex all command + * + * @package N98\Magento\Command\Indexer + */ class ReindexAllCommand extends AbstractIndexerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Indexer/ReindexCommand.php b/src/N98/Magento/Command/Indexer/ReindexCommand.php index 0c7a96c94..fa319d165 100644 --- a/src/N98/Magento/Command/Indexer/ReindexCommand.php +++ b/src/N98/Magento/Command/Indexer/ReindexCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Question\ChoiceQuestion; use Symfony\Component\Console\Question\Question; +/** + * Reindex command + * + * @package N98\Magento\Command\Indexer + */ class ReindexCommand extends AbstractIndexerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php b/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php index 8dbb5ffd4..8ccf47114 100644 --- a/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php +++ b/src/N98/Magento/Command/Indexer/ReindexMviewCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Reindex MView command + * + * @package N98\Magento\Command\Indexer + */ class ReindexMviewCommand extends AbstractMviewIndexerCommand { protected function configure() diff --git a/src/N98/Magento/Command/Installer/InstallCommand.php b/src/N98/Magento/Command/Installer/InstallCommand.php index f6890a51c..cba5d4b19 100644 --- a/src/N98/Magento/Command/Installer/InstallCommand.php +++ b/src/N98/Magento/Command/Installer/InstallCommand.php @@ -9,7 +9,7 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class InstallCommand + * Install command * * @codeCoverageIgnore - Travis server uses installer to create a new shop. If it not works complete build fails. * @package N98\Magento\Command\Installer @@ -22,7 +22,7 @@ class InstallCommand extends AbstractMagentoCommand protected $commandConfig; /** - * @var SubCommandFactory; + * @var SubCommandFactory */ protected $subCommandFactory; diff --git a/src/N98/Magento/Command/Installer/SubCommand/ChooseInstallationFolder.php b/src/N98/Magento/Command/Installer/SubCommand/ChooseInstallationFolder.php index 1728f75ba..34bb8a86a 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/ChooseInstallationFolder.php +++ b/src/N98/Magento/Command/Installer/SubCommand/ChooseInstallationFolder.php @@ -7,6 +7,7 @@ /** * Class ChooseInstallationFolder + * * @package N98\Magento\Command\Installer\SubCommand */ class ChooseInstallationFolder extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/CreateDatabase.php b/src/N98/Magento/Command/Installer/SubCommand/CreateDatabase.php index 1c83de52e..eb3a9bb3d 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/CreateDatabase.php +++ b/src/N98/Magento/Command/Installer/SubCommand/CreateDatabase.php @@ -10,6 +10,7 @@ /** * Class CreateDatabase + * * @package N98\Magento\Command\Installer\SubCommand */ class CreateDatabase extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/DownloadMagento.php b/src/N98/Magento/Command/Installer/SubCommand/DownloadMagento.php index a0f003ab0..91b652976 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/DownloadMagento.php +++ b/src/N98/Magento/Command/Installer/SubCommand/DownloadMagento.php @@ -15,6 +15,7 @@ /** * Class DownloadMagento + * * @package N98\Magento\Command\Installer\SubCommand */ class DownloadMagento extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/InstallComposer.php b/src/N98/Magento/Command/Installer/SubCommand/InstallComposer.php index b405d06e8..6080bd5c1 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/InstallComposer.php +++ b/src/N98/Magento/Command/Installer/SubCommand/InstallComposer.php @@ -9,6 +9,7 @@ /** * Class InstallComposer + * * @package N98\Magento\Command\Installer\SubCommand */ class InstallComposer extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/InstallComposerPackages.php b/src/N98/Magento/Command/Installer/SubCommand/InstallComposerPackages.php index 5ede87466..7ee02dad6 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/InstallComposerPackages.php +++ b/src/N98/Magento/Command/Installer/SubCommand/InstallComposerPackages.php @@ -7,6 +7,7 @@ /** * Class InstallComposerPackages + * * @package N98\Magento\Command\Installer\SubCommand */ class InstallComposerPackages extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/InstallMagento.php b/src/N98/Magento/Command/Installer/SubCommand/InstallMagento.php index 7260c181b..400a3eaef 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/InstallMagento.php +++ b/src/N98/Magento/Command/Installer/SubCommand/InstallMagento.php @@ -13,6 +13,7 @@ /** * Class InstallMagento + * * @package N98\Magento\Command\Installer\SubCommand */ class InstallMagento extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/InstallSampleData.php b/src/N98/Magento/Command/Installer/SubCommand/InstallSampleData.php index 9901e841f..5c748be2c 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/InstallSampleData.php +++ b/src/N98/Magento/Command/Installer/SubCommand/InstallSampleData.php @@ -15,6 +15,7 @@ /** * Class InstallSampleData + * * @package N98\Magento\Command\Installer\SubCommand */ class InstallSampleData extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/PostInstallation.php b/src/N98/Magento/Command/Installer/SubCommand/PostInstallation.php index a99a1db26..7254df8ae 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/PostInstallation.php +++ b/src/N98/Magento/Command/Installer/SubCommand/PostInstallation.php @@ -5,6 +5,11 @@ use N98\Magento\Command\SubCommand\AbstractSubCommand; use Symfony\Component\Console\Input\ArrayInput; +/** + * Class PostInstallation + * + * @package N98\Magento\Command\Installer\SubCommand + */ class PostInstallation extends AbstractSubCommand { /** diff --git a/src/N98/Magento/Command/Installer/SubCommand/PreCheckPhp.php b/src/N98/Magento/Command/Installer/SubCommand/PreCheckPhp.php index 430c0df85..9cec068d0 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/PreCheckPhp.php +++ b/src/N98/Magento/Command/Installer/SubCommand/PreCheckPhp.php @@ -9,6 +9,7 @@ /** * Class PreCheckPhp + * * @package N98\Magento\Command\Installer\SubCommand */ class PreCheckPhp extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/RemoveEmptyFolders.php b/src/N98/Magento/Command/Installer/SubCommand/RemoveEmptyFolders.php index 18457b707..d81e48c9d 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/RemoveEmptyFolders.php +++ b/src/N98/Magento/Command/Installer/SubCommand/RemoveEmptyFolders.php @@ -8,6 +8,7 @@ /** * Class RemoveEmptyFolders + * * @package N98\Magento\Command\Installer\SubCommand */ class RemoveEmptyFolders extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/RewriteHtaccessFile.php b/src/N98/Magento/Command/Installer/SubCommand/RewriteHtaccessFile.php index c55c60774..da1110226 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/RewriteHtaccessFile.php +++ b/src/N98/Magento/Command/Installer/SubCommand/RewriteHtaccessFile.php @@ -6,6 +6,7 @@ /** * Class RewriteHtaccessFile + * * @package N98\Magento\Command\Installer\SubCommand */ class RewriteHtaccessFile extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/SelectMagentoVersion.php b/src/N98/Magento/Command/Installer/SubCommand/SelectMagentoVersion.php index af30683e3..7a5f87aac 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/SelectMagentoVersion.php +++ b/src/N98/Magento/Command/Installer/SubCommand/SelectMagentoVersion.php @@ -7,6 +7,7 @@ /** * Class SelectMagentoVersion + * * @package N98\Magento\Command\Installer\SubCommand */ class SelectMagentoVersion extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/SubCommand/SetDirectoryPermissions.php b/src/N98/Magento/Command/Installer/SubCommand/SetDirectoryPermissions.php index 3177560a7..13b018d09 100644 --- a/src/N98/Magento/Command/Installer/SubCommand/SetDirectoryPermissions.php +++ b/src/N98/Magento/Command/Installer/SubCommand/SetDirectoryPermissions.php @@ -7,6 +7,7 @@ /** * Class SetDirectoryPermissions + * * @package N98\Magento\Command\Installer\SubCommand */ class SetDirectoryPermissions extends AbstractSubCommand diff --git a/src/N98/Magento/Command/Installer/UninstallCommand.php b/src/N98/Magento/Command/Installer/UninstallCommand.php index b30fb1994..b71e7efc6 100644 --- a/src/N98/Magento/Command/Installer/UninstallCommand.php +++ b/src/N98/Magento/Command/Installer/UninstallCommand.php @@ -13,7 +13,7 @@ use Symfony\Component\Console\Question\ConfirmationQuestion; /** - * Class UninstallCommand + * Uninstall command * * @codeCoverageIgnore * @package N98\Magento\Command\Installer diff --git a/src/N98/Magento/Command/LocalConfig/GenerateCommand.php b/src/N98/Magento/Command/LocalConfig/GenerateCommand.php index 7b13cc47d..cdb22388e 100644 --- a/src/N98/Magento/Command/LocalConfig/GenerateCommand.php +++ b/src/N98/Magento/Command/LocalConfig/GenerateCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\Question; +/** + * Generate local config command + * + * @package N98\Magento\Command\LocalConfig + */ class GenerateCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Media/Cache/Image/ClearCommand.php b/src/N98/Magento/Command/Media/Cache/Image/ClearCommand.php index 532864bca..44bdd1a98 100644 --- a/src/N98/Magento/Command/Media/Cache/Image/ClearCommand.php +++ b/src/N98/Magento/Command/Media/Cache/Image/ClearCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Clear image cache command + * + * @package N98\Magento\Command\Media\Cache\Image + */ class ClearCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Media/Cache/JsCss/ClearCommand.php b/src/N98/Magento/Command/Media/Cache/JsCss/ClearCommand.php index eede2bda4..013cdbcf9 100644 --- a/src/N98/Magento/Command/Media/Cache/JsCss/ClearCommand.php +++ b/src/N98/Magento/Command/Media/Cache/JsCss/ClearCommand.php @@ -7,6 +7,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Clear JS/CSS cache command + * + * @package N98\Magento\Command\Media\Cache\JsCss + */ class ClearCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Media/DumpCommand.php b/src/N98/Magento/Command/Media/DumpCommand.php index 6f51c4c0c..794927fe2 100644 --- a/src/N98/Magento/Command/Media/DumpCommand.php +++ b/src/N98/Magento/Command/Media/DumpCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Finder\SplFileInfo; use ZipArchive; +/** + * Dump media command + * + * @package N98\Magento\Command\Media + */ class DumpCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/OpenBrowserCommand.php b/src/N98/Magento/Command/OpenBrowserCommand.php index 741242fed..f4e5fd27f 100644 --- a/src/N98/Magento/Command/OpenBrowserCommand.php +++ b/src/N98/Magento/Command/OpenBrowserCommand.php @@ -13,6 +13,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * Open browser command + * + * @package N98\Magento\Command + */ class OpenBrowserCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/Script/Repository/AbstractRepositoryCommand.php b/src/N98/Magento/Command/Script/Repository/AbstractRepositoryCommand.php index 250cd62fc..a7f4e6a47 100644 --- a/src/N98/Magento/Command/Script/Repository/AbstractRepositoryCommand.php +++ b/src/N98/Magento/Command/Script/Repository/AbstractRepositoryCommand.php @@ -4,6 +4,11 @@ use N98\Magento\Command\AbstractMagentoCommand; +/** + * Class AbstractRepositoryCommand + * + * @package N98\Magento\Command\Script\Repository + */ class AbstractRepositoryCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/Script/Repository/ListCommand.php b/src/N98/Magento/Command/Script/Repository/ListCommand.php index a7f04f1df..8d1a69a82 100644 --- a/src/N98/Magento/Command/Script/Repository/ListCommand.php +++ b/src/N98/Magento/Command/Script/Repository/ListCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List scripts command + * + * @package N98\Magento\Command\Script\Repository + */ class ListCommand extends AbstractRepositoryCommand { protected function configure() diff --git a/src/N98/Magento/Command/Script/Repository/RunCommand.php b/src/N98/Magento/Command/Script/Repository/RunCommand.php index 269ae4ed2..bf6a045a5 100644 --- a/src/N98/Magento/Command/Script/Repository/RunCommand.php +++ b/src/N98/Magento/Command/Script/Repository/RunCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\ChoiceQuestion; +/** + * Run script command + * + * @package N98\Magento\Command\Script\Repository + */ class RunCommand extends AbstractRepositoryCommand { protected function configure() diff --git a/src/N98/Magento/Command/Script/Repository/ScriptLoader.php b/src/N98/Magento/Command/Script/Repository/ScriptLoader.php index c8ddfe91f..936d6bd3b 100644 --- a/src/N98/Magento/Command/Script/Repository/ScriptLoader.php +++ b/src/N98/Magento/Command/Script/Repository/ScriptLoader.php @@ -6,6 +6,11 @@ use Symfony\Component\Finder\Finder; use Symfony\Component\Finder\SplFileInfo; +/** + * Class ScriptLoader + * + * @package N98\Magento\Command\Script\Repository + */ class ScriptLoader { /** diff --git a/src/N98/Magento/Command/ScriptCommand.php b/src/N98/Magento/Command/ScriptCommand.php index 8c0de9c66..d437e3c7d 100644 --- a/src/N98/Magento/Command/ScriptCommand.php +++ b/src/N98/Magento/Command/ScriptCommand.php @@ -16,6 +16,11 @@ use Symfony\Component\Console\Question\ChoiceQuestion; use Symfony\Component\Console\Question\Question; +/** + * Script command + * + * @package N98\Magento\Command + */ class ScriptCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/SelfUpdateCommand.php b/src/N98/Magento/Command/SelfUpdateCommand.php index 81cb8fdfa..b2b35c677 100644 --- a/src/N98/Magento/Command/SelfUpdateCommand.php +++ b/src/N98/Magento/Command/SelfUpdateCommand.php @@ -17,6 +17,10 @@ use WpOrg\Requests\Requests; /** + * Self-update command + * + * @package N98\Magento\Command + * * @codeCoverageIgnore * @author Igor Wiedler * @author Christian Münch diff --git a/src/N98/Magento/Command/SubCommand/AbstractSubCommand.php b/src/N98/Magento/Command/SubCommand/AbstractSubCommand.php index 9229c94ee..1195da1db 100644 --- a/src/N98/Magento/Command/SubCommand/AbstractSubCommand.php +++ b/src/N98/Magento/Command/SubCommand/AbstractSubCommand.php @@ -10,6 +10,7 @@ /** * Class AbstractSubCommand + * * @package N98\Magento\Command\SubCommand */ abstract class AbstractSubCommand implements SubCommandInterface diff --git a/src/N98/Magento/Command/SubCommand/ConfigBag.php b/src/N98/Magento/Command/SubCommand/ConfigBag.php index 9150c55e6..f25170563 100644 --- a/src/N98/Magento/Command/SubCommand/ConfigBag.php +++ b/src/N98/Magento/Command/SubCommand/ConfigBag.php @@ -4,6 +4,7 @@ /** * Class ConfigBag + * * @package N98\Magento\Command\SubCommand */ class ConfigBag extends \ArrayObject diff --git a/src/N98/Magento/Command/SubCommand/SubCommandFactory.php b/src/N98/Magento/Command/SubCommand/SubCommandFactory.php index 38662eaa2..ff65f3754 100644 --- a/src/N98/Magento/Command/SubCommand/SubCommandFactory.php +++ b/src/N98/Magento/Command/SubCommand/SubCommandFactory.php @@ -8,6 +8,7 @@ /** * Class SubCommandFactory + * * @package N98\Magento\Command\SubCommand */ class SubCommandFactory diff --git a/src/N98/Magento/Command/SubCommand/SubCommandInterface.php b/src/N98/Magento/Command/SubCommand/SubCommandInterface.php index 88fd73586..ee6307566 100644 --- a/src/N98/Magento/Command/SubCommand/SubCommandInterface.php +++ b/src/N98/Magento/Command/SubCommand/SubCommandInterface.php @@ -8,6 +8,7 @@ /** * Interface SubCommandInterface + * * @package N98\Magento\Command\SubCommand */ interface SubCommandInterface diff --git a/src/N98/Magento/Command/System/Check/Filesystem/FilesCheck.php b/src/N98/Magento/Command/System/Check/Filesystem/FilesCheck.php index 31c619e76..798153921 100644 --- a/src/N98/Magento/Command/System/Check/Filesystem/FilesCheck.php +++ b/src/N98/Magento/Command/System/Check/Filesystem/FilesCheck.php @@ -10,6 +10,11 @@ use N98\Magento\Command\System\CheckCommand; use Symfony\Component\Console\Command\Command; +/** + * Class FilesCheck + * + * @package N98\Magento\Command\System\Check\Filesystem + */ class FilesCheck implements SimpleCheck, CommandAware, CommandConfigAware { /** diff --git a/src/N98/Magento/Command/System/Check/Filesystem/FoldersCheck.php b/src/N98/Magento/Command/System/Check/Filesystem/FoldersCheck.php index eaf4a3151..56ff7e2c4 100644 --- a/src/N98/Magento/Command/System/Check/Filesystem/FoldersCheck.php +++ b/src/N98/Magento/Command/System/Check/Filesystem/FoldersCheck.php @@ -10,6 +10,11 @@ use N98\Magento\Command\System\CheckCommand; use Symfony\Component\Console\Command\Command; +/** + * Class FoldersCheck + * + * @package N98\Magento\Command\System\Check\Filesystem + */ class FoldersCheck implements SimpleCheck, CommandAware, CommandConfigAware { /** diff --git a/src/N98/Magento/Command/System/Check/MySQL/EnginesCheck.php b/src/N98/Magento/Command/System/Check/MySQL/EnginesCheck.php index 47da4a95c..a0613cec1 100644 --- a/src/N98/Magento/Command/System/Check/MySQL/EnginesCheck.php +++ b/src/N98/Magento/Command/System/Check/MySQL/EnginesCheck.php @@ -1,15 +1,17 @@ - */ namespace N98\Magento\Command\System\Check\MySQL; use N98\Magento\Command\System\Check\Result; use Varien_Db_Adapter_Interface; +/** + * Class EnginesCheck + * + * @package N98\Magento\Command\System\Check\MySQL + * + * @author Tom Klingenberg (https://github.com/ktomk) + */ class EnginesCheck extends ResourceCheck { /** diff --git a/src/N98/Magento/Command/System/Check/MySQL/ResourceCheck.php b/src/N98/Magento/Command/System/Check/MySQL/ResourceCheck.php index 43397bf5d..0d4b41c69 100644 --- a/src/N98/Magento/Command/System/Check/MySQL/ResourceCheck.php +++ b/src/N98/Magento/Command/System/Check/MySQL/ResourceCheck.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\System\Check\MySQL; @@ -14,6 +9,13 @@ use N98\Magento\Command\System\Check\SimpleCheck; use Varien_Db_Adapter_Interface; +/** + * Class ResourceCheck + * + * @package N98\Magento\Command\System\Check\MySQL + * + * @author Tom Klingenberg (https://github.com/ktomk) + */ abstract class ResourceCheck implements SimpleCheck { /** diff --git a/src/N98/Magento/Command/System/Check/MySQL/VersionCheck.php b/src/N98/Magento/Command/System/Check/MySQL/VersionCheck.php index 8d23a922a..38798ae8d 100644 --- a/src/N98/Magento/Command/System/Check/MySQL/VersionCheck.php +++ b/src/N98/Magento/Command/System/Check/MySQL/VersionCheck.php @@ -1,15 +1,17 @@ - */ namespace N98\Magento\Command\System\Check\MySQL; use N98\Magento\Command\System\Check\Result; use Varien_Db_Adapter_Interface; +/** + * Class VersionCheck + * + * @package N98\Magento\Command\System\Check\MySQL + * + * @author Tom Klingenberg (https://github.com/ktomk) + */ class VersionCheck extends ResourceCheck { /** diff --git a/src/N98/Magento/Command/System/Check/PHP/BytecodeCacheExtensionsCheck.php b/src/N98/Magento/Command/System/Check/PHP/BytecodeCacheExtensionsCheck.php index a15c6b6d5..103463f31 100644 --- a/src/N98/Magento/Command/System/Check/PHP/BytecodeCacheExtensionsCheck.php +++ b/src/N98/Magento/Command/System/Check/PHP/BytecodeCacheExtensionsCheck.php @@ -7,6 +7,11 @@ use N98\Magento\Command\System\Check\ResultCollection; use N98\Magento\Command\System\Check\SimpleCheck; +/** + * Class BytecodeCacheExtensionsCheck + * + * @package N98\Magento\Command\System\Check\PHP + */ class BytecodeCacheExtensionsCheck implements SimpleCheck, CommandConfigAware { /** diff --git a/src/N98/Magento/Command/System/Check/PHP/ExtensionsCheck.php b/src/N98/Magento/Command/System/Check/PHP/ExtensionsCheck.php index 8c230f327..2cd5ba4ba 100644 --- a/src/N98/Magento/Command/System/Check/PHP/ExtensionsCheck.php +++ b/src/N98/Magento/Command/System/Check/PHP/ExtensionsCheck.php @@ -7,6 +7,11 @@ use N98\Magento\Command\System\Check\ResultCollection; use N98\Magento\Command\System\Check\SimpleCheck; +/** + * Class ExtensionsCheck + * + * @package N98\Magento\Command\System\Check\PHP + */ class ExtensionsCheck implements SimpleCheck, CommandConfigAware { /** diff --git a/src/N98/Magento/Command/System/Check/Result.php b/src/N98/Magento/Command/System/Check/Result.php index ed4c5dfc2..584490f13 100644 --- a/src/N98/Magento/Command/System/Check/Result.php +++ b/src/N98/Magento/Command/System/Check/Result.php @@ -4,6 +4,11 @@ use LogicException; +/** + * Class Result + * + * @package N98\Magento\Command\System\Check + */ class Result { /** diff --git a/src/N98/Magento/Command/System/Check/Security/LocalConfigAccessableCheck.php b/src/N98/Magento/Command/System/Check/Security/LocalConfigAccessableCheck.php index eecdfe2f6..5583b85dd 100644 --- a/src/N98/Magento/Command/System/Check/Security/LocalConfigAccessableCheck.php +++ b/src/N98/Magento/Command/System/Check/Security/LocalConfigAccessableCheck.php @@ -11,6 +11,11 @@ use Zend_Http_Client; use Zend_Http_Response; +/** + * Class LocalConfigAccessableCheck + * + * @package N98\Magento\Command\System\Check\Security + */ class LocalConfigAccessableCheck implements SimpleCheck { /** diff --git a/src/N98/Magento/Command/System/Check/Settings/BaseUrlCheckAbstract.php b/src/N98/Magento/Command/System/Check/Settings/BaseUrlCheckAbstract.php index 03e39ebc1..670040be8 100644 --- a/src/N98/Magento/Command/System/Check/Settings/BaseUrlCheckAbstract.php +++ b/src/N98/Magento/Command/System/Check/Settings/BaseUrlCheckAbstract.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\System\Check\Settings; @@ -14,6 +9,8 @@ * Class BaseUrlCheckAbstract * * @package N98\Magento\Command\System\Check\Settings + * + * @author Tom Klingenberg (https://github.com/ktomk) */ abstract class BaseUrlCheckAbstract extends CheckAbstract { diff --git a/src/N98/Magento/Command/System/Check/Settings/CheckAbstract.php b/src/N98/Magento/Command/System/Check/Settings/CheckAbstract.php index 7f91d1e99..d17d0f88d 100644 --- a/src/N98/Magento/Command/System/Check/Settings/CheckAbstract.php +++ b/src/N98/Magento/Command/System/Check/Settings/CheckAbstract.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\System\Check\Settings; @@ -17,6 +12,8 @@ * Class CheckAbstract * * @package N98\Magento\Command\System\Check\Settings + * + * @author Tom Klingenberg (https://github.com/ktomk) */ abstract class CheckAbstract implements StoreCheck { diff --git a/src/N98/Magento/Command/System/Check/Settings/CookieDomainCheckAbstract.php b/src/N98/Magento/Command/System/Check/Settings/CookieDomainCheckAbstract.php index 2d25c1206..a2fe68e0b 100644 --- a/src/N98/Magento/Command/System/Check/Settings/CookieDomainCheckAbstract.php +++ b/src/N98/Magento/Command/System/Check/Settings/CookieDomainCheckAbstract.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento\Command\System\Check\Settings; @@ -14,6 +9,8 @@ * Class CookieDomainCheckAbstract * * @package N98\Magento\Command\System\Check\Settings + * + * @author Tom Klingenberg (https://github.com/ktomk) */ abstract class CookieDomainCheckAbstract extends CheckAbstract { diff --git a/src/N98/Magento/Command/System/Check/Settings/SecureCookieDomainCheck.php b/src/N98/Magento/Command/System/Check/Settings/SecureCookieDomainCheck.php index 034292e66..2b8010f90 100644 --- a/src/N98/Magento/Command/System/Check/Settings/SecureCookieDomainCheck.php +++ b/src/N98/Magento/Command/System/Check/Settings/SecureCookieDomainCheck.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command\System\Check\Settings; +/** + * Class SecureCookieDomainCheck + * + * @package N98\Magento\Command\System\Check\Settings + */ class SecureCookieDomainCheck extends CookieDomainCheckAbstract { protected $class = 'secure'; diff --git a/src/N98/Magento/Command/System/Check/Settings/UnsecureCookieDomainCheck.php b/src/N98/Magento/Command/System/Check/Settings/UnsecureCookieDomainCheck.php index 1409343f7..c0bf511bb 100644 --- a/src/N98/Magento/Command/System/Check/Settings/UnsecureCookieDomainCheck.php +++ b/src/N98/Magento/Command/System/Check/Settings/UnsecureCookieDomainCheck.php @@ -2,6 +2,11 @@ namespace N98\Magento\Command\System\Check\Settings; +/** + * Class UnsecureCookieDomainCheck + * + * @package N98\Magento\Command\System\Check\Settings + */ class UnsecureCookieDomainCheck extends CookieDomainCheckAbstract { protected $class = 'unsecure'; diff --git a/src/N98/Magento/Command/System/CheckCommand.php b/src/N98/Magento/Command/System/CheckCommand.php index d99faf132..77e514da9 100644 --- a/src/N98/Magento/Command/System/CheckCommand.php +++ b/src/N98/Magento/Command/System/CheckCommand.php @@ -18,7 +18,7 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class CheckCommand + * System check command * * @package N98\Magento\Command\System */ diff --git a/src/N98/Magento/Command/System/Cron/AbstractCronCommand.php b/src/N98/Magento/Command/System/Cron/AbstractCronCommand.php index e18bfd735..933635b57 100644 --- a/src/N98/Magento/Command/System/Cron/AbstractCronCommand.php +++ b/src/N98/Magento/Command/System/Cron/AbstractCronCommand.php @@ -11,6 +11,11 @@ use N98\Magento\Command\AbstractMagentoCommand; use Traversable; +/** + * Class AbstractCronCommand + * + * @package N98\Magento\Command\System\Cron + */ abstract class AbstractCronCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/System/Cron/HistoryCommand.php b/src/N98/Magento/Command/System/Cron/HistoryCommand.php index a02491507..b0234c1cb 100644 --- a/src/N98/Magento/Command/System/Cron/HistoryCommand.php +++ b/src/N98/Magento/Command/System/Cron/HistoryCommand.php @@ -11,6 +11,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Varien_Data_Collection_Db; +/** + * List cronjob history command + * + * @package N98\Magento\Command\System\Cron + */ class HistoryCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/System/Cron/ListCommand.php b/src/N98/Magento/Command/System/Cron/ListCommand.php index 8f8f63ac3..bc4a29384 100644 --- a/src/N98/Magento/Command/System/Cron/ListCommand.php +++ b/src/N98/Magento/Command/System/Cron/ListCommand.php @@ -6,6 +6,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List cronjob command + * + * @package N98\Magento\Command\System\Cron + */ class ListCommand extends AbstractCronCommand { /** diff --git a/src/N98/Magento/Command/System/Cron/RunCommand.php b/src/N98/Magento/Command/System/Cron/RunCommand.php index 294333022..6087d216f 100644 --- a/src/N98/Magento/Command/System/Cron/RunCommand.php +++ b/src/N98/Magento/Command/System/Cron/RunCommand.php @@ -16,6 +16,11 @@ use Symfony\Component\Console\Question\Question; use Symfony\Component\Validator\Exception\InvalidArgumentException; +/** + * Run cronjob command + * + * @package N98\Magento\Command\System\Cron + */ class RunCommand extends AbstractCronCommand { public const REGEX_RUN_MODEL = '#^([a-z0-9_]+/[a-z0-9_]+)::([a-z0-9_]+)$#i'; diff --git a/src/N98/Magento/Command/System/InfoCommand.php b/src/N98/Magento/Command/System/InfoCommand.php index b200fce56..1db3bc714 100644 --- a/src/N98/Magento/Command/System/InfoCommand.php +++ b/src/N98/Magento/Command/System/InfoCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Finder\Finder; +/** + * System info command + * + * @package N98\Magento\Command\System + */ class InfoCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/System/MaintenanceCommand.php b/src/N98/Magento/Command/System/MaintenanceCommand.php index a7ad7084d..6ac27df7a 100644 --- a/src/N98/Magento/Command/System/MaintenanceCommand.php +++ b/src/N98/Magento/Command/System/MaintenanceCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Toggles maintenance mode command + * + * @package N98\Magento\Command\System + */ class MaintenanceCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/System/Setup/AbstractSetupCommand.php b/src/N98/Magento/Command/System/Setup/AbstractSetupCommand.php index c7419b119..adb1a8260 100644 --- a/src/N98/Magento/Command/System/Setup/AbstractSetupCommand.php +++ b/src/N98/Magento/Command/System/Setup/AbstractSetupCommand.php @@ -9,6 +9,7 @@ /** * Class AbstractSetupCommand + * * @package N98\Magento\Command\System\Setup */ class AbstractSetupCommand extends AbstractMagentoCommand diff --git a/src/N98/Magento/Command/System/Setup/ChangeVersionCommand.php b/src/N98/Magento/Command/System/Setup/ChangeVersionCommand.php index 95862a12d..58c081e22 100644 --- a/src/N98/Magento/Command/System/Setup/ChangeVersionCommand.php +++ b/src/N98/Magento/Command/System/Setup/ChangeVersionCommand.php @@ -8,7 +8,8 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class ChangeVersionCommand + * Change setup version command + * * @package N98\Magento\Command\System\Setup */ class ChangeVersionCommand extends AbstractSetupCommand diff --git a/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php b/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php index 659084426..33fbc489e 100644 --- a/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php +++ b/src/N98/Magento/Command/System/Setup/CompareVersionsCommand.php @@ -12,6 +12,11 @@ use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; +/** + * Compare setup versions command + * + * @package N98\Magento\Command\System\Setup + */ class CompareVersionsCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/System/Setup/IncrementalCommand.php b/src/N98/Magento/Command/System/Setup/IncrementalCommand.php index acbad4613..07855d744 100644 --- a/src/N98/Magento/Command/System/Setup/IncrementalCommand.php +++ b/src/N98/Magento/Command/System/Setup/IncrementalCommand.php @@ -16,7 +16,7 @@ use Symfony\Component\Console\Question\Question; /** - * Class IncrementalCommand + * Run incremental setup command * * @package N98\Magento\Command\System\Setup * @codeCoverageIgnore diff --git a/src/N98/Magento/Command/System/Setup/RemoveCommand.php b/src/N98/Magento/Command/System/Setup/RemoveCommand.php index 611cadf2a..06f58489e 100644 --- a/src/N98/Magento/Command/System/Setup/RemoveCommand.php +++ b/src/N98/Magento/Command/System/Setup/RemoveCommand.php @@ -10,9 +10,10 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Class RemoveCommand + * Remove setup ommand * * @package N98\Magento\Command\System\Setup + * * @author Aydin Hassan */ class RemoveCommand extends AbstractSetupCommand diff --git a/src/N98/Magento/Command/System/Setup/RunCommand.php b/src/N98/Magento/Command/System/Setup/RunCommand.php index 5aa0b7540..b07f9f345 100644 --- a/src/N98/Magento/Command/System/Setup/RunCommand.php +++ b/src/N98/Magento/Command/System/Setup/RunCommand.php @@ -14,6 +14,11 @@ use Symfony\Component\Console\Output\NullOutput; use Symfony\Component\Console\Output\OutputInterface; +/** + * Run setup command + * + * @package N98\Magento\Command\System\Setup + */ class RunCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/System/Store/Config/BaseUrlListCommand.php b/src/N98/Magento/Command/System/Store/Config/BaseUrlListCommand.php index fa5b06766..5e9f71d47 100644 --- a/src/N98/Magento/Command/System/Store/Config/BaseUrlListCommand.php +++ b/src/N98/Magento/Command/System/Store/Config/BaseUrlListCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List stores base url command + * + * @package N98\Magento\Command\System\Store\Config + */ class BaseUrlListCommand extends AbstractMagentoCommand { protected function configure() diff --git a/src/N98/Magento/Command/System/Store/ListCommand.php b/src/N98/Magento/Command/System/Store/ListCommand.php index 3f0afb3da..4856ff5fb 100644 --- a/src/N98/Magento/Command/System/Store/ListCommand.php +++ b/src/N98/Magento/Command/System/Store/ListCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List stores command + * + * @package N98\Magento\Command\System\Store + */ class ListCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/Command/System/Url/ListCommand.php b/src/N98/Magento/Command/System/Url/ListCommand.php index e335e8a53..12c730a90 100644 --- a/src/N98/Magento/Command/System/Url/ListCommand.php +++ b/src/N98/Magento/Command/System/Url/ListCommand.php @@ -12,7 +12,7 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Create url list + * List url command * * Examples: * - Create a list of product urls only @@ -25,6 +25,8 @@ * The "linetemplate" can contain all parts "parse_url" return wrapped in '{}'. '{url}' always maps the complete url * and is set by default * + * @package N98\Magento\Command\System\Url + * * @author Fabrizio Branca */ class ListCommand extends AbstractMagentoCommand diff --git a/src/N98/Magento/Command/System/Website/ListCommand.php b/src/N98/Magento/Command/System/Website/ListCommand.php index f27f9166e..176b415d1 100644 --- a/src/N98/Magento/Command/System/Website/ListCommand.php +++ b/src/N98/Magento/Command/System/Website/ListCommand.php @@ -8,6 +8,11 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +/** + * List websites command + * + * @package N98\Magento\Command\System\Website + */ class ListCommand extends AbstractMagentoCommand { /** diff --git a/src/N98/Magento/DbSettings.php b/src/N98/Magento/DbSettings.php index 8c4887322..f801759de 100644 --- a/src/N98/Magento/DbSettings.php +++ b/src/N98/Magento/DbSettings.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento; @@ -25,6 +20,8 @@ * The Magento database settings are stored in a SimpleXMLElement structure * * @package N98\Magento + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class DbSettings implements ArrayAccess, IteratorAggregate { diff --git a/src/N98/Magento/Initialiser.php b/src/N98/Magento/Initialiser.php index ebc75ea15..fc662135a 100644 --- a/src/N98/Magento/Initialiser.php +++ b/src/N98/Magento/Initialiser.php @@ -12,9 +12,11 @@ use RuntimeException; /** - * Magento initialiser (Magento 1) + * Magento initializer (Magento 1) * * @package N98\Magento + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class Initialiser { diff --git a/src/N98/Magento/Modules.php b/src/N98/Magento/Modules.php index 8c6181af4..7f1ca6537 100644 --- a/src/N98/Magento/Modules.php +++ b/src/N98/Magento/Modules.php @@ -1,9 +1,4 @@ - */ namespace N98\Magento; @@ -20,6 +15,8 @@ * Magento Modules * * @package N98\Magento + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class Modules implements IteratorAggregate, Countable { diff --git a/src/N98/MagerunBootstrap.php b/src/N98/MagerunBootstrap.php index 9484c3b82..fb5ce5aef 100644 --- a/src/N98/MagerunBootstrap.php +++ b/src/N98/MagerunBootstrap.php @@ -1,9 +1,4 @@ - */ namespace N98; @@ -15,6 +10,8 @@ * Bootstrap class for the Magerun applications (Symfony console based application) * * @package N98 + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class MagerunBootstrap { diff --git a/src/N98/Util/ArrayFunctions.php b/src/N98/Util/ArrayFunctions.php index 3c965f103..64577824f 100644 --- a/src/N98/Util/ArrayFunctions.php +++ b/src/N98/Util/ArrayFunctions.php @@ -1,10 +1,14 @@ - */ namespace N98\Util; +/** + * Class Twig + * + * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) + */ class ArrayFunctions { /** diff --git a/src/N98/Util/AutoloadHandler.php b/src/N98/Util/AutoloadHandler.php index 30c56c578..f702c2872 100644 --- a/src/N98/Util/AutoloadHandler.php +++ b/src/N98/Util/AutoloadHandler.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -13,6 +8,8 @@ * Autloader with self-registration, de-registration, muting and implementation switching * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ final class AutoloadHandler { diff --git a/src/N98/Util/AutoloadRestorer.php b/src/N98/Util/AutoloadRestorer.php index b88343129..0d4527dcd 100644 --- a/src/N98/Util/AutoloadRestorer.php +++ b/src/N98/Util/AutoloadRestorer.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -13,6 +8,8 @@ * Based on SPL autoloader. * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class AutoloadRestorer { diff --git a/src/N98/Util/BinaryString.php b/src/N98/Util/BinaryString.php index 7415a391f..15404fcc5 100644 --- a/src/N98/Util/BinaryString.php +++ b/src/N98/Util/BinaryString.php @@ -2,6 +2,11 @@ namespace N98\Util; +/** + * Class BinaryString + * + * @package N98\Util + */ class BinaryString { /** diff --git a/src/N98/Util/Console/Enabler.php b/src/N98/Util/Console/Enabler.php index 97fcd97a3..58a92c528 100644 --- a/src/N98/Util/Console/Enabler.php +++ b/src/N98/Util/Console/Enabler.php @@ -1,9 +1,4 @@ - */ namespace N98\Util\Console; @@ -19,6 +14,8 @@ * @see \N98\Magento\Command\Database\DumpCommand::execute() * * @package N98\Util\Console + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class Enabler { diff --git a/src/N98/Util/Console/Helper/ComposerHelper.php b/src/N98/Util/Console/Helper/ComposerHelper.php index a6ce6a747..1216e673d 100644 --- a/src/N98/Util/Console/Helper/ComposerHelper.php +++ b/src/N98/Util/Console/Helper/ComposerHelper.php @@ -11,6 +11,7 @@ /** * Class ComposerHelper + * * @package N98\Util\Console\Helper */ class ComposerHelper extends AbstractHelper implements InputAwareInterface diff --git a/src/N98/Util/Console/Helper/IoHelper.php b/src/N98/Util/Console/Helper/IoHelper.php index 31c564d99..d374956bf 100644 --- a/src/N98/Util/Console/Helper/IoHelper.php +++ b/src/N98/Util/Console/Helper/IoHelper.php @@ -1,9 +1,4 @@ - */ namespace N98\Util\Console\Helper; @@ -23,6 +18,8 @@ * Register itself on @see ConsoleEvents::COMMAND event to populate helper fields * * @package N98\Util\Console\Helper + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class IoHelper implements HelperInterface, EventSubscriberInterface { diff --git a/src/N98/Util/Console/Helper/ParameterHelper.php b/src/N98/Util/Console/Helper/ParameterHelper.php index 33ab3a0eb..7a7eac5b3 100644 --- a/src/N98/Util/Console/Helper/ParameterHelper.php +++ b/src/N98/Util/Console/Helper/ParameterHelper.php @@ -28,6 +28,8 @@ /** * Helper to init some parameters + * + * @package N98\Util\Console\Helper */ class ParameterHelper extends AbstractHelper { diff --git a/src/N98/Util/Console/Helper/Table/Renderer/CsvRenderer.php b/src/N98/Util/Console/Helper/Table/Renderer/CsvRenderer.php index 1e789407b..31ff8aa8d 100644 --- a/src/N98/Util/Console/Helper/Table/Renderer/CsvRenderer.php +++ b/src/N98/Util/Console/Helper/Table/Renderer/CsvRenderer.php @@ -5,6 +5,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\StreamOutput; +/** + * Class CsvRenderer + * + * @package N98\Util\Console\Helper\Table\Renderer + */ class CsvRenderer implements RendererInterface { /** diff --git a/src/N98/Util/Console/Helper/Table/Renderer/JsonRenderer.php b/src/N98/Util/Console/Helper/Table/Renderer/JsonRenderer.php index fc57a1568..265c0a2f4 100644 --- a/src/N98/Util/Console/Helper/Table/Renderer/JsonRenderer.php +++ b/src/N98/Util/Console/Helper/Table/Renderer/JsonRenderer.php @@ -4,6 +4,11 @@ use Symfony\Component\Console\Output\OutputInterface; +/** + * Class JsonRenderer + * + * @package N98\Util\Console\Helper\Table\Renderer + */ class JsonRenderer implements RendererInterface { /** diff --git a/src/N98/Util/Console/Helper/Table/Renderer/RendererFactory.php b/src/N98/Util/Console/Helper/Table/Renderer/RendererFactory.php index 8aaefd6c1..fcb33c426 100644 --- a/src/N98/Util/Console/Helper/Table/Renderer/RendererFactory.php +++ b/src/N98/Util/Console/Helper/Table/Renderer/RendererFactory.php @@ -5,6 +5,11 @@ use InvalidArgumentException; use Symfony\Component\Console\Output\OutputInterface; +/** + * Class RendererFactory + * + * @package N98\Util\Console\Helper\Table\Renderer + */ class RendererFactory { protected static $formats = ['csv' => CsvRenderer::class, 'json' => JsonRenderer::class, 'text' => TextRenderer::class, 'xml' => XmlRenderer::class]; diff --git a/src/N98/Util/Console/Helper/Table/Renderer/RendererInterface.php b/src/N98/Util/Console/Helper/Table/Renderer/RendererInterface.php index 4b33ffaa8..60a1390c0 100644 --- a/src/N98/Util/Console/Helper/Table/Renderer/RendererInterface.php +++ b/src/N98/Util/Console/Helper/Table/Renderer/RendererInterface.php @@ -4,6 +4,11 @@ use Symfony\Component\Console\Output\OutputInterface; +/** + * Interface RendererInterface + * + * @package N98\Util\Console\Helper\Table\Renderer + */ interface RendererInterface { /** diff --git a/src/N98/Util/Console/Helper/Table/Renderer/TextRenderer.php b/src/N98/Util/Console/Helper/Table/Renderer/TextRenderer.php index 2d28f8462..3e48476b3 100644 --- a/src/N98/Util/Console/Helper/Table/Renderer/TextRenderer.php +++ b/src/N98/Util/Console/Helper/Table/Renderer/TextRenderer.php @@ -1,9 +1,4 @@ - */ namespace N98\Util\Console\Helper\Table\Renderer; @@ -15,6 +10,8 @@ * Class TextRenderer * * @package N98\Util\Console\Helper\Table\Renderer + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class TextRenderer implements RendererInterface { diff --git a/src/N98/Util/Console/Helper/Table/Renderer/XmlRenderer.php b/src/N98/Util/Console/Helper/Table/Renderer/XmlRenderer.php index fb6a8b924..e80b25303 100644 --- a/src/N98/Util/Console/Helper/Table/Renderer/XmlRenderer.php +++ b/src/N98/Util/Console/Helper/Table/Renderer/XmlRenderer.php @@ -1,9 +1,4 @@ - */ namespace N98\Util\Console\Helper\Table\Renderer; @@ -17,6 +12,8 @@ * Class XmlRenderer * * @package N98\Util\Console\Helper\Table\Renderer + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class XmlRenderer implements RendererInterface { diff --git a/src/N98/Util/Console/Helper/TableHelper.php b/src/N98/Util/Console/Helper/TableHelper.php index 2353b1dbf..d0505d95d 100644 --- a/src/N98/Util/Console/Helper/TableHelper.php +++ b/src/N98/Util/Console/Helper/TableHelper.php @@ -10,11 +10,13 @@ /** * Text Table Helper - * @author Timothy Anido * * Based on draw_text_table by Paul Maunders * Available at http://www.pyrosoft.co.uk/blog/2007/07/01/php-array-to-text-table-function/ - */ + * + * @package N98\Util\Console\Helper + * + * @author Timothy Anido */ class TableHelper extends AbstractHelper { /** diff --git a/src/N98/Util/Console/Helper/TwigHelper.php b/src/N98/Util/Console/Helper/TwigHelper.php index 519fdd7a9..fcab1cb4b 100644 --- a/src/N98/Util/Console/Helper/TwigHelper.php +++ b/src/N98/Util/Console/Helper/TwigHelper.php @@ -10,6 +10,8 @@ /** * Helper to render twig templates + * + * @package N98\Util\Console\Helper */ class TwigHelper extends Helper { diff --git a/src/N98/Util/DateTime.php b/src/N98/Util/DateTime.php index fd0c92c14..006598538 100644 --- a/src/N98/Util/DateTime.php +++ b/src/N98/Util/DateTime.php @@ -4,6 +4,11 @@ use DateTime as PhpDateTime; +/** + * Class DateTime + * + * @package N98\Util + */ class DateTime { /** diff --git a/src/N98/Util/Faker/Provider/Internet.php b/src/N98/Util/Faker/Provider/Internet.php index da3128a63..86f3588ca 100644 --- a/src/N98/Util/Faker/Provider/Internet.php +++ b/src/N98/Util/Faker/Provider/Internet.php @@ -2,6 +2,11 @@ namespace N98\Util\Faker\Provider; +/** + * Class Internet + * + * @package N98\Util\Faker\Provider + */ class Internet extends \Faker\Provider\Internet { // Reduce the chance of conflicts. diff --git a/src/N98/Util/Filesystem.php b/src/N98/Util/Filesystem.php index 5b1346409..0e58814de 100644 --- a/src/N98/Util/Filesystem.php +++ b/src/N98/Util/Filesystem.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -13,6 +8,8 @@ * Class Filesystem * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class Filesystem { diff --git a/src/N98/Util/Markdown/VersionFilePrinter.php b/src/N98/Util/Markdown/VersionFilePrinter.php index de4cdb105..2f8ce1ce4 100644 --- a/src/N98/Util/Markdown/VersionFilePrinter.php +++ b/src/N98/Util/Markdown/VersionFilePrinter.php @@ -4,6 +4,7 @@ /** * Class VersionFilePrinter + * * @package N98\Util\Markdown */ class VersionFilePrinter diff --git a/src/N98/Util/OperatingSystem.php b/src/N98/Util/OperatingSystem.php index f733df1da..aa549963b 100644 --- a/src/N98/Util/OperatingSystem.php +++ b/src/N98/Util/OperatingSystem.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -11,6 +6,8 @@ * Class OperatingSystem * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class OperatingSystem { diff --git a/src/N98/Util/ProcessArguments.php b/src/N98/Util/ProcessArguments.php index 4c87be652..4a7a0a761 100644 --- a/src/N98/Util/ProcessArguments.php +++ b/src/N98/Util/ProcessArguments.php @@ -1,7 +1,4 @@ - */ namespace N98\Util; @@ -12,6 +9,8 @@ * * @see Process * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class ProcessArguments { diff --git a/src/N98/Util/StringTyped.php b/src/N98/Util/StringTyped.php index a25908093..1b61c8cca 100644 --- a/src/N98/Util/StringTyped.php +++ b/src/N98/Util/StringTyped.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -11,6 +6,8 @@ * StringTyped String formatter / parser * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ abstract class StringTyped { diff --git a/src/N98/Util/Template/Twig.php b/src/N98/Util/Template/Twig.php index 4ca97c1f3..d711dd804 100644 --- a/src/N98/Util/Template/Twig.php +++ b/src/N98/Util/Template/Twig.php @@ -8,6 +8,11 @@ use Twig\Loader\FilesystemLoader; use Twig\TwigFilter; +/** + * Class Twig + * + * @package N98\Util\Template + */ class Twig { /** diff --git a/src/N98/Util/Unicode/Charset.php b/src/N98/Util/Unicode/Charset.php index 3b5eaaee2..e09a54635 100644 --- a/src/N98/Util/Unicode/Charset.php +++ b/src/N98/Util/Unicode/Charset.php @@ -4,6 +4,7 @@ /** * Class Charset + * * @package N98\Util\Unicode */ class Charset diff --git a/src/N98/Util/Validator/FakeMetadataFactory.php b/src/N98/Util/Validator/FakeMetadataFactory.php index 18c5327bb..f27de0451 100644 --- a/src/N98/Util/Validator/FakeMetadataFactory.php +++ b/src/N98/Util/Validator/FakeMetadataFactory.php @@ -8,6 +8,7 @@ /** * Class FakeMetadataFactory + * * @package N98\Util\Validator */ class FakeMetadataFactory implements MetadataFactoryInterface diff --git a/src/N98/Util/VerifyOrDie.php b/src/N98/Util/VerifyOrDie.php index cd7367a5b..bc5d2a9e7 100644 --- a/src/N98/Util/VerifyOrDie.php +++ b/src/N98/Util/VerifyOrDie.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -14,6 +9,8 @@ * Class VerifyOrDie * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ class VerifyOrDie { diff --git a/src/N98/Util/WindowsSystem.php b/src/N98/Util/WindowsSystem.php index d45067f86..5d6fba8df 100644 --- a/src/N98/Util/WindowsSystem.php +++ b/src/N98/Util/WindowsSystem.php @@ -1,9 +1,4 @@ - */ namespace N98\Util; @@ -13,6 +8,8 @@ * Utility class with global static functions. * * @package N98\Util + * + * @author Tom Klingenberg (https://github.com/ktomk) */ final class WindowsSystem { diff --git a/src/N98/View/PhpView.php b/src/N98/View/PhpView.php index b881525db..37e2686ea 100644 --- a/src/N98/View/PhpView.php +++ b/src/N98/View/PhpView.php @@ -2,6 +2,11 @@ namespace N98\View; +/** + * Class PhpView + * + * @package N98\View + */ class PhpView implements View { /** diff --git a/src/N98/View/View.php b/src/N98/View/View.php index 9fef22500..e0d9f369e 100644 --- a/src/N98/View/View.php +++ b/src/N98/View/View.php @@ -2,6 +2,11 @@ namespace N98\View; +/** + * Interface View + * + * @package N98\View + */ interface View { /** From 31dfc29b5390bebb8e57ada188465b57178c3b02 Mon Sep 17 00:00:00 2001 From: Sven Reichel Date: Sun, 14 Jul 2024 04:16:18 +0200 Subject: [PATCH 3/5] Added basic phpDocumentor config --- phpdoc.dist.xml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 phpdoc.dist.xml diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml new file mode 100644 index 000000000..dfe2bb8ac --- /dev/null +++ b/phpdoc.dist.xml @@ -0,0 +1,20 @@ + + + + + docs/api + docs/cache + + + + + src + + + + From 40e5a14fa61cc27d24349caa187bdfdb54c165f8 Mon Sep 17 00:00:00 2001 From: Sven Reichel Date: Sun, 14 Jul 2024 04:18:24 +0200 Subject: [PATCH 4/5] Updated .gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 8209c82c8..a90f6a2bb 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,5 @@ act.secrets # Local Magento src /magento +# phpDocumentor +/docs/ From 5236884d62ede089a34aeab2e760671087059daa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=BCnch?= Date: Mon, 15 Jul 2024 15:56:33 +0200 Subject: [PATCH 5/5] Rename netz98 to valantic CEC --- readme.rst | 2 +- src/N98/Magento/Application.php | 2 +- tests/N98/Magento/Command/ListCommandTest.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.rst b/readme.rst index 3a0454181..ded933103 100644 --- 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 index fa1438503..c9053c7f5 100644 --- a/src/N98/Magento/Application.php +++ b/src/N98/Magento/Application.php @@ -485,7 +485,7 @@ public function getHelp() public function getLongVersion() { - return parent::getLongVersion() . ' by netz98 GmbH'; + return parent::getLongVersion() . ' by valantic CEC'; } /** diff --git a/tests/N98/Magento/Command/ListCommandTest.php b/tests/N98/Magento/Command/ListCommandTest.php index a4bf3cd81..afea0d266 100644 --- a/tests/N98/Magento/Command/ListCommandTest.php +++ b/tests/N98/Magento/Command/ListCommandTest.php @@ -16,7 +16,7 @@ public function testExecute() ); self::assertStringContainsString( - sprintf('n98-magerun %s by netz98 GmbH', $this->getApplication()->getVersion()), + sprintf('n98-magerun %s by valantic CEC', $this->getApplication()->getVersion()), $commandTester->getDisplay() ); }