From 9c3739ee1f6c696fec496a914eb5cce9476183b1 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Tue, 16 Aug 2022 12:02:50 +0100 Subject: [PATCH 01/12] DQA-4443: Add drupal-check to toolkit. --- composer.json | 1 + src/TaskRunner/Commands/TestsCommands.php | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/composer.json b/composer.json index 59dbdd874..2ae4d1fc9 100644 --- a/composer.json +++ b/composer.json @@ -22,6 +22,7 @@ "ec-europa/qa-automation": "^8.1.5", "guzzlehttp/guzzle": "^6.3 || ^7.0", "j13k/yaml-lint": "^1.1", + "mglaman/drupal-check": "^1.4", "openeuropa/task-runner": "^2.0@alpha", "php-parallel-lint/php-parallel-lint": "^1.3", "phpmd/phpmd": "^2.12", diff --git a/src/TaskRunner/Commands/TestsCommands.php b/src/TaskRunner/Commands/TestsCommands.php index b32a45a74..b7f7b03d0 100644 --- a/src/TaskRunner/Commands/TestsCommands.php +++ b/src/TaskRunner/Commands/TestsCommands.php @@ -771,4 +771,25 @@ public function toolkitBlackfire() return new ResultData(0); } + + /** + * Run drupal-check. + * + * Checking deprecated code on Drupal Context. + * + * @command toolkit:drupal-check + * + * @option analysis Check for correctness. + * @option deprecations Check for deprecations. + * + * @aliases tdc + */ + public function toolkitDrupalCheck(array $options = [ + 'analysis' => InputOption::VALUE_REQUIRED, + 'deprecations' => InputOption::VALUE_REQUIRED, + ]) + { + $task = $this->taskExec("./vendor/bin/drupal-check ./../../../lib"); + return $this->collectionBuilder()->addTaskList([$task]); + } } From a92c990dfa9ba9228f133f01c127275a6c7591c0 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Tue, 16 Aug 2022 19:39:58 +0000 Subject: [PATCH 02/12] DQA-4443: Create Drupal 10 compatibility check. --- config/default.yml | 2 + docs/available-tasks.md | 2 +- src/TaskRunner/Commands/TestsCommands.php | 20 ----- src/TaskRunner/Commands/ToolCommands.php | 89 ++++++++++++++++------- 4 files changed, 64 insertions(+), 49 deletions(-) diff --git a/config/default.yml b/config/default.yml index fee046b28..c38fbedd8 100644 --- a/config/default.yml +++ b/config/default.yml @@ -125,6 +125,8 @@ toolkit: whitelist-components: endpoint: 'https://webgate.ec.europa.eu/fpfis/qa/api/v1/package-reviews?version=8.x' blocker: true + drupal-upgrade: + skip: false invalid-versions: - 1.x - 2.x diff --git a/docs/available-tasks.md b/docs/available-tasks.md index d8e454339..3142ac6b8 100644 --- a/docs/available-tasks.md +++ b/docs/available-tasks.md @@ -29,7 +29,6 @@ Available commands: toolkit:build-dev-reset Build site for local development from scratch with a clean git. toolkit:build-dist Build the distribution package. toolkit:component-check Check composer.json for components that are not whitelisted/blacklisted. - toolkit:d9-compatibility Check project compatibility for Drupal 9 upgrade. toolkit:disable-drupal-cache Disable aggregation and clear cache. toolkit:download-dump Download ASDA snapshot. toolkit:import-config Import config. @@ -42,6 +41,7 @@ Available commands: toolkit:run-phpcbf [tpb] Run PHP code autofixing. toolkit:test-behat [tb] Run Behat tests. toolkit:test-phpcs [tp] Run PHP code review. + toolkit:upgrade-status [tdus] Check project compatibility for Drupal 9/10 upgrade. ``` diff --git a/src/TaskRunner/Commands/TestsCommands.php b/src/TaskRunner/Commands/TestsCommands.php index b7f7b03d0..ea0ba8c6e 100644 --- a/src/TaskRunner/Commands/TestsCommands.php +++ b/src/TaskRunner/Commands/TestsCommands.php @@ -772,24 +772,4 @@ public function toolkitBlackfire() return new ResultData(0); } - /** - * Run drupal-check. - * - * Checking deprecated code on Drupal Context. - * - * @command toolkit:drupal-check - * - * @option analysis Check for correctness. - * @option deprecations Check for deprecations. - * - * @aliases tdc - */ - public function toolkitDrupalCheck(array $options = [ - 'analysis' => InputOption::VALUE_REQUIRED, - 'deprecations' => InputOption::VALUE_REQUIRED, - ]) - { - $task = $this->taskExec("./vendor/bin/drupal-check ./../../../lib"); - return $this->collectionBuilder()->addTaskList([$task]); - } } diff --git a/src/TaskRunner/Commands/ToolCommands.php b/src/TaskRunner/Commands/ToolCommands.php index 2c0dca52e..2c1e1653e 100644 --- a/src/TaskRunner/Commands/ToolCommands.php +++ b/src/TaskRunner/Commands/ToolCommands.php @@ -706,77 +706,110 @@ public static function postQaContent(array $fields, string $auth): string } /** - * Check project compatibility for Drupal 9 upgrade. + * Check project compatibility for Drupal 9/10 upgrade. * * @SuppressWarnings(PHPMD.CyclomaticComplexity) * - * Note: The project configuration should be updated. + * @command toolkit:drupal-upgrade-status * - * @command toolkit:d9-compatibility + * @aliases tdus * + * @option skip Return results from a previous scan of a project (defaults to: 'false') */ - public function d9Compatibility(): int + public function drupalUpgradeStatus(array $options = [ + 'skip' => InputOption::VALUE_OPTIONAL, + ]): int { + $mode = $this->getConfig()->get('toolkit.tool.drupal-upgrade.skip'); + if (!empty($options['skip'])) { + $skip = $options['skip']; + } + $this->checkCommitMessage(); - if (!$this->skipd9c) { - $this->say('Developer is skipping Drupal 9 compatibility analysis.'); + if (!$this->skipdus) { + $this->say('Developer is skipping Drupal 9/10 compatibility analysis.'); return 0; } if ($drupal_version = self::getPackagePropertyFromComposer('drupal/core')) { - if (Semver::satisfies($drupal_version, '^9')) { - $this->say('Project already running on Drupal 9, skipping Drupal 9 compatibility analysis.'); + if (Semver::satisfies($drupal_version, '^10')) { + $this->say('Project already running on Drupal 10, skipping Drupal 10 compatibility analysis.'); return 0; } } - // Prepare project - $this->say("Preparing project to run upgrade_status:analyze command."); + // Prepare project. + $this->say("Preparing the project to run upgrade_status."); $drushBin = $this->getBin('drush'); $collection = $this->collectionBuilder(); - $collection->taskComposerRequire() - ->dependency('phpspec/prophecy-phpunit', '^2') + // Require 'drupal/upgrade_status' if does not exist on the project. + if (self::getPackagePropertyFromComposer('drupal/upgrade_status') != FALSE) { + $collection->taskComposerRequire() ->dependency('drupal/upgrade_status', '^3') ->dev() ->run(); + } + // Require 'drupal/core-dev' if does not exist on the project. + if (self::getPackagePropertyFromComposer('drupal/core-dev') != FALSE) { + $collection->taskComposerRequire() + ->dependency('drupal/core-dev') + ->dev() + ->run(); + } + // Build collection. $collection = $this->collectionBuilder(); $collection->taskExecStack() ->exec($drushBin . ' en upgrade_status -y') ->run(); - // Collect result details. - $result = $collection->taskExecStack() - ->exec($drushBin . ' upgrade_status:analyze --all') - ->printOutput(false) - ->storeState('insecure') - ->silent(true) - ->run() - ->getMessage(); + // Return results from a previous scan of a project. + if ($skip == true) { + $result = $collection->taskExecStack() + ->exec($drushBin . ' us-a --all --skip-existing') + ->printOutput(false) + ->storeState('insecure') + ->silent(true) + ->run() + ->getMessage(); + } else { + // Otherwise perform the default module's analysis. + $result = $collection->taskExecStack() + ->exec($drushBin . ' us-a --all') + ->printOutput(false) + ->storeState('insecure') + ->silent(true) + ->run() + ->getMessage(); + } - // Check for results. + // Check flagged results. $qaCompatibilityResult = 0; if (is_string($result)) { $flags = [ 'Check manually', 'Fix now', ]; - foreach ($flags as $flag) { - if (strpos($flag, $result) !== false) { + if (strpos($result, $flag) !== false) { $qaCompatibilityResult = 1; } } } + echo $result . PHP_EOL; if ($qaCompatibilityResult) { - $this->say('Looks the project need some attention, please check the report.'); + $this->say('Looks the project need some attention, please check the report above.'); } else { - $this->say('Congrats, looks like your project is Drupal 9 compatible. In any case you can check the report below.'); + if (Semver::satisfies($drupal_version, '^8')) { + $this->say('Congrats, looks like your project is Drupal 9 compatible.'); + } + if (Semver::satisfies($drupal_version, '^9')) { + $this->say('Congrats, looks like your project is Drupal 10 compatible.'); + } } - echo $result . PHP_EOL; return $qaCompatibilityResult; } @@ -887,7 +920,7 @@ protected function checkCommitMessage() { $this->skipOutdated = false; $this->skipInsecure = false; - $this->skipd9c = true; + $this->skipdus = true; $commitMsg = getenv('DRONE_COMMIT_MESSAGE') !== false ? getenv('DRONE_COMMIT_MESSAGE') : ''; $commitMsg = getenv('CI_COMMIT_MESSAGE') !== false ? getenv('CI_COMMIT_MESSAGE') : $commitMsg; @@ -906,7 +939,7 @@ protected function checkCommitMessage() $this->skipInsecure = true; } if ($transformedToken == 'skip_d9c') { - $this->skipd9c = false; + $this->skipdus = false; } } } From 801d4cfd13393e41eb46403e37cfdc4b16476b03 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Tue, 16 Aug 2022 19:43:41 +0000 Subject: [PATCH 03/12] DQA-4443: Create Drupal 10 compatibility check. --- src/TaskRunner/Commands/TestsCommands.php | 1 - src/TaskRunner/Commands/ToolCommands.php | 8 ++++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/TaskRunner/Commands/TestsCommands.php b/src/TaskRunner/Commands/TestsCommands.php index ea0ba8c6e..b32a45a74 100644 --- a/src/TaskRunner/Commands/TestsCommands.php +++ b/src/TaskRunner/Commands/TestsCommands.php @@ -771,5 +771,4 @@ public function toolkitBlackfire() return new ResultData(0); } - } diff --git a/src/TaskRunner/Commands/ToolCommands.php b/src/TaskRunner/Commands/ToolCommands.php index 2c1e1653e..239c1c27f 100644 --- a/src/TaskRunner/Commands/ToolCommands.php +++ b/src/TaskRunner/Commands/ToolCommands.php @@ -744,14 +744,14 @@ public function drupalUpgradeStatus(array $options = [ $drushBin = $this->getBin('drush'); $collection = $this->collectionBuilder(); // Require 'drupal/upgrade_status' if does not exist on the project. - if (self::getPackagePropertyFromComposer('drupal/upgrade_status') != FALSE) { + if (self::getPackagePropertyFromComposer('drupal/upgrade_status') != false) { $collection->taskComposerRequire() ->dependency('drupal/upgrade_status', '^3') ->dev() ->run(); } // Require 'drupal/core-dev' if does not exist on the project. - if (self::getPackagePropertyFromComposer('drupal/core-dev') != FALSE) { + if (self::getPackagePropertyFromComposer('drupal/core-dev') != false) { $collection->taskComposerRequire() ->dependency('drupal/core-dev') ->dev() @@ -803,10 +803,10 @@ public function drupalUpgradeStatus(array $options = [ $this->say('Looks the project need some attention, please check the report above.'); } else { if (Semver::satisfies($drupal_version, '^8')) { - $this->say('Congrats, looks like your project is Drupal 9 compatible.'); + $this->say('Congrats, looks like your project is Drupal 9 compatible.'); } if (Semver::satisfies($drupal_version, '^9')) { - $this->say('Congrats, looks like your project is Drupal 10 compatible.'); + $this->say('Congrats, looks like your project is Drupal 10 compatible.'); } } From 5c070698b99260ec49d81a7d4790d7563ef46d7e Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Tue, 16 Aug 2022 19:49:09 +0000 Subject: [PATCH 04/12] DQA-4443: Create Drupal 10 compatibility check. --- composer.json | 1 - src/TaskRunner/Commands/ToolCommands.php | 6 +++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/composer.json b/composer.json index 2ae4d1fc9..59dbdd874 100644 --- a/composer.json +++ b/composer.json @@ -22,7 +22,6 @@ "ec-europa/qa-automation": "^8.1.5", "guzzlehttp/guzzle": "^6.3 || ^7.0", "j13k/yaml-lint": "^1.1", - "mglaman/drupal-check": "^1.4", "openeuropa/task-runner": "^2.0@alpha", "php-parallel-lint/php-parallel-lint": "^1.3", "phpmd/phpmd": "^2.12", diff --git a/src/TaskRunner/Commands/ToolCommands.php b/src/TaskRunner/Commands/ToolCommands.php index 239c1c27f..274ac7d01 100644 --- a/src/TaskRunner/Commands/ToolCommands.php +++ b/src/TaskRunner/Commands/ToolCommands.php @@ -727,7 +727,7 @@ public function drupalUpgradeStatus(array $options = [ $this->checkCommitMessage(); - if (!$this->skipdus) { + if (!$this->skipDus) { $this->say('Developer is skipping Drupal 9/10 compatibility analysis.'); return 0; } @@ -920,7 +920,7 @@ protected function checkCommitMessage() { $this->skipOutdated = false; $this->skipInsecure = false; - $this->skipdus = true; + $this->skipDus = true; $commitMsg = getenv('DRONE_COMMIT_MESSAGE') !== false ? getenv('DRONE_COMMIT_MESSAGE') : ''; $commitMsg = getenv('CI_COMMIT_MESSAGE') !== false ? getenv('CI_COMMIT_MESSAGE') : $commitMsg; @@ -939,7 +939,7 @@ protected function checkCommitMessage() $this->skipInsecure = true; } if ($transformedToken == 'skip_d9c') { - $this->skipdus = false; + $this->skipDus = false; } } } From aac19d3f64957a232d6e26ab39e01e8251458531 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Tue, 16 Aug 2022 19:58:29 +0000 Subject: [PATCH 05/12] DQA-4443: Create Drupal 10 compatibility check. --- src/TaskRunner/Commands/ToolCommands.php | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/TaskRunner/Commands/ToolCommands.php b/src/TaskRunner/Commands/ToolCommands.php index 274ac7d01..8b85cd148 100644 --- a/src/TaskRunner/Commands/ToolCommands.php +++ b/src/TaskRunner/Commands/ToolCommands.php @@ -720,23 +720,26 @@ public function drupalUpgradeStatus(array $options = [ 'skip' => InputOption::VALUE_OPTIONAL, ]): int { - $mode = $this->getConfig()->get('toolkit.tool.drupal-upgrade.skip'); + $skip = $this->getConfig()->get('toolkit.tool.drupal-upgrade.skip'); if (!empty($options['skip'])) { $skip = $options['skip']; } $this->checkCommitMessage(); - if (!$this->skipDus) { - $this->say('Developer is skipping Drupal 9/10 compatibility analysis.'); - return 0; - } - if ($drupal_version = self::getPackagePropertyFromComposer('drupal/core')) { if (Semver::satisfies($drupal_version, '^10')) { $this->say('Project already running on Drupal 10, skipping Drupal 10 compatibility analysis.'); return 0; } + if (!$this->skipDus && Semver::satisfies($drupal_version, '^8')) { + $this->say('Developer is skipping Drupal 9 compatibility analysis.'); + return 0; + } + if (!$this->skipDus && Semver::satisfies($drupal_version, '^9')) { + $this->say('Developer is skipping Drupal 10 compatibility analysis.'); + return 0; + } } // Prepare project. From 3280679ac4e00c12173e6e6a6a31bfdc7e6bbc14 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Wed, 17 Aug 2022 14:00:27 +0000 Subject: [PATCH 06/12] DQA-4443: Create Drupal 10 compatibility check. --- src/TaskRunner/Commands/ToolCommands.php | 56 ++++++------------------ 1 file changed, 13 insertions(+), 43 deletions(-) diff --git a/src/TaskRunner/Commands/ToolCommands.php b/src/TaskRunner/Commands/ToolCommands.php index 8b85cd148..babcbcb85 100644 --- a/src/TaskRunner/Commands/ToolCommands.php +++ b/src/TaskRunner/Commands/ToolCommands.php @@ -713,33 +713,14 @@ public static function postQaContent(array $fields, string $auth): string * @command toolkit:drupal-upgrade-status * * @aliases tdus - * - * @option skip Return results from a previous scan of a project (defaults to: 'false') */ - public function drupalUpgradeStatus(array $options = [ - 'skip' => InputOption::VALUE_OPTIONAL, - ]): int + public function drupalUpgradeStatus(): int { - $skip = $this->getConfig()->get('toolkit.tool.drupal-upgrade.skip'); - if (!empty($options['skip'])) { - $skip = $options['skip']; - } $this->checkCommitMessage(); - if ($drupal_version = self::getPackagePropertyFromComposer('drupal/core')) { - if (Semver::satisfies($drupal_version, '^10')) { - $this->say('Project already running on Drupal 10, skipping Drupal 10 compatibility analysis.'); - return 0; - } - if (!$this->skipDus && Semver::satisfies($drupal_version, '^8')) { - $this->say('Developer is skipping Drupal 9 compatibility analysis.'); - return 0; - } - if (!$this->skipDus && Semver::satisfies($drupal_version, '^9')) { - $this->say('Developer is skipping Drupal 10 compatibility analysis.'); - return 0; - } + if (!$this->skipDus) { + return 0; } // Prepare project. @@ -767,25 +748,14 @@ public function drupalUpgradeStatus(array $options = [ ->exec($drushBin . ' en upgrade_status -y') ->run(); - // Return results from a previous scan of a project. - if ($skip == true) { - $result = $collection->taskExecStack() - ->exec($drushBin . ' us-a --all --skip-existing') - ->printOutput(false) - ->storeState('insecure') - ->silent(true) - ->run() - ->getMessage(); - } else { - // Otherwise perform the default module's analysis. - $result = $collection->taskExecStack() - ->exec($drushBin . ' us-a --all') - ->printOutput(false) - ->storeState('insecure') - ->silent(true) - ->run() - ->getMessage(); - } + // Perform the default analysis to all contrib and custom components. + $result = $collection->taskExecStack() + ->exec($drushBin . ' us-a --all') + ->printOutput(false) + ->storeState('insecure') + ->silent(true) + ->run() + ->getMessage(); // Check flagged results. $qaCompatibilityResult = 0; @@ -806,10 +776,10 @@ public function drupalUpgradeStatus(array $options = [ $this->say('Looks the project need some attention, please check the report above.'); } else { if (Semver::satisfies($drupal_version, '^8')) { - $this->say('Congrats, looks like your project is Drupal 9 compatible.'); + $this->say('Congrats, looks like your project is Drupal 9 compatible.'); } if (Semver::satisfies($drupal_version, '^9')) { - $this->say('Congrats, looks like your project is Drupal 10 compatible.'); + $this->say('Congrats, looks like your project is Drupal 10 compatible.'); } } From 4154afc59956c1124193fb4ef43e0d585abe48fd Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Wed, 17 Aug 2022 14:03:39 +0000 Subject: [PATCH 07/12] DQA-4443: Create Drupal 10 compatibility check. --- config/default.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/config/default.yml b/config/default.yml index c38fbedd8..fee046b28 100644 --- a/config/default.yml +++ b/config/default.yml @@ -125,8 +125,6 @@ toolkit: whitelist-components: endpoint: 'https://webgate.ec.europa.eu/fpfis/qa/api/v1/package-reviews?version=8.x' blocker: true - drupal-upgrade: - skip: false invalid-versions: - 1.x - 2.x From 55a7f948f4122454c76ad5d4203f0e63036c83da Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Thu, 18 Aug 2022 10:40:11 +0000 Subject: [PATCH 08/12] DQA-3063: Rebuild documentation. --- .gitignore | 2 +- ...kit-TaskRunner-Commands-BuildCommands.html | 848 ++++++ ...kit-TaskRunner-Commands-CloneCommands.html | 1003 +++++++ ...it-TaskRunner-Commands-DrupalCommands.html | 618 +++++ ...t-TaskRunner-Commands-InstallCommands.html | 520 ++++ ...er-Commands-LoadDefaultConfigCommands.html | 420 +++ ...kit-TaskRunner-Commands-TestsCommands.html | 1356 ++++++++++ ...lkit-TaskRunner-Commands-ToolCommands.html | 2313 +++++++++++++++++ .../EcEuropa-Toolkit-Tests-AbstractTest.html | 784 ++++++ ...lkit-Tests-Commands-BuildCommandsTest.html | 928 +++++++ ...lkit-Tests-Commands-CloneCommandsTest.html | 928 +++++++ ...kit-Tests-Commands-DrupalCommandsTest.html | 937 +++++++ ...it-Tests-Commands-InstallCommandsTest.html | 928 +++++++ docs/classes/EcEuropa-Toolkit-Toolkit.html | 619 +++++ ...Site-Tests-Behat-BlackfireMinkContext.html | 931 +++++++ docs/css/base.css | 1106 ++++++++ docs/css/normalize.css | 427 +++ docs/css/template.css | 192 ++ ...ources-blackfire-blackfireminkcontext.html | 253 ++ ...src-taskrunner-commands-buildcommands.html | 253 ++ ...src-taskrunner-commands-clonecommands.html | 253 ++ ...rc-taskrunner-commands-drupalcommands.html | 253 ++ ...c-taskrunner-commands-installcommands.html | 253 ++ ...er-commands-loaddefaultconfigcommands.html | 253 ++ ...src-taskrunner-commands-testscommands.html | 253 ++ .../src-taskrunner-commands-toolcommands.html | 253 ++ docs/files/src-toolkit.html | 253 ++ docs/files/tests-abstracttest.html | 253 ++ .../tests-commands-buildcommandstest.html | 253 ++ .../tests-commands-clonecommandstest.html | 253 ++ .../tests-commands-drupalcommandstest.html | 307 +++ .../tests-commands-installcommandstest.html | 253 ++ docs/graphs/classes.html | 126 + docs/index.html | 154 ++ docs/indices/files.html | 163 ++ docs/js/search.js | 173 ++ docs/js/searchIndex.js | 649 +++++ docs/namespaces/default.html | 242 ++ .../eceuropa-toolkit-taskrunner-commands.html | 314 +++ .../eceuropa-toolkit-taskrunner.html | 243 ++ .../eceuropa-toolkit-tests-commands.html | 254 ++ docs/namespaces/eceuropa-toolkit-tests.html | 255 ++ docs/namespaces/eceuropa-toolkit.html | 255 ++ docs/namespaces/eceuropa.html | 241 ++ .../openeuropa-site-tests-behat.html | 248 ++ docs/namespaces/openeuropa-site-tests.html | 243 ++ docs/namespaces/openeuropa-site.html | 242 ++ docs/namespaces/openeuropa.html | 241 ++ docs/packages/Application.html | 325 +++ docs/packages/default.html | 241 ++ docs/reports/deprecated.html | 156 ++ docs/reports/errors.html | 138 + docs/reports/markers.html | 139 + 53 files changed, 23497 insertions(+), 1 deletion(-) create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html create mode 100644 docs/classes/EcEuropa-Toolkit-Tests-AbstractTest.html create mode 100644 docs/classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html create mode 100644 docs/classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html create mode 100644 docs/classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html create mode 100644 docs/classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html create mode 100644 docs/classes/EcEuropa-Toolkit-Toolkit.html create mode 100644 docs/classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html create mode 100644 docs/css/base.css create mode 100644 docs/css/normalize.css create mode 100644 docs/css/template.css create mode 100644 docs/files/resources-blackfire-blackfireminkcontext.html create mode 100644 docs/files/src-taskrunner-commands-buildcommands.html create mode 100644 docs/files/src-taskrunner-commands-clonecommands.html create mode 100644 docs/files/src-taskrunner-commands-drupalcommands.html create mode 100644 docs/files/src-taskrunner-commands-installcommands.html create mode 100644 docs/files/src-taskrunner-commands-loaddefaultconfigcommands.html create mode 100644 docs/files/src-taskrunner-commands-testscommands.html create mode 100644 docs/files/src-taskrunner-commands-toolcommands.html create mode 100644 docs/files/src-toolkit.html create mode 100644 docs/files/tests-abstracttest.html create mode 100644 docs/files/tests-commands-buildcommandstest.html create mode 100644 docs/files/tests-commands-clonecommandstest.html create mode 100644 docs/files/tests-commands-drupalcommandstest.html create mode 100644 docs/files/tests-commands-installcommandstest.html create mode 100644 docs/graphs/classes.html create mode 100644 docs/index.html create mode 100644 docs/indices/files.html create mode 100644 docs/js/search.js create mode 100644 docs/js/searchIndex.js create mode 100644 docs/namespaces/default.html create mode 100644 docs/namespaces/eceuropa-toolkit-taskrunner-commands.html create mode 100644 docs/namespaces/eceuropa-toolkit-taskrunner.html create mode 100644 docs/namespaces/eceuropa-toolkit-tests-commands.html create mode 100644 docs/namespaces/eceuropa-toolkit-tests.html create mode 100644 docs/namespaces/eceuropa-toolkit.html create mode 100644 docs/namespaces/eceuropa.html create mode 100644 docs/namespaces/openeuropa-site-tests-behat.html create mode 100644 docs/namespaces/openeuropa-site-tests.html create mode 100644 docs/namespaces/openeuropa-site.html create mode 100644 docs/namespaces/openeuropa.html create mode 100644 docs/packages/Application.html create mode 100644 docs/packages/default.html create mode 100644 docs/reports/deprecated.html create mode 100644 docs/reports/errors.html create mode 100644 docs/reports/markers.html diff --git a/.gitignore b/.gitignore index eda4706ca..e7b8aa720 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,6 @@ /grumphp.yml /docker-compose.*.yml .phpunit.result.cache - *.sql phpda.* +.phpdoc* \ No newline at end of file diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html new file mode 100644 index 000000000..cbd84f5a8 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html @@ -0,0 +1,848 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
+

Documentation

+ + + + + +
+ +
+
+ + + + +
+ + +
+

+ BuildCommands + + + extends AbstractCommands + + +
+ in package + +
+ + + + Uses + loadTasks +

+ + + +

Provides commands to build a site for development and a production artifact.

+ + + +
+ Tags + +
+
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ buildAssets() + +  : Result|int +
+
Build theme assets (Css and Js).
+ +
+ buildDev() + +  : CollectionBuilder +
+
Build site for local development.
+ +
+ buildDevReset() + +  : CollectionBuilder +
+
Build site for local development from scratch with a clean git.
+ +
+ buildDist() + +  : CollectionBuilder +
+
Build the distribution package.
+ +
+ getConfigurationFile() + +  : mixed +
+
{@inheritdoc}
+ +
+ getGitCommitHash() + +  : string +
+
Returns the current Git commit hash.
+ +
+ getGitTag() + +  : string +
+
Returns the current Git tag.
+ +
+ + + + + + + +
+

+ Methods + +

+
+

+ buildAssets() + +

+ + +

Build theme assets (Css and Js).

+ + + public + buildAssets([array<string|int, mixed> $options = ['default-theme' => InputOption::VALUE_REQUIRED, 'build-npm-packages' => InputOption::VALUE_OPTIONAL, 'build-npm-mode' => InputOption::VALUE_OPTIONAL, 'validate' => InputOption::VALUE_OPTIONAL, 'theme-task-runner' => InputOption::VALUE_OPTIONAL] ]) : Result|int + + +
Parameters
+
+
+ $options + : array<string|int, mixed> + = ['default-theme' => InputOption::VALUE_REQUIRED, 'build-npm-packages' => InputOption::VALUE_OPTIONAL, 'build-npm-mode' => InputOption::VALUE_OPTIONAL, 'validate' => InputOption::VALUE_OPTIONAL, 'theme-task-runner' => InputOption::VALUE_OPTIONAL]
+
+

Additional options for the command.

+
+ +
+
+ + +
+ Tags + +
+
+
+ SuppressWarnings +
+
+ +

(PHPMD.CyclomaticComplexity)

+
+ +
+
+ command +
+
+ +

toolkit:build-assets

+
+ +
+
+ option +
+
+ +

default-theme theme where to build assets.

+
+ +
+
+ option +
+
+ +

validate or validate=fix to check or fix scss files.

+
+ +
+
+ aliases +
+
+ +

tba

+
+ +
+
+ +
Return values
+ Result|int + — +

The collection builder.

+
+ + +
+
+

+ buildDev() + +

+ + +

Build site for local development.

+ + + public + buildDev([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + + +
Parameters
+
+
+ $options + : array<string|int, mixed> + = ['root' => InputOption::VALUE_REQUIRED]
+
+

Command options.

+
+ +
+
+ + +
+ Tags + +
+
+
+ command +
+
+ +

toolkit:build-dev

+
+ +
+
+ option +
+
+ +

root Drupal root.

+
+ +
+
+ +
Return values
+ CollectionBuilder + — +

Collection builder.

+
+ + +
+
+

+ buildDevReset() + +

+ + +

Build site for local development from scratch with a clean git.

+ + + public + buildDevReset([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'yes' => InputOption::VALUE_OPTIONAL] ]) : CollectionBuilder + + +
Parameters
+
+
+ $options + : array<string|int, mixed> + = ['root' => InputOption::VALUE_REQUIRED, 'yes' => InputOption::VALUE_OPTIONAL]
+
+

Command options.

+
+ +
+
+ + +
+ Tags + +
+
+
+ command +
+
+ +

toolkit:build-dev-reset

+
+ +
+
+ option +
+
+ +

root Drupal root.

+
+ +
+
+ option +
+
+ +

yes Skip the question.

+
+ +
+
+ +
Return values
+ CollectionBuilder + — +

Collection builder.

+
+ + +
+
+

+ buildDist() + +

+ + +

Build the distribution package.

+ + + public + buildDist([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'dist-root' => InputOption::VALUE_REQUIRED, 'keep' => InputOption::VALUE_REQUIRED, 'tag' => InputOption::VALUE_OPTIONAL, 'sha' => InputOption::VALUE_OPTIONAL, 'remove' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + +

This will create the distribution package intended to be deployed. +The folder structure will match the following:

+
    +
  • ./dist
  • +
  • ./dist/composer.json
  • +
  • ./dist/composer.lock
  • +
  • ./dist/manifest.json
  • +
  • ./dist/config
  • +
  • ./dist/vendor
  • +
  • ./dist/web
  • +
  • ./dist/web/VERSION.txt
  • +
+
+ +
Parameters
+
+
+ $options + : array<string|int, mixed> + = ['root' => InputOption::VALUE_REQUIRED, 'dist-root' => InputOption::VALUE_REQUIRED, 'keep' => InputOption::VALUE_REQUIRED, 'tag' => InputOption::VALUE_OPTIONAL, 'sha' => InputOption::VALUE_OPTIONAL, 'remove' => InputOption::VALUE_REQUIRED]
+
+

Command options.

+
+ +
+
+ + +
+ Tags + +
+
+
+ command +
+
+ +

toolkit:build-dist

+
+ +
+
+ option +
+
+ +

root Drupal root.

+
+ +
+
+ option +
+
+ +

dist-root Distribution package root.

+
+ +
+
+ option +
+
+ +

keep Comma separated list of files and folders to keep.

+
+ +
+
+ option +
+
+ +

tag (deprecated) Version tag for manifest.

+
+ +
+
+ option +
+
+ +

sha (deprecated) Commit hash for manifest.

+
+ +
+
+ SuppressWarnings +
+
+ +

(PHPMD.CyclomaticComplexity)

+
+ +
+
+ SuppressWarnings +
+
+ +

(PHPMD.NPathComplexity)

+
+ +
+
+ +
Return values
+ CollectionBuilder + — +

Collection builder.

+
+ + +
+
+

+ getConfigurationFile() + +

+ + +

{@inheritdoc}

+ + + public + getConfigurationFile() : mixed + + + + +
+ Tags + +
+
+
+ +
Return values
+ mixed + — + + +
+
+

+ getGitCommitHash() + +

+ + +

Returns the current Git commit hash.

+ + + protected + getGitCommitHash() : string + + + + +
+ Tags + +
+
+
+ +
Return values
+ string + — +

Current Git hash.

+
+ + +
+
+

+ getGitTag() + +

+ + +

Returns the current Git tag.

+ + + protected + getGitTag() : string + + + + +
+ Tags + +
+
+
+ +
Return values
+ string + — +

Current Git tag.

+
+ + +
+
+ +
+
+
+
+

+        
+ +
+
+ + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html new file mode 100644 index 000000000..e0a9b8d57 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html @@ -0,0 +1,1003 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
    +

    Documentation

    + + + + + +
    + +
    +
    + + + + +
    + + +
    +

    + CloneCommands + + + extends AbstractCommands + + +
    + in package + +
    + + + + Uses + loadTasks +

    + + + +

    Provides commands to clone a site for development and a production artifact.

    + + + +
    + Tags + +
    +
    +
    + + + + + + +

    + Table of Contents + +

    + +
    +
    + downloadDump() + +  : CollectionBuilder +
    +
    Download ASDA snapshot.
    + +
    + getConfigurationFile() + +  : mixed +
    +
    {@inheritdoc}
    + +
    + installDump() + +  : CollectionBuilder +
    +
    Import the production snapshot.
    + +
    + runDeploy() + +  : CollectionBuilder +
    +
    Run deployment sequence.
    + +
    + asdaProcessFile() + +  : array<string|int, mixed> +
    +
    Helper to download and process a ASDA file.
    + +
    + checkForNewerDump() + +  : bool +
    +
    Check if a newer dump exists on the server.
    + +
    + generateAsdaWgetInputFile() + +  : mixed +
    +
    Create file containing a url for usage in wget --input-file argument.
    + +
    + tmpDirectory() + +  : string +
    +
    Return the tmp folder path, folder is created if missing.
    + +
    + wgetDownloadFile() + +  : CollectionBuilder|Exec +
    +
    Download the file present in the tmp file.
    + +
    + + + + + + + +
    +

    + Methods + +

    +
    +

    + downloadDump() + +

    + + +

    Download ASDA snapshot.

    + + + public + downloadDump([array<string|int, mixed> $options = ['is-admin' => InputOption::VALUE_NONE, 'yes' => InputOption::VALUE_NONE] ]) : CollectionBuilder + +

    Configuration for ASDA in NEXTCLOUD.

    +
      +
    • Environment variables: NEXTCLOUD_USER, NEXTCLOUD_PASS (EU Login).
    • +
    • Runner variables:
    • +
    +
    + +
    Parameters
    +
    +
    + $options + : array<string|int, mixed> + = ['is-admin' => InputOption::VALUE_NONE, 'yes' => InputOption::VALUE_NONE]
    +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + code +
    +
    + +

    toolkit: +clone: +asda_services: +- mysql +- solr +- virtuoso +asda_type: 'nextcloud' +nextcloud_url: 'files.fpfis.tech.ec.europa.eu/remote.php/dav/files'

    +
    + +
    +
    + code +
    +
    + +

    toolkit: +clone: +asda_type: 'default' +asda_url: 'webgate.ec.europa.eu/fpfis/files-for/automate_dumps/${toolkit.project_id}'

    +
    + +
    +
    + endcode +
    +
    + +

    Configuration for ASDA default.

    +
      +
    • Environment variables: ASDA_USER, ASDA_PASSWORD.
    • +
    • Runner variables:
    • +
    +
    + +
    +
    + endcode +
    +
    + + +
    +
    + command +
    +
    + +

    toolkit:download-dump

    +
    + +
    +
    + option +
    +
    + +

    is-admin For nextcloud admin user.

    +
    + +
    +
    + option +
    +
    + +

    yes Skip the question to download newer dump.

    +
    + +
    +
    + +
    Return values
    + CollectionBuilder + — +

    Collection builder.

    +
    + + +
    +
    +

    + getConfigurationFile() + +

    + + +

    {@inheritdoc}

    + + + public + getConfigurationFile() : mixed + + + + +
    + Tags + +
    +
    +
    + +
    Return values
    + mixed + — + + +
    +
    +

    + installDump() + +

    + + +

    Import the production snapshot.

    + + + public + installDump([array<string|int, mixed> $options = ['dumpfile' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + + +
    Parameters
    +
    +
    + $options + : array<string|int, mixed> + = ['dumpfile' => InputOption::VALUE_REQUIRED]
    +
    +

    Command options.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + command +
    +
    + +

    toolkit:install-dump

    +
    + +
    +
    + option +
    +
    + +

    dumpfile The dump file name.

    +
    + +
    +
    + +
    Return values
    + CollectionBuilder + — +

    Collection builder.

    +
    + + +
    +
    +

    + runDeploy() + +

    + + +

    Run deployment sequence.

    + + + public + runDeploy([array<string|int, mixed> $options = ['sequence-file' => InputOption::VALUE_REQUIRED, 'sequence-key' => InputOption::VALUE_REQUIRED, 'config-file' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + +

    This command will check for a file that holds the deployment sequence. If +it is available it will run the commands defined in the yaml file under the +selected key. If not we will run a standard set of deployment commands.

    +
    + +
    Parameters
    +
    +
    + $options + : array<string|int, mixed> + = ['sequence-file' => InputOption::VALUE_REQUIRED, 'sequence-key' => InputOption::VALUE_REQUIRED, 'config-file' => InputOption::VALUE_REQUIRED]
    +
    +

    Command options.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + command +
    +
    + +

    toolkit:run-deploy

    +
    + +
    +
    + option +
    +
    + +

    sequence-file The file that holds the deployment sequence.

    +
    + +
    +
    + option +
    +
    + +

    sequence-key The key under which the commands are defined.

    +
    + +
    +
    + option +
    +
    + +

    config-file The config file that triggers the config import.

    +
    + +
    +
    + +
    Return values
    + CollectionBuilder + — +

    Collection builder.

    +
    + + +
    +
    +

    + asdaProcessFile() + +

    + + +

    Helper to download and process a ASDA file.

    + + + private + asdaProcessFile( $link,  $service) : array<string|int, mixed> + + +
    Parameters
    +
    +
    + $link + : +
    +
    +

    The link to the folder.

    +
    + +
    +
    + $service + : +
    +
    +

    The service to use.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + +
    Return values
    + array<string|int, mixed> + — +

    The tasks to execute.

    +
    + + +
    +
    +

    + checkForNewerDump() + +

    + + +

    Check if a newer dump exists on the server.

    + + + private + checkForNewerDump( $link,  $service) : bool + + +
    Parameters
    +
    +
    + $link + : +
    +
    +

    The link to the folder.

    +
    + +
    +
    + $service + : +
    +
    +

    The service to use.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + +
    Return values
    + bool + — +

    Return true if sha1 from local is different from the server, +False is case of error or no local file exists.

    +
    + + +
    +
    +

    + generateAsdaWgetInputFile() + +

    + + +

    Create file containing a url for usage in wget --input-file argument.

    + + + private + generateAsdaWgetInputFile(string $url, string $tmp[, bool $silent = false ]) : mixed + + +
    Parameters
    +
    +
    + $url + : string +
    +
    +

    Url to fill in the temp file.

    +
    + +
    +
    + $tmp + : string +
    +
    +

    The temporary filename.

    +
    + +
    +
    + $silent + : bool + = false
    +
    +

    Whether show or not output from task.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + +
    Return values
    + mixed + — + + +
    +
    +

    + tmpDirectory() + +

    + + +

    Return the tmp folder path, folder is created if missing.

    + + + private + tmpDirectory() : string + + + + +
    + Tags + +
    +
    +
    + +
    Return values
    + string + — +

    The tmp folder path.

    +
    + + +
    +
    +

    + wgetDownloadFile() + +

    + + +

    Download the file present in the tmp file.

    + + + private + wgetDownloadFile( $tmp,  $destination[, null $accept = null ][, bool $silent = false ]) : CollectionBuilder|Exec + + +
    Parameters
    +
    +
    + $tmp + : +
    +
    +

    The temporary filename.

    +
    + +
    +
    + $destination + : +
    +
    +

    The destination filename.

    +
    + +
    +
    + $accept + : null + = null
    +
    +

    A comma-separated list of accepted extensions.

    +
    + +
    +
    + $silent + : bool + = false
    +
    +

    Whether show or not output from task.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + +
    Return values
    + CollectionBuilder|Exec + — + + +
    +
    + +
    +
    +
    +
    +
    
    +        
    + +
    +
    + + + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html new file mode 100644 index 000000000..bb51ff9f5 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html @@ -0,0 +1,618 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
      +

      Documentation

      + + + + + +
      + +
      +
      + + + + +
      + + +
      +

      + DrupalCommands + + + extends Drupal8Commands + + +
      + in package + +
      + + +

      + + + +

      Drupal commands to setup and install a Drupal 8 site.

      + + + +
      + Tags + +
      +
      +
      + + + + + + +

      + Table of Contents + +

      + +
      +
      + $blockEnd + +  : string +
      +
      Comment ending the Toolkit settings block.
      + +
      + $blockStart + +  : string +
      +
      Comment starting the Toolkit settings block.
      + +
      + settingsSetup() + +  : CollectionBuilder +
      +
      Setup Drupal settings.php file in compliance with Toolkit conventions.
      + +
      + getSettingsBlockRegex() + +  : string +
      +
      Remove settings block from given content.
      + +
      + getToolkitSettingsBlock() + +  : string +
      +
      Helper function to update settings.php file.
      + +
      + + + + + + +
      +

      + Properties + +

      +
      +

      + $blockEnd + + + +

      + + +

      Comment ending the Toolkit settings block.

      + + + protected + string + $blockEnd + = '// End Toolkit settings block.' + + + + +
      + Tags + +
      +
      +
      + +
      +
      +

      + $blockStart + + + +

      + + +

      Comment starting the Toolkit settings block.

      + + + protected + string + $blockStart + = '// Start Toolkit settings block.' + + + + +
      + Tags + +
      +
      +
      + +
      +
      + +
      +

      + Methods + +

      +
      +

      + settingsSetup() + +

      + + +

      Setup Drupal settings.php file in compliance with Toolkit conventions.

      + + + public + settingsSetup([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED, 'force' => false, 'skip-permissions-setup' => false] ]) : CollectionBuilder + +

      This command will:

      +
        +
      • Copy "default.settings.php" to "settings.php", which will be overridden +if existing
      • +
      • Add database and config directory settings using environment variables
      • +
      • Append to "settings.php" an include operation for a +"settings.override.php" +file
      • +
      +

      You can specify additional settings.php portions in your local +runner.yml.dist/runner.yml +as shown below:

      +
      +

      drupal: +additional_settings: | +$config['cas.settings']['server']['hostname'] = getenv('CAS_HOSTNAME'), +$config['cas.settings']['server']['port'] = getenv('CAS_PORT');

      +
      +

      You can specify additional service parameters in your local +runner.yml.dist/runner.yml +as shown below:

      +
      +

      drupal: +service_parameters: +session.storage.options: +cookie_domain: '.europa.eu'

      +
      +

      The settings override file name cannot be changed, changing the +"drupal.site.settings_override_file" property will have no effect.

      +
      + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = ['root' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED, 'force' => false, 'skip-permissions-setup' => false]
      +
      +

      Command options.

      +
      + +
      +
      + + +
      + Tags + +
      +
      +
      + command +
      +
      + +

      drupal:settings-setup

      +
      + +
      +
      + option +
      +
      + +

      root Drupal root.

      +
      + +
      +
      + option +
      +
      + +

      sites-subdir Drupal site subdirectory.

      +
      + +
      +
      + option +
      +
      + +

      force Drupal force generation of a new +settings.php.

      +
      + +
      +
      + option +
      +
      + +

      skip-permissions-setup Drupal skip permissions setup.

      +
      + +
      +
      + +
      Return values
      + CollectionBuilder + — +

      Collection builder.

      +
      + + +
      +
      +

      + getSettingsBlockRegex() + +

      + + +

      Remove settings block from given content.

      + + + protected + getSettingsBlockRegex() : string + + + + +
      + Tags + +
      +
      +
      + +
      Return values
      + string + — +

      Content without setting block.

      +
      + + +
      +
      +

      + getToolkitSettingsBlock() + +

      + + +

      Helper function to update settings.php file.

      + + + protected + getToolkitSettingsBlock() : string + + + + +
      + Tags + +
      +
      +
      + +
      Return values
      + string + — +

      Database configuration to be attached to Drupal settings.php.

      +
      + + +
      +
      + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html new file mode 100644 index 000000000..f9a0816d6 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html @@ -0,0 +1,520 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
        +

        Documentation

        + + + + + +
        + +
        +
        + + + + +
        + + +
        +

        + InstallCommands + + + extends AbstractCommands + + +
        + in package + +
        + + + + Uses + loadTasks, loadTasks +

        + + + +

        Class ToolkitCommands.

        + + + +
        + Tags + +
        +
        +
        + + + + + + +

        + Table of Contents + +

        + +
        +
        + getConfigurationFile() + +  : mixed +
        +
        {@inheritdoc}
        + +
        + importConfig() + +  : CollectionBuilder +
        +
        Import config.
        + +
        + installClean() + +  : CollectionBuilder +
        +
        Install a clean website.
        + +
        + installClone() + +  : CollectionBuilder +
        +
        Install a clone website.
        + +
        + + + + + + + +
        +

        + Methods + +

        +
        +

        + getConfigurationFile() + +

        + + +

        {@inheritdoc}

        + + + public + getConfigurationFile() : mixed + + + + +
        + Tags + +
        +
        +
        + +
        Return values
        + mixed + — + + +
        +
        +

        + importConfig() + +

        + + +

        Import config.

        + + + public + importConfig() : CollectionBuilder + + + + +
        + Tags + +
        +
        +
        + command +
        +
        + +

        toolkit:import-config

        +
        + +
        +
        + +
        Return values
        + CollectionBuilder + — +

        Collection builder.

        +
        + + +
        +
        +

        + installClean() + +

        + + +

        Install a clean website.

        + + + public + installClean([array<string|int, mixed> $options = ['config-file' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + + +
        Parameters
        +
        +
        + $options + : array<string|int, mixed> + = ['config-file' => InputOption::VALUE_REQUIRED]
        +
        +

        Command options.

        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + command +
        +
        + +

        toolkit:install-clean

        +
        + +
        +
        + +
        Return values
        + CollectionBuilder + — +

        Collection builder.

        +
        + + +
        +
        +

        + installClone() + +

        + + +

        Install a clone website.

        + + + public + installClone() : CollectionBuilder + + + + +
        + Tags + +
        +
        +
        + command +
        +
        + +

        toolkit:install-clone

        +
        + +
        +
        + +
        Return values
        + CollectionBuilder + — +

        Collection builder.

        +
        + + +
        +
        + +
        +
        +
        +
        +
        
        +        
        + +
        +
        + + + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html new file mode 100644 index 000000000..80085ad40 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html @@ -0,0 +1,420 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
          +

          Documentation

          + + + + + +
          + +
          +
          + + + + +
          + + +
          +

          + LoadDefaultConfigCommands + + + extends AbstractCommands + + +
          + in package + +
          + + +

          + + + +

          Default configuration loader.

          + +

          This class does not expose any commands as it is used to load default +Toolkit configuration using Annotated Commands hooks.

          +
          + + +
          + Tags + +
          +
          +
          + see +
          +
          + https://github.com/consolidation/annotated-command#command-event-hook + + +
          +
          + + + + + + +

          + Table of Contents + +

          + +
          +
          + getDefaultConfigurationFile() + +  : string +
          +
          Path to YAML configuration file containing command defaults.
          + +
          + loadDefaultConfig() + +  : mixed +
          +
          Load default Toolkit configuration.
          + +
          + + + + + + + +
          +

          + Methods + +

          +
          +

          + getDefaultConfigurationFile() + +

          + + +

          Path to YAML configuration file containing command defaults.

          + + + public + getDefaultConfigurationFile() : string + +

          Command classes should implement this method.

          +
          + + + +
          + Tags + +
          +
          +
          + +
          Return values
          + string + — +

          The path of the default configuration file.

          +
          + + +
          +
          +

          + loadDefaultConfig() + +

          + + +

          Load default Toolkit configuration.

          + + + public + loadDefaultConfig(ConsoleCommandEvent $event) : mixed + +

          The Task Runner does not allow providing default configuration for +commands. In this hook we load Toolkit default configuration and re-apply +it to the Task Runner one.

          +
          + +
          Parameters
          +
          +
          + $event + : ConsoleCommandEvent +
          +
          +

          Event of the console command event.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + hook +
          +
          + +

          pre-command-event *

          +
          + +
          +
          + +
          Return values
          + mixed + — + + +
          +
          + +
          +
          +
          +
          +
          
          +        
          + +
          +
          + + + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html new file mode 100644 index 000000000..4bd7efd97 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html @@ -0,0 +1,1356 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
            +

            Documentation

            + + + + + +
            + +
            +
            + + + + +
            + + +
            +

            + TestsCommands + + + extends AbstractCommands + + +
            + in package + +
            + + + implements + FilesystemAwareInterface + + + Uses + loadTasks, loadTasks, ConfigurationTokensTrait, FilesystemAwareTrait, loadTasks +

            + + + +

            Class TestsCommands.

            + + + +
            + Tags + +
            +
            +
            + + + + +

            + Interfaces, Classes, Traits and Enums + +

            + +
            +
            FilesystemAwareInterface
            +
            + + + +
            + + +

            + Table of Contents + +

            + +
            +
            + getConfigurationFile() + +  : mixed +
            +
            {@inheritdoc}
            + +
            + runGrumphp() + +  : mixed +
            +
            Run PHP code sniffer within GrumPHP.
            + +
            + runPhpcs() + +  : mixed +
            +
            Run PHP code sniffer in standalone mode.
            + +
            + toolkitBehat() + +  : mixed +
            +
            Run Behat tests.
            + +
            + toolkitBlackfire() + +  : mixed +
            +
            Run Blackfire.
            + +
            + toolkitLintPhp() + +  : mixed +
            +
            Run lint PHP.
            + +
            + toolkitLintYaml() + +  : mixed +
            +
            Run lint YAML.
            + +
            + toolkitPhpcbf() + +  : mixed +
            +
            Run PHP code autofixing.
            + +
            + toolkitPhpcbfStandalone() + +  : mixed +
            +
            Run PHP code autofixing in standalone mode.
            + +
            + toolkitPhpcs() + +  : mixed +
            +
            Run PHP code sniffer.
            + +
            + toolkitPhpmd() + +  : mixed +
            +
            Run PHPMD standalone.
            + +
            + toolkitPhpUnit() + +  : mixed +
            +
            Run PHPUnit tests.
            + +
            + toolkitSetupPhpcs() + +  : mixed +
            +
            Setup PHP code sniffer for standalone execution.
            + +
            + checkPhpCsRequirements() + +  : ResultData|void +
            +
            Make sure that the config file exists and configuration is correct.
            + +
            + + + + + + + +
            +

            + Methods + +

            +
            +

            + getConfigurationFile() + +

            + + +

            {@inheritdoc}

            + + + public + getConfigurationFile() : mixed + + + + +
            + Tags + +
            +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + runGrumphp() + +

            + + +

            Run PHP code sniffer within GrumPHP.

            + + + public + runGrumphp() : mixed + + + + +
            + Tags + +
            +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + runPhpcs() + +

            + + +

            Run PHP code sniffer in standalone mode.

            + + + public + runPhpcs() : mixed + + + + +
            + Tags + +
            +
            +
            + code +
            +
            + +

            toolkit: +test: +phpcs: +mode: grumphp || phpcs +config: phpcs.xml +ignore_annotations: 0 +show_sniffs: 0 +standards: +- ./vendor/drupal/coder/coder_sniffer/Drupal +- ./vendor/drupal/coder/coder_sniffer/DrupalPractice +- ./vendor/ec-europa/qa-automation/phpcs/QualityAssurance +ignore_patterns: +- vendor/ +- web/ +- node_modules/ +triggered_by: +- php +- module +- inc +- theme +- install +- yml +files: +- ./lib

            +
            + +
            +
            + endcode +
            +
            + + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitBehat() + +

            + + +

            Run Behat tests.

            + + + public + toolkitBehat([array<string|int, mixed> $options = ['from' => InputOption::VALUE_OPTIONAL, 'to' => InputOption::VALUE_OPTIONAL, 'profile' => InputOption::VALUE_OPTIONAL, 'suite' => InputOption::VALUE_OPTIONAL] ]) : mixed + +

            Additional commands could run before and/or after the Behat tests. Such +commands should be described in configuration files in this way:

            +
            + +
            Parameters
            +
            +
            + $options + : array<string|int, mixed> + = ['from' => InputOption::VALUE_OPTIONAL, 'to' => InputOption::VALUE_OPTIONAL, 'profile' => InputOption::VALUE_OPTIONAL, 'suite' => InputOption::VALUE_OPTIONAL]
            +
            +
            + +
            +
            + + +
            + Tags + +
            +
            +
            + code +
            +
            + +

            toolkit: +test: +behat: +profile: "default" +commands: +before: +- task: exec +command: ls -la +- ... +after: +- task: exec +command: whoami +- ...

            +
            + +
            +
            + endcode +
            +
            + + +
            +
            + command +
            +
            + +

            toolkit:test-behat

            +
            + +
            +
            + aliases +
            +
            + +

            tb

            +
            + +
            +
            + option +
            +
            + +

            from From behat.yml.dist config file.

            +
            + +
            +
            + option +
            +
            + +

            to To behat.yml config file.

            +
            + +
            +
            + option +
            +
            + +

            profile The profile to execute.

            +
            + +
            +
            + option +
            +
            + +

            suite The suite to execute, default runs all suites of profile.

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitBlackfire() + +

            + + +

            Run Blackfire.

            + + + public + toolkitBlackfire() : mixed + + + + +
            + Tags + +
            +
            +
            + command +
            +
            + +

            toolkit:run-blackfire

            +
            + +
            +
            + aliases +
            +
            + +

            tbf

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitLintPhp() + +

            + + +

            Run lint PHP.

            + + + public + toolkitLintPhp() : mixed + +

            Override the default include and exclude patterns in configuration files:

            +
            + + + +
            + Tags + +
            +
            +
            + code +
            +
            + +

            toolkit: +lint: +php: +extensions: [ 'php', 'module', 'inc', 'theme', 'install' ] +exclude: [ 'vendor/', 'web/' ]

            +
            + +
            +
            + endcode +
            +
            + + +
            +
            + command +
            +
            + +

            toolkit:lint-php

            +
            + +
            +
            + aliases +
            +
            + +

            tlp

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitLintYaml() + +

            + + +

            Run lint YAML.

            + + + public + toolkitLintYaml() : mixed + +

            Override the default include and exclude patterns in configuration files:

            +
            + + + +
            + Tags + +
            +
            +
            + code +
            +
            + +

            toolkit: +lint: +yaml: +pattern: [ '.yml', '.yaml', '.yml.dist', '.yaml.dist' ] +include: [ 'lib/' ] +exclude: [ 'vendor/', 'web/', 'node_modules/' ]

            +
            + +
            +
            + endcode +
            +
            + + +
            +
            + command +
            +
            + +

            toolkit:lint-yaml

            +
            + +
            +
            + aliases +
            +
            + +

            tly

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitPhpcbf() + +

            + + +

            Run PHP code autofixing.

            + + + public + toolkitPhpcbf([array<string|int, mixed> $options = ['test-path' => InputOption::VALUE_REQUIRED] ]) : mixed + + +
            Parameters
            +
            +
            + $options + : array<string|int, mixed> + = ['test-path' => InputOption::VALUE_REQUIRED]
            +
            +
            + +
            +
            + + +
            + Tags + +
            +
            +
            + command +
            +
            + +

            toolkit:run-phpcbf

            +
            + +
            +
            + SuppressWarnings +
            +
            + +

            (PHPMD)

            +
            + +
            +
            + option +
            +
            + +

            test-path directory or file path to be autofixed by phpcbf.

            +
            + +
            +
            + aliases +
            +
            + +

            tpb

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitPhpcbfStandalone() + +

            + + +

            Run PHP code autofixing in standalone mode.

            + + + public + toolkitPhpcbfStandalone() : mixed + + + + +
            + Tags + +
            +
            +
            + command +
            +
            + +

            toolkit:run-phpcbf-standalone

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitPhpcs() + +

            + + +

            Run PHP code sniffer.

            + + + public + toolkitPhpcs() : mixed + + + + +
            + Tags + +
            +
            +
            + command +
            +
            + +

            toolkit:test-phpcs

            +
            + +
            +
            + aliases +
            +
            + +

            tp

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitPhpmd() + +

            + + +

            Run PHPMD standalone.

            + + + public + toolkitPhpmd() : mixed + +

            Check configurations at config/default.yml - 'toolkit.test.phpmd'.

            +
            + + + +
            + Tags + +
            +
            +
            + command +
            +
            + +

            toolkit:test-phpmd

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitPhpUnit() + +

            + + +

            Run PHPUnit tests.

            + + + public + toolkitPhpUnit([array<string|int, mixed> $options = ['from' => InputOption::VALUE_OPTIONAL, 'to' => InputOption::VALUE_OPTIONAL] ]) : mixed + +

            Additional commands could run before and/or after the PHPUnit tests. Such +commands should be described in configuration files in this way:

            +
            + +
            Parameters
            +
            +
            + $options + : array<string|int, mixed> + = ['from' => InputOption::VALUE_OPTIONAL, 'to' => InputOption::VALUE_OPTIONAL]
            +
            +
            + +
            +
            + + +
            + Tags + +
            +
            +
            + code +
            +
            + +

            phpunit: +options: '--log-junit report.xml' +commands: +before: +- task: exec +command: ls -la +- ... +after: +- task: exec +command: whoami +- ...

            +
            + +
            +
            + endcode +
            +
            + + +
            +
            + command +
            +
            + +

            toolkit:test-phpunit

            +
            + +
            +
            + aliases +
            +
            + +

            tp

            +
            + +
            +
            + option +
            +
            + +

            from From phpunit.xml.dist config file.

            +
            + +
            +
            + option +
            +
            + +

            to To phpunit.xml config file.

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + toolkitSetupPhpcs() + +

            + + +

            Setup PHP code sniffer for standalone execution.

            + + + public + toolkitSetupPhpcs() : mixed + + + + +
            + Tags + +
            +
            +
            + command +
            +
            + +

            toolkit:setup-phpcs

            +
            + +
            +
            + +
            Return values
            + mixed + — + + +
            +
            +

            + checkPhpCsRequirements() + +

            + + +

            Make sure that the config file exists and configuration is correct.

            + + + private + checkPhpCsRequirements() : ResultData|void + + + + +
            + Tags + +
            +
            +
            + +
            Return values
            + ResultData|void + — +

            No return if all is ok, return 1 if fails.

            +
            + + +
            +
            + +
            +
            +
            +
            +
            
            +        
            + +
            +
            + + + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html new file mode 100644 index 000000000..e3f18fef0 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html @@ -0,0 +1,2313 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
              +

              Documentation

              + + + + + +
              + +
              +
              + + + + +
              + + +
              +

              + ToolCommands + + + extends AbstractCommands + + +
              + in package + +
              + + + + Uses + loadTasks +

              + + + +

              Generic tools.

              + + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.ExcessiveClassComplexity)

              +
              + +
              +
              + + + + + + +

              + Table of Contents + +

              + +
              +
              + componentCheck() + +  : mixed +
              +
              Check composer.json for components that are not whitelisted/blacklisted.
              + +
              + composerLockCheck() + +  : int +
              +
              Check if 'composer.lock' exists on the project root folder.
              + +
              + d9Compatibility() + +  : int +
              +
              Check project compatibility for Drupal 9 upgrade.
              + +
              + disableDrupalCache() + +  : CollectionBuilder +
              +
              Disable aggregation and clear cache.
              + +
              + displayNotifications() + +  : mixed +
              +
              Display toolkit notifications.
              + +
              + fixPermissions() + +  : mixed +
              +
              Run script to fix permissions (experimental).
              + +
              + formatBytes() + +  : string +
              +
              Helper to convert bytes to human-readable unit.
              + +
              + getConfigurationFile() + +  : mixed +
              +
              {@inheritdoc}
              + +
              + getDeploymentEnvironment() + +  : string +
              +
              Returns the current environment based on env vars.
              + +
              + getPackageDetails() + +  : mixed +
              +
              Call release history of d.org to confirm security alert.
              + +
              + getPackagePropertyFromComposer() + +  : false|mixed +
              +
              Helper to return a property from a package in the composer.lock file.
              + +
              + getQaApiBasicAuth() + +  : string +
              +
              Return the QA API BASIC AUTH from token or from questions.
              + +
              + getQaEndpointContent() + +  : string +
              +
              Curl function to access endpoint with or without authentication.
              + +
              + getQaProjectInformation() + +  : false|array<string|int, mixed> +
              +
              Returns the Project information from the QA Website.
              + +
              + getQaSessionToken() + +  : string +
              +
              Helper to return the session token.
              + +
              + optsReview() + +  : mixed +
              +
              Check project's .opts.yml file for forbidden commands.
              + +
              + postQaContent() + +  : string +
              +
              Helper to send a payload to the QA Website.
              + +
              + setupBlackfireBehat() + +  : mixed +
              +
              Copy the needed resources to run Behat with Blackfire.
              + +
              + toolkitCodeReview() + +  : mixed +
              +
              This command will execute all the testing tools.
              + +
              + toolkitRequirements() + +  : mixed +
              +
              Check the Toolkit Requirements.
              + +
              + toolkitVendorList() + +  : mixed +
              +
              Check 'Vendor' packages being monitorised.
              + +
              + toolkitVersion() + +  : mixed +
              +
              Check the Toolkit version.
              + +
              + checkCommitMessage() + +  : mixed +
              +
              Check the commit message for SKIPPING tokens.
              + +
              + componentInsecure() + +  : mixed +
              +
              Helper function to check component's review information.
              + +
              + componentMandatory() + +  : mixed +
              +
              Helper function to check component's review information.
              + +
              + componentOutdated() + +  : mixed +
              +
              Helper function to check component's review information.
              + +
              + componentRecommended() + +  : mixed +
              +
              Helper function to check component's review information.
              + +
              + printComponentResults() + +  : mixed +
              +
              Helper function to validate the component.
              + +
              + validateComponent() + +  : mixed +
              +
              Helper function to validate the component.
              + +
              + + + + + + + +
              +

              + Methods + +

              +
              +

              + componentCheck() + +

              + + +

              Check composer.json for components that are not whitelisted/blacklisted.

              + + + public + componentCheck([array<string|int, mixed> $options = ['endpoint' => InputOption::VALUE_REQUIRED, 'blocker' => InputOption::VALUE_REQUIRED, 'test-command' => false] ]) : mixed + + +
              Parameters
              +
              +
              + $options + : array<string|int, mixed> + = ['endpoint' => InputOption::VALUE_REQUIRED, 'blocker' => InputOption::VALUE_REQUIRED, 'test-command' => false]
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + command +
              +
              + +

              toolkit:component-check

              +
              + +
              +
              + option +
              +
              + +

              endpoint Deprecated

              +
              + +
              +
              + option +
              +
              + +

              blocker Deprecated

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + composerLockCheck() + +

              + + +

              Check if 'composer.lock' exists on the project root folder.

              + + + public + composerLockCheck() : int + + + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:complock-check

              +
              + +
              +
              + +
              Return values
              + int + — + + +
              +
              +

              + d9Compatibility() + +

              + + +

              Check project compatibility for Drupal 9 upgrade.

              + + + public + d9Compatibility() : int + + + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +

              Note: The project configuration should be updated.

              +
              + +
              +
              + command +
              +
              + +

              toolkit:d9-compatibility

              +
              + +
              +
              + +
              Return values
              + int + — + + +
              +
              +

              + disableDrupalCache() + +

              + + +

              Disable aggregation and clear cache.

              + + + public + disableDrupalCache() : CollectionBuilder + + + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:disable-drupal-cache

              +
              + +
              +
              + +
              Return values
              + CollectionBuilder + — +

              Collection builder.

              +
              + + +
              +
              +

              + displayNotifications() + +

              + + +

              Display toolkit notifications.

              + + + public + displayNotifications([array<string|int, mixed> $options = ['endpoint' => InputOption::VALUE_OPTIONAL] ]) : mixed + + +
              Parameters
              +
              +
              + $options + : array<string|int, mixed> + = ['endpoint' => InputOption::VALUE_OPTIONAL]
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:notifications

              +
              + +
              +
              + option +
              +
              + +

              endpoint The endpoint for the notifications

              +
              + +
              +
              + deprecated +
              +
              + + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + fixPermissions() + +

              + + +

              Run script to fix permissions (experimental).

              + + + public + fixPermissions([array<string|int, mixed> $options = ['drupal_path' => InputOption::VALUE_OPTIONAL, 'drupal_user' => InputOption::VALUE_OPTIONAL, 'httpd_group' => InputOption::VALUE_OPTIONAL] ]) : mixed + + +
              Parameters
              +
              +
              + $options + : array<string|int, mixed> + = ['drupal_path' => InputOption::VALUE_OPTIONAL, 'drupal_user' => InputOption::VALUE_OPTIONAL, 'httpd_group' => InputOption::VALUE_OPTIONAL]
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:fix-permissions

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + formatBytes() + +

              + + +

              Helper to convert bytes to human-readable unit.

              + + + public + static formatBytes(int $bytes[, int $precision = 2 ]) : string + + +
              Parameters
              +
              +
              + $bytes + : int +
              +
              +

              The bytes to convert.

              +
              + +
              +
              + $precision + : int + = 2
              +
              +

              The precision for the conversion.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + +
              Return values
              + string + — +

              The converted value.

              +
              + + +
              +
              +

              + getConfigurationFile() + +

              + + +

              {@inheritdoc}

              + + + public + getConfigurationFile() : mixed + + + + +
              + Tags + +
              +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + getDeploymentEnvironment() + +

              + + +

              Returns the current environment based on env vars.

              + + + public + static getDeploymentEnvironment() : string + +

              This command is called during build-dist, the build-dist is called in +the create-distribution step during deployments. +If CI env var is defined and TAG is available then the environment is +'prod' otherwise is 'acc'. If no CI env var is defined assume 'dev' +environment.

              +
              + + + +
              + Tags + +
              +
              +
              + +
              Return values
              + string + — +

              The current environment, one of: 'dev', 'acc', 'prod'.

              +
              + + +
              +
              +

              + getPackageDetails() + +

              + + +

              Call release history of d.org to confirm security alert.

              + + + public + getPackageDetails(mixed $package, mixed $version, mixed $core) : mixed + + +
              Parameters
              +
              +
              + $package + : mixed +
              +
              +
              + +
              +
              + $version + : mixed +
              +
              +
              + +
              +
              + $core + : mixed +
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + getPackagePropertyFromComposer() + +

              + + +

              Helper to return a property from a package in the composer.lock file.

              + + + public + static getPackagePropertyFromComposer(string $package[, string $prop = 'version' ][, string|null $section = null ]) : false|mixed + + +
              Parameters
              +
              +
              + $package + : string +
              +
              +

              The package name to search.

              +
              + +
              +
              + $prop + : string + = 'version'
              +
              +

              The property to return, default to 'version'.

              +
              + +
              +
              + $section + : string|null + = null
              +
              +

              Set to 'packages' or 'packages-dev' to filter by section.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + +
              Return values
              + false|mixed + — +

              The property value, false if not found.

              +
              + + +
              +
              +

              + getQaApiBasicAuth() + +

              + + +

              Return the QA API BASIC AUTH from token or from questions.

              + + + public + getQaApiBasicAuth() : string + + + + +
              + Tags + +
              +
              +
              + +
              Return values
              + string + — +

              The Basic auth or empty string if fails.

              +
              + + +
              +
              +

              + getQaEndpointContent() + +

              + + +

              Curl function to access endpoint with or without authentication.

              + + + public + static getQaEndpointContent(string $url[, string $basicAuth = '' ]) : string + +

              This function is made publicly available as a static function for other +projects to call. Then we have to maintain less code.

              +
              + +
              Parameters
              +
              +
              + $url + : string +
              +
              +

              The QA endpoint url.

              +
              + +
              +
              + $basicAuth + : string + = ''
              +
              +

              The basic auth.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.MissingImport)

              +
              + +
              +
              + throws +
              +
              + Exception + + +
              +
              + +
              Return values
              + string + — +

              The endpoint content, or empty string if no session is generated.

              +
              + + +
              +
              +

              + getQaProjectInformation() + +

              + + +

              Returns the Project information from the QA Website.

              + + + public + getQaProjectInformation( $project_id) : false|array<string|int, mixed> + + +
              Parameters
              +
              +
              + $project_id + : +
              +
              +

              The project ID to use.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + throws +
              +
              + Exception + + +
              +
              + +
              Return values
              + false|array<string|int, mixed> + — +

              An array with the Project information, false if fails.

              +
              + + +
              +
              +

              + getQaSessionToken() + +

              + + +

              Helper to return the session token.

              + + + public + static getQaSessionToken() : string + + + + +
              + Tags + +
              +
              +
              + +
              Return values
              + string + — +

              The token or false if the request failed.

              +
              + + +
              +
              +

              + optsReview() + +

              + + +

              Check project's .opts.yml file for forbidden commands.

              + + + public + optsReview() : mixed + + + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + command +
              +
              + +

              toolkit:opts-review

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + postQaContent() + +

              + + +

              Helper to send a payload to the QA Website.

              + + + public + static postQaContent(array<string|int, mixed> $fields, string $auth) : string + + +
              Parameters
              +
              +
              + $fields + : array<string|int, mixed> +
              +
              +

              Data to send.

              +
              + +
              +
              + $auth + : string +
              +
              +

              The Basic auth.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + throws +
              +
              + Exception + + +
              +
              + +
              Return values
              + string + — +

              The endpoint response code, or empty string if no session is generated.

              +
              + + +
              +
              +

              + setupBlackfireBehat() + +

              + + +

              Copy the needed resources to run Behat with Blackfire.

              + + + public + setupBlackfireBehat() : mixed + + + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:setup-blackfire-behat

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + toolkitCodeReview() + +

              + + +

              This command will execute all the testing tools.

              + + + public + toolkitCodeReview([array<string|int, mixed> $options = ['phpcs' => InputOption::VALUE_NONE, 'opts-review' => InputOption::VALUE_NONE, 'lint-php' => InputOption::VALUE_NONE, 'lint-yaml' => InputOption::VALUE_NONE] ]) : mixed + + +
              Parameters
              +
              +
              + $options + : array<string|int, mixed> + = ['phpcs' => InputOption::VALUE_NONE, 'opts-review' => InputOption::VALUE_NONE, 'lint-php' => InputOption::VALUE_NONE, 'lint-yaml' => InputOption::VALUE_NONE]
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:code-review

              +
              + +
              +
              + option +
              +
              + +

              phpcs Execute the command toolkit:test-phpcs.

              +
              + +
              +
              + option +
              +
              + +

              opts-review Execute the command toolkit:opts-review.

              +
              + +
              +
              + option +
              +
              + +

              lint-php Execute the command toolkit:lint-php.

              +
              + +
              +
              + option +
              +
              + +

              lint-yaml Execute the command toolkit:lint-yaml.

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + toolkitRequirements() + +

              + + +

              Check the Toolkit Requirements.

              + + + public + toolkitRequirements([array<string|int, mixed> $options = ['endpoint' => InputOption::VALUE_OPTIONAL] ]) : mixed + + +
              Parameters
              +
              +
              + $options + : array<string|int, mixed> + = ['endpoint' => InputOption::VALUE_OPTIONAL]
              +
              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + command +
              +
              + +

              toolkit:requirements

              +
              + +
              +
              + option +
              +
              + +

              endpoint The endpoint to get the requirements.

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + toolkitVendorList() + +

              + + +

              Check 'Vendor' packages being monitorised.

              + + + public + toolkitVendorList() : mixed + + + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:vendor-list

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + toolkitVersion() + +

              + + +

              Check the Toolkit version.

              + + + public + toolkitVersion() : mixed + + + + +
              + Tags + +
              +
              +
              + command +
              +
              + +

              toolkit:check-version

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + checkCommitMessage() + +

              + + +

              Check the commit message for SKIPPING tokens.

              + + + protected + checkCommitMessage() : mixed + + + + +
              + Tags + +
              +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + componentInsecure() + +

              + + +

              Helper function to check component's review information.

              + + + protected + componentInsecure(array<string|int, mixed> $modules) : mixed + + +
              Parameters
              +
              +
              + $modules + : array<string|int, mixed> +
              +
              +

              The modules list.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + throws +
              +
              + TaskException + + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + componentMandatory() + +

              + + +

              Helper function to check component's review information.

              + + + protected + componentMandatory(array<string|int, mixed> $modules) : mixed + + +
              Parameters
              +
              +
              + $modules + : array<string|int, mixed> +
              +
              +

              The modules list.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + throws +
              +
              + TaskException + + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + componentOutdated() + +

              + + +

              Helper function to check component's review information.

              + + + protected + componentOutdated() : mixed + + + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + componentRecommended() + +

              + + +

              Helper function to check component's review information.

              + + + protected + componentRecommended(array<string|int, mixed> $modules, array<string|int, mixed> $packages) : mixed + + +
              Parameters
              +
              +
              + $modules + : array<string|int, mixed> +
              +
              +

              The modules list.

              +
              + +
              +
              + $packages + : array<string|int, mixed> +
              +
              +

              The packages to validate.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + printComponentResults() + +

              + + +

              Helper function to validate the component.

              + + + protected + printComponentResults() : mixed + + + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              +

              + validateComponent() + +

              + + +

              Helper function to validate the component.

              + + + protected + validateComponent(array<string|int, mixed> $package, array<string|int, mixed> $modules) : mixed + + +
              Parameters
              +
              +
              + $package + : array<string|int, mixed> +
              +
              +

              The package to validate.

              +
              + +
              +
              + $modules + : array<string|int, mixed> +
              +
              +

              The modules list.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.CyclomaticComplexity)

              +
              + +
              +
              + SuppressWarnings +
              +
              + +

              (PHPMD.NPathComplexity)

              +
              + +
              +
              + +
              Return values
              + mixed + — + + +
              +
              + +
              +
              +
              +
              +
              
              +        
              + +
              +
              + + + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-Tests-AbstractTest.html b/docs/classes/EcEuropa-Toolkit-Tests-AbstractTest.html new file mode 100644 index 000000000..aad8bdebc --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-Tests-AbstractTest.html @@ -0,0 +1,784 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                +

                Documentation

                + + + + + +
                + +
                +
                + + + + +
                + + +
                +

                + AbstractTest + + + extends TestCase + + +
                + in package + +
                + + +

                + + + +

                Abstract test class for Toolkit commands.

                + + + +
                + Tags + +
                +
                +
                + + + + + + +

                + Table of Contents + +

                + +
                +
                + assertContainsNotContains() + +  : mixed +
                +
                Helper function to assert contain / not contain expectations.
                + +
                + getClassLoader() + +  : ClassLoader +
                +
                Get class loader.
                + +
                + getFixtureContent() + +  : mixed +
                +
                Get fixture content.
                + +
                + getFixtureFilepath() + +  : string +
                +
                Get fixture filepath.
                + +
                + getFixtureRoot() + +  : mixed +
                +
                Get fixture root.
                + +
                + getSandboxFilepath() + +  : string +
                +
                Get sandbox filepath.
                + +
                + getSandboxRoot() + +  : string +
                +
                Get sandbox root path.
                + +
                + setUp() + +  : void +
                +
                {@inheritdoc}
                + +
                + trimEachLine() + +  : string +
                +
                Trim each line of a blob of text, used when asserting on multiline strings.
                + +
                + + + + + + + +
                +

                + Methods + +

                +
                +

                + assertContainsNotContains() + +

                + + +

                Helper function to assert contain / not contain expectations.

                + + + protected + assertContainsNotContains(string $content, array<string|int, mixed> $expected) : mixed + + +
                Parameters
                +
                +
                + $content + : string +
                +
                +

                Content to test.

                +
                + +
                +
                + $expected + : array<string|int, mixed> +
                +
                +

                Content expected.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + mixed + — + + +
                +
                +

                + getClassLoader() + +

                + + +

                Get class loader.

                + + + protected + getClassLoader() : ClassLoader + + + + +
                + Tags + +
                +
                +
                + +
                Return values
                + ClassLoader + — +

                Class loader of vendor.

                +
                + + +
                +
                +

                + getFixtureContent() + +

                + + +

                Get fixture content.

                + + + protected + getFixtureContent(string $filepath) : mixed + + +
                Parameters
                +
                +
                + $filepath + : string +
                +
                +

                File path.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + mixed + — +

                A set of test data.

                +
                + + +
                +
                +

                + getFixtureFilepath() + +

                + + +

                Get fixture filepath.

                + + + protected + getFixtureFilepath(string $name) : string + + +
                Parameters
                +
                +
                + $name + : string +
                +
                +

                A name of Sandbox.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + string + — +

                The filepath of the sandbox.

                +
                + + +
                +
                +

                + getFixtureRoot() + +

                + + +

                Get fixture root.

                + + + protected + getFixtureRoot() : mixed + + + + +
                + Tags + +
                +
                +
                + +
                Return values
                + mixed + — +

                A set of test data.

                +
                + + +
                +
                +

                + getSandboxFilepath() + +

                + + +

                Get sandbox filepath.

                + + + protected + getSandboxFilepath(string $name) : string + + +
                Parameters
                +
                +
                + $name + : string +
                +
                +

                A name of Sandbox.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + string + — +

                The filepath of the sandbox.

                +
                + + +
                +
                +

                + getSandboxRoot() + +

                + + +

                Get sandbox root path.

                + + + protected + getSandboxRoot() : string + + + + +
                + Tags + +
                +
                +
                + +
                Return values
                + string + — +

                The filepath of sandbox.

                +
                + + +
                +
                +

                + setUp() + +

                + + +

                {@inheritdoc}

                + + + protected + setUp() : void + + + + +
                + Tags + +
                +
                +
                + +
                Return values
                + void + — + + +
                +
                +

                + trimEachLine() + +

                + + +

                Trim each line of a blob of text, used when asserting on multiline strings.

                + + + protected + trimEachLine(string $text) : string + + +
                Parameters
                +
                +
                + $text + : string +
                +
                +

                Untrimmed text.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + +
                Return values
                + string + — +

                Trimmed text.

                +
                + + +
                +
                + +
                +
                +
                +
                +
                
                +        
                + +
                +
                + + + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html b/docs/classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html new file mode 100644 index 000000000..a6655ad52 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html @@ -0,0 +1,928 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + + + + +
                  + +
                  +
                  + + + + +
                  + + +
                  +

                  + BuildCommandsTest + + + extends AbstractTest + + +
                  + in package + +
                  + + +

                  + + + +

                  Abstract test class for Toolkit commands.

                  + + + +
                  + Tags + +
                  +
                  +
                  + group +
                  +
                  + +

                  build

                  +

                  Test Toolkit build commands.

                  +
                  + +
                  +
                  + + + + + + +

                  + Table of Contents + +

                  + +
                  +
                  + dataProvider() + +  : array<string|int, mixed> +
                  +
                  Data provider for testBuild.
                  + +
                  + testBuild() + +  : mixed +
                  +
                  Test "toolkit:build-*" commands.
                  + +
                  + assertContainsNotContains() + +  : mixed +
                  +
                  Helper function to assert contain / not contain expectations.
                  + +
                  + getClassLoader() + +  : ClassLoader +
                  +
                  Get class loader.
                  + +
                  + getFixtureContent() + +  : mixed +
                  +
                  Get fixture content.
                  + +
                  + getFixtureFilepath() + +  : string +
                  +
                  Get fixture filepath.
                  + +
                  + getFixtureRoot() + +  : mixed +
                  +
                  Get fixture root.
                  + +
                  + getSandboxFilepath() + +  : string +
                  +
                  Get sandbox filepath.
                  + +
                  + getSandboxRoot() + +  : string +
                  +
                  Get sandbox root path.
                  + +
                  + setUp() + +  : void +
                  +
                  {@inheritdoc}
                  + +
                  + trimEachLine() + +  : string +
                  +
                  Trim each line of a blob of text, used when asserting on multiline strings.
                  + +
                  + + + + + + + +
                  +

                  + Methods + +

                  +
                  +

                  + dataProvider() + +

                  + + +

                  Data provider for testBuild.

                  + + + public + dataProvider() : array<string|int, mixed> + + + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + array<string|int, mixed> + — +

                  An array of test data arrays with assertations.

                  +
                  + + +
                  +
                  +

                  + testBuild() + +

                  + + +

                  Test "toolkit:build-*" commands.

                  + + + public + testBuild(mixed $command, array<string|int, mixed> $config, array<string|int, mixed> $expected) : mixed + + +
                  Parameters
                  +
                  +
                  + $command + : mixed +
                  +
                  +

                  A command.

                  +
                  + +
                  +
                  + $config + : array<string|int, mixed> +
                  +
                  +

                  A configuration.

                  +
                  + +
                  +
                  + $expected + : array<string|int, mixed> +
                  +
                  +

                  Tests expected.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + dataProvider +
                  +
                  + +

                  dataProvider

                  +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — + + +
                  +
                  +

                  + assertContainsNotContains() + +

                  + + +

                  Helper function to assert contain / not contain expectations.

                  + + + protected + assertContainsNotContains(string $content, array<string|int, mixed> $expected) : mixed + + +
                  Parameters
                  +
                  +
                  + $content + : string +
                  +
                  +

                  Content to test.

                  +
                  + +
                  +
                  + $expected + : array<string|int, mixed> +
                  +
                  +

                  Content expected.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + mixed + — + + +
                  +
                  +

                  + getClassLoader() + +

                  + + +

                  Get class loader.

                  + + + protected + getClassLoader() : ClassLoader + + + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + ClassLoader + — +

                  Class loader of vendor.

                  +
                  + + +
                  +
                  +

                  + getFixtureContent() + +

                  + + +

                  Get fixture content.

                  + + + protected + getFixtureContent(string $filepath) : mixed + + +
                  Parameters
                  +
                  +
                  + $filepath + : string +
                  +
                  +

                  File path.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + mixed + — +

                  A set of test data.

                  +
                  + + +
                  +
                  +

                  + getFixtureFilepath() + +

                  + + +

                  Get fixture filepath.

                  + + + protected + getFixtureFilepath(string $name) : string + + +
                  Parameters
                  +
                  +
                  + $name + : string +
                  +
                  +

                  A name of Sandbox.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + string + — +

                  The filepath of the sandbox.

                  +
                  + + +
                  +
                  +

                  + getFixtureRoot() + +

                  + + +

                  Get fixture root.

                  + + + protected + getFixtureRoot() : mixed + + + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + mixed + — +

                  A set of test data.

                  +
                  + + +
                  +
                  +

                  + getSandboxFilepath() + +

                  + + +

                  Get sandbox filepath.

                  + + + protected + getSandboxFilepath(string $name) : string + + +
                  Parameters
                  +
                  +
                  + $name + : string +
                  +
                  +

                  A name of Sandbox.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + string + — +

                  The filepath of the sandbox.

                  +
                  + + +
                  +
                  +

                  + getSandboxRoot() + +

                  + + +

                  Get sandbox root path.

                  + + + protected + getSandboxRoot() : string + + + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + string + — +

                  The filepath of sandbox.

                  +
                  + + +
                  +
                  +

                  + setUp() + +

                  + + +

                  {@inheritdoc}

                  + + + protected + setUp() : void + + + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + void + — + + +
                  +
                  +

                  + trimEachLine() + +

                  + + +

                  Trim each line of a blob of text, used when asserting on multiline strings.

                  + + + protected + trimEachLine(string $text) : string + + +
                  Parameters
                  +
                  +
                  + $text + : string +
                  +
                  +

                  Untrimmed text.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + +
                  Return values
                  + string + — +

                  Trimmed text.

                  +
                  + + +
                  +
                  + +
                  +
                  +
                  +
                  +
                  
                  +        
                  + +
                  +
                  + + + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html b/docs/classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html new file mode 100644 index 000000000..4c30af741 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html @@ -0,0 +1,928 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                    +

                    Documentation

                    + + + + + +
                    + +
                    +
                    + + + + +
                    + + +
                    +

                    + CloneCommandsTest + + + extends AbstractTest + + +
                    + in package + +
                    + + +

                    + + + +

                    Abstract test class for Toolkit commands.

                    + + + +
                    + Tags + +
                    +
                    +
                    + group +
                    +
                    + +

                    clone

                    +

                    Test Toolkit build commands.

                    +
                    + +
                    +
                    + + + + + + +

                    + Table of Contents + +

                    + +
                    +
                    + dataProvider() + +  : array<string|int, mixed> +
                    +
                    Data provider for testClone.
                    + +
                    + testClone() + +  : mixed +
                    +
                    Test "toolkit:clone-*" commands.
                    + +
                    + assertContainsNotContains() + +  : mixed +
                    +
                    Helper function to assert contain / not contain expectations.
                    + +
                    + getClassLoader() + +  : ClassLoader +
                    +
                    Get class loader.
                    + +
                    + getFixtureContent() + +  : mixed +
                    +
                    Get fixture content.
                    + +
                    + getFixtureFilepath() + +  : string +
                    +
                    Get fixture filepath.
                    + +
                    + getFixtureRoot() + +  : mixed +
                    +
                    Get fixture root.
                    + +
                    + getSandboxFilepath() + +  : string +
                    +
                    Get sandbox filepath.
                    + +
                    + getSandboxRoot() + +  : string +
                    +
                    Get sandbox root path.
                    + +
                    + setUp() + +  : void +
                    +
                    {@inheritdoc}
                    + +
                    + trimEachLine() + +  : string +
                    +
                    Trim each line of a blob of text, used when asserting on multiline strings.
                    + +
                    + + + + + + + +
                    +

                    + Methods + +

                    +
                    +

                    + dataProvider() + +

                    + + +

                    Data provider for testClone.

                    + + + public + dataProvider() : array<string|int, mixed> + + + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + array<string|int, mixed> + — +

                    An array of test data arrays with assertations.

                    +
                    + + +
                    +
                    +

                    + testClone() + +

                    + + +

                    Test "toolkit:clone-*" commands.

                    + + + public + testClone(mixed $command, array<string|int, mixed> $config, array<string|int, mixed> $expected) : mixed + + +
                    Parameters
                    +
                    +
                    + $command + : mixed +
                    +
                    +

                    A command.

                    +
                    + +
                    +
                    + $config + : array<string|int, mixed> +
                    +
                    +

                    A configuration.

                    +
                    + +
                    +
                    + $expected + : array<string|int, mixed> +
                    +
                    +

                    Tests expected.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + dataProvider +
                    +
                    + +

                    dataProvider

                    +
                    + +
                    +
                    + +
                    Return values
                    + mixed + — + + +
                    +
                    +

                    + assertContainsNotContains() + +

                    + + +

                    Helper function to assert contain / not contain expectations.

                    + + + protected + assertContainsNotContains(string $content, array<string|int, mixed> $expected) : mixed + + +
                    Parameters
                    +
                    +
                    + $content + : string +
                    +
                    +

                    Content to test.

                    +
                    + +
                    +
                    + $expected + : array<string|int, mixed> +
                    +
                    +

                    Content expected.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + mixed + — + + +
                    +
                    +

                    + getClassLoader() + +

                    + + +

                    Get class loader.

                    + + + protected + getClassLoader() : ClassLoader + + + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + ClassLoader + — +

                    Class loader of vendor.

                    +
                    + + +
                    +
                    +

                    + getFixtureContent() + +

                    + + +

                    Get fixture content.

                    + + + protected + getFixtureContent(string $filepath) : mixed + + +
                    Parameters
                    +
                    +
                    + $filepath + : string +
                    +
                    +

                    File path.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + mixed + — +

                    A set of test data.

                    +
                    + + +
                    +
                    +

                    + getFixtureFilepath() + +

                    + + +

                    Get fixture filepath.

                    + + + protected + getFixtureFilepath(string $name) : string + + +
                    Parameters
                    +
                    +
                    + $name + : string +
                    +
                    +

                    A name of Sandbox.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + string + — +

                    The filepath of the sandbox.

                    +
                    + + +
                    +
                    +

                    + getFixtureRoot() + +

                    + + +

                    Get fixture root.

                    + + + protected + getFixtureRoot() : mixed + + + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + mixed + — +

                    A set of test data.

                    +
                    + + +
                    +
                    +

                    + getSandboxFilepath() + +

                    + + +

                    Get sandbox filepath.

                    + + + protected + getSandboxFilepath(string $name) : string + + +
                    Parameters
                    +
                    +
                    + $name + : string +
                    +
                    +

                    A name of Sandbox.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + string + — +

                    The filepath of the sandbox.

                    +
                    + + +
                    +
                    +

                    + getSandboxRoot() + +

                    + + +

                    Get sandbox root path.

                    + + + protected + getSandboxRoot() : string + + + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + string + — +

                    The filepath of sandbox.

                    +
                    + + +
                    +
                    +

                    + setUp() + +

                    + + +

                    {@inheritdoc}

                    + + + protected + setUp() : void + + + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + void + — + + +
                    +
                    +

                    + trimEachLine() + +

                    + + +

                    Trim each line of a blob of text, used when asserting on multiline strings.

                    + + + protected + trimEachLine(string $text) : string + + +
                    Parameters
                    +
                    +
                    + $text + : string +
                    +
                    +

                    Untrimmed text.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + +
                    Return values
                    + string + — +

                    Trimmed text.

                    +
                    + + +
                    +
                    + +
                    +
                    +
                    +
                    +
                    
                    +        
                    + +
                    +
                    + + + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html b/docs/classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html new file mode 100644 index 000000000..dbc785275 --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html @@ -0,0 +1,937 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                      +

                      Documentation

                      + + + + + +
                      + +
                      +
                      + + + + +
                      + + +
                      +

                      + DrupalCommandsTest + + + extends AbstractTest + + +
                      + in package + +
                      + + +

                      + + + +

                      Abstract test class for Toolkit commands.

                      + + + +
                      + Tags + +
                      +
                      +
                      + group +
                      +
                      + +

                      drupal

                      +

                      Test Toolkit Drupal commands.

                      +
                      + +
                      +
                      + + + + + + +

                      + Table of Contents + +

                      + +
                      +
                      + dataProvider() + +  : array<string|int, mixed> +
                      +
                      Data provider for testDrupalSettingsSetup.
                      + +
                      + testDrupalSettingsSetup() + +  : mixed +
                      +
                      Test Toolkit very own "drupal:settings-setup" command.
                      + +
                      + assertContainsNotContains() + +  : mixed +
                      +
                      Helper function to assert contain / not contain expectations.
                      + +
                      + getClassLoader() + +  : ClassLoader +
                      +
                      Get class loader.
                      + +
                      + getFixtureContent() + +  : mixed +
                      +
                      Get fixture content.
                      + +
                      + getFixtureFilepath() + +  : string +
                      +
                      Get fixture filepath.
                      + +
                      + getFixtureRoot() + +  : mixed +
                      +
                      Get fixture root.
                      + +
                      + getSandboxFilepath() + +  : string +
                      +
                      Get sandbox filepath.
                      + +
                      + getSandboxRoot() + +  : string +
                      +
                      Get sandbox root path.
                      + +
                      + setUp() + +  : void +
                      +
                      {@inheritdoc}
                      + +
                      + trimEachLine() + +  : string +
                      +
                      Trim each line of a blob of text, used when asserting on multiline strings.
                      + +
                      + + + + + + + +
                      +

                      + Methods + +

                      +
                      +

                      + dataProvider() + +

                      + + +

                      Data provider for testDrupalSettingsSetup.

                      + + + public + dataProvider() : array<string|int, mixed> + + + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + array<string|int, mixed> + — +

                      An array of test data arrays with assertations.

                      +
                      + + +
                      +
                      +

                      + testDrupalSettingsSetup() + +

                      + + +

                      Test Toolkit very own "drupal:settings-setup" command.

                      + + + public + testDrupalSettingsSetup(array<string|int, mixed> $config, mixed $initial_default_settings, mixed $initial_settings, array<string|int, mixed> $expected) : mixed + + +
                      Parameters
                      +
                      +
                      + $config + : array<string|int, mixed> +
                      +
                      +

                      A configuration array.

                      +
                      + +
                      +
                      + $initial_default_settings + : mixed +
                      +
                      +

                      A initial default settings.

                      +
                      + +
                      +
                      + $initial_settings + : mixed +
                      +
                      +

                      A initial settings.

                      +
                      + +
                      +
                      + $expected + : array<string|int, mixed> +
                      +
                      +

                      Test assertions.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + dataProvider +
                      +
                      + +

                      dataProvider

                      +
                      + +
                      +
                      + +
                      Return values
                      + mixed + — + + +
                      +
                      +

                      + assertContainsNotContains() + +

                      + + +

                      Helper function to assert contain / not contain expectations.

                      + + + protected + assertContainsNotContains(string $content, array<string|int, mixed> $expected) : mixed + + +
                      Parameters
                      +
                      +
                      + $content + : string +
                      +
                      +

                      Content to test.

                      +
                      + +
                      +
                      + $expected + : array<string|int, mixed> +
                      +
                      +

                      Content expected.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + mixed + — + + +
                      +
                      +

                      + getClassLoader() + +

                      + + +

                      Get class loader.

                      + + + protected + getClassLoader() : ClassLoader + + + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + ClassLoader + — +

                      Class loader of vendor.

                      +
                      + + +
                      +
                      +

                      + getFixtureContent() + +

                      + + +

                      Get fixture content.

                      + + + protected + getFixtureContent(string $filepath) : mixed + + +
                      Parameters
                      +
                      +
                      + $filepath + : string +
                      +
                      +

                      File path.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + mixed + — +

                      A set of test data.

                      +
                      + + +
                      +
                      +

                      + getFixtureFilepath() + +

                      + + +

                      Get fixture filepath.

                      + + + protected + getFixtureFilepath(string $name) : string + + +
                      Parameters
                      +
                      +
                      + $name + : string +
                      +
                      +

                      A name of Sandbox.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + string + — +

                      The filepath of the sandbox.

                      +
                      + + +
                      +
                      +

                      + getFixtureRoot() + +

                      + + +

                      Get fixture root.

                      + + + protected + getFixtureRoot() : mixed + + + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + mixed + — +

                      A set of test data.

                      +
                      + + +
                      +
                      +

                      + getSandboxFilepath() + +

                      + + +

                      Get sandbox filepath.

                      + + + protected + getSandboxFilepath(string $name) : string + + +
                      Parameters
                      +
                      +
                      + $name + : string +
                      +
                      +

                      A name of Sandbox.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + string + — +

                      The filepath of the sandbox.

                      +
                      + + +
                      +
                      +

                      + getSandboxRoot() + +

                      + + +

                      Get sandbox root path.

                      + + + protected + getSandboxRoot() : string + + + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + string + — +

                      The filepath of sandbox.

                      +
                      + + +
                      +
                      +

                      + setUp() + +

                      + + +

                      {@inheritdoc}

                      + + + protected + setUp() : void + + + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + void + — + + +
                      +
                      +

                      + trimEachLine() + +

                      + + +

                      Trim each line of a blob of text, used when asserting on multiline strings.

                      + + + protected + trimEachLine(string $text) : string + + +
                      Parameters
                      +
                      +
                      + $text + : string +
                      +
                      +

                      Untrimmed text.

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + +
                      Return values
                      + string + — +

                      Trimmed text.

                      +
                      + + +
                      +
                      + +
                      +
                      +
                      +
                      +
                      
                      +        
                      + +
                      +
                      + + + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html b/docs/classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html new file mode 100644 index 000000000..7ebece5fe --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html @@ -0,0 +1,928 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                        +

                        Documentation

                        + + + + + +
                        + +
                        +
                        + + + + +
                        + + +
                        +

                        + InstallCommandsTest + + + extends AbstractTest + + +
                        + in package + +
                        + + +

                        + + + +

                        Abstract test class for Toolkit commands.

                        + + + +
                        + Tags + +
                        +
                        +
                        + group +
                        +
                        + +

                        install

                        +

                        Test Toolkit install commands.

                        +
                        + +
                        +
                        + + + + + + +

                        + Table of Contents + +

                        + +
                        +
                        + dataProvider() + +  : array<string|int, mixed> +
                        +
                        Data provider for testInstall.
                        + +
                        + testInstall() + +  : mixed +
                        +
                        Test "toolkit:install-*" commands.
                        + +
                        + assertContainsNotContains() + +  : mixed +
                        +
                        Helper function to assert contain / not contain expectations.
                        + +
                        + getClassLoader() + +  : ClassLoader +
                        +
                        Get class loader.
                        + +
                        + getFixtureContent() + +  : mixed +
                        +
                        Get fixture content.
                        + +
                        + getFixtureFilepath() + +  : string +
                        +
                        Get fixture filepath.
                        + +
                        + getFixtureRoot() + +  : mixed +
                        +
                        Get fixture root.
                        + +
                        + getSandboxFilepath() + +  : string +
                        +
                        Get sandbox filepath.
                        + +
                        + getSandboxRoot() + +  : string +
                        +
                        Get sandbox root path.
                        + +
                        + setUp() + +  : void +
                        +
                        {@inheritdoc}
                        + +
                        + trimEachLine() + +  : string +
                        +
                        Trim each line of a blob of text, used when asserting on multiline strings.
                        + +
                        + + + + + + + +
                        +

                        + Methods + +

                        +
                        +

                        + dataProvider() + +

                        + + +

                        Data provider for testInstall.

                        + + + public + dataProvider() : array<string|int, mixed> + + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + array<string|int, mixed> + — +

                        An array of test data arrays with assertations.

                        +
                        + + +
                        +
                        +

                        + testInstall() + +

                        + + +

                        Test "toolkit:install-*" commands.

                        + + + public + testInstall(mixed $command, array<string|int, mixed> $config, array<string|int, mixed> $expected) : mixed + + +
                        Parameters
                        +
                        +
                        + $command + : mixed +
                        +
                        +

                        A command.

                        +
                        + +
                        +
                        + $config + : array<string|int, mixed> +
                        +
                        +

                        A configuration.

                        +
                        + +
                        +
                        + $expected + : array<string|int, mixed> +
                        +
                        +

                        Tests expected.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + dataProvider +
                        +
                        + +

                        dataProvider

                        +
                        + +
                        +
                        + +
                        Return values
                        + mixed + — + + +
                        +
                        +

                        + assertContainsNotContains() + +

                        + + +

                        Helper function to assert contain / not contain expectations.

                        + + + protected + assertContainsNotContains(string $content, array<string|int, mixed> $expected) : mixed + + +
                        Parameters
                        +
                        +
                        + $content + : string +
                        +
                        +

                        Content to test.

                        +
                        + +
                        +
                        + $expected + : array<string|int, mixed> +
                        +
                        +

                        Content expected.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + mixed + — + + +
                        +
                        +

                        + getClassLoader() + +

                        + + +

                        Get class loader.

                        + + + protected + getClassLoader() : ClassLoader + + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + ClassLoader + — +

                        Class loader of vendor.

                        +
                        + + +
                        +
                        +

                        + getFixtureContent() + +

                        + + +

                        Get fixture content.

                        + + + protected + getFixtureContent(string $filepath) : mixed + + +
                        Parameters
                        +
                        +
                        + $filepath + : string +
                        +
                        +

                        File path.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + mixed + — +

                        A set of test data.

                        +
                        + + +
                        +
                        +

                        + getFixtureFilepath() + +

                        + + +

                        Get fixture filepath.

                        + + + protected + getFixtureFilepath(string $name) : string + + +
                        Parameters
                        +
                        +
                        + $name + : string +
                        +
                        +

                        A name of Sandbox.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + string + — +

                        The filepath of the sandbox.

                        +
                        + + +
                        +
                        +

                        + getFixtureRoot() + +

                        + + +

                        Get fixture root.

                        + + + protected + getFixtureRoot() : mixed + + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + mixed + — +

                        A set of test data.

                        +
                        + + +
                        +
                        +

                        + getSandboxFilepath() + +

                        + + +

                        Get sandbox filepath.

                        + + + protected + getSandboxFilepath(string $name) : string + + +
                        Parameters
                        +
                        +
                        + $name + : string +
                        +
                        +

                        A name of Sandbox.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + string + — +

                        The filepath of the sandbox.

                        +
                        + + +
                        +
                        +

                        + getSandboxRoot() + +

                        + + +

                        Get sandbox root path.

                        + + + protected + getSandboxRoot() : string + + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + string + — +

                        The filepath of sandbox.

                        +
                        + + +
                        +
                        +

                        + setUp() + +

                        + + +

                        {@inheritdoc}

                        + + + protected + setUp() : void + + + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + void + — + + +
                        +
                        +

                        + trimEachLine() + +

                        + + +

                        Trim each line of a blob of text, used when asserting on multiline strings.

                        + + + protected + trimEachLine(string $text) : string + + +
                        Parameters
                        +
                        +
                        + $text + : string +
                        +
                        +

                        Untrimmed text.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + +
                        Return values
                        + string + — +

                        Trimmed text.

                        +
                        + + +
                        +
                        + +
                        +
                        +
                        +
                        +
                        
                        +        
                        + +
                        +
                        + + + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + + + + + diff --git a/docs/classes/EcEuropa-Toolkit-Toolkit.html b/docs/classes/EcEuropa-Toolkit-Toolkit.html new file mode 100644 index 000000000..2e64e43bf --- /dev/null +++ b/docs/classes/EcEuropa-Toolkit-Toolkit.html @@ -0,0 +1,619 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                          +

                          Documentation

                          + + + + + +
                          + +
                          +
                          + + + + +
                          + + +
                          +

                          + Toolkit + + +
                          + in package + +
                          + + +

                          + + + +

                          Provides default Toolkit class.

                          + + + +
                          + Tags + +
                          +
                          +
                          + + + + + + +

                          + Table of Contents + +

                          + +
                          +
                          + VERSION + +  = '8.6.15' +
                          +
                          Constant holding the current version.
                          + +
                          + getAsdaPass() + +  : string +
                          +
                          Returns the ASDA password.
                          + +
                          + getAsdaUser() + +  : string +
                          +
                          Returns the ASDA user.
                          + +
                          + getNextcloudPass() + +  : string +
                          +
                          Returns the NEXTCLOUD password.
                          + +
                          + getNextcloudUser() + +  : string +
                          +
                          Returns the NEXTCLOUD user.
                          + +
                          + getQaWebsiteUrl() + +  : string +
                          +
                          Returns the QA base url.
                          + +
                          + isCiCd() + +  : bool +
                          +
                          Returns whether is running in CI/CD environment.
                          + +
                          + + + + +
                          +

                          + Constants + +

                          +
                          +

                          + VERSION + +

                          + + + +

                          Constant holding the current version.

                          + + + public + mixed + VERSION + = '8.6.15' + + + + +
                          + + +
                          + Tags + +
                          +
                          +
                          + +
                          +
                          + + + +
                          +

                          + Methods + +

                          +
                          +

                          + getAsdaPass() + +

                          + + +

                          Returns the ASDA password.

                          + + + public + static getAsdaPass() : string + + + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + string + — +

                          The ASDA password.

                          +
                          + + +
                          +
                          +

                          + getAsdaUser() + +

                          + + +

                          Returns the ASDA user.

                          + + + public + static getAsdaUser() : string + + + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + string + — +

                          The ASDA user.

                          +
                          + + +
                          +
                          +

                          + getNextcloudPass() + +

                          + + +

                          Returns the NEXTCLOUD password.

                          + + + public + static getNextcloudPass() : string + + + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + string + — +

                          The NEXTCLOUD password.

                          +
                          + + +
                          +
                          +

                          + getNextcloudUser() + +

                          + + +

                          Returns the NEXTCLOUD user.

                          + + + public + static getNextcloudUser() : string + + + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + string + — +

                          The NEXTCLOUD user.

                          +
                          + + +
                          +
                          +

                          + getQaWebsiteUrl() + +

                          + + +

                          Returns the QA base url.

                          + + + public + static getQaWebsiteUrl() : string + + + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + string + — +

                          The base url.

                          +
                          + + +
                          +
                          +

                          + isCiCd() + +

                          + + +

                          Returns whether is running in CI/CD environment.

                          + + + public + static isCiCd() : bool + + + + +
                          + Tags + +
                          +
                          +
                          + +
                          Return values
                          + bool + — +

                          True if running in CI/CD, false otherwise.

                          +
                          + + +
                          +
                          + +
                          +
                          +
                          +
                          +
                          
                          +        
                          + +
                          +
                          + + + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + + + + + diff --git a/docs/classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html b/docs/classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html new file mode 100644 index 000000000..73e960d1e --- /dev/null +++ b/docs/classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html @@ -0,0 +1,931 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                            +

                            Documentation

                            + + + + + +
                            + +
                            +
                            + + + + +
                            + + +
                            +

                            + BlackfireMinkContext + + + extends MinkContext + + +
                            + in package + +
                            + + + + Uses + BlackfireContextTrait +

                            + + + +

                            Extends Behat MinkContext and add steps from Drupal MinkContext.

                            + + + +
                            + Tags + +
                            +
                            +
                            + see +
                            +
                            + MinkContext + + +
                            +
                            + + + + + + +

                            + Table of Contents + +

                            + +
                            +
                            + assertAtPath() + +  : mixed +
                            +
                            Visit a given path, and additionally check for HTTP response code 200.
                            + +
                            + assertHeading() + +  : mixed +
                            +
                            + +
                            + assertHttpResponse() + +  : mixed +
                            +
                            + +
                            + assertNotHttpResponse() + +  : mixed +
                            +
                            + +
                            + assertNotTextVisible() + +  : mixed +
                            +
                            + +
                            + assertRegionLinkFollow() + +  : mixed +
                            +
                            + +
                            + assertTextVisible() + +  : mixed +
                            +
                            + +
                            + iAmOnLandingPage() + +  : mixed +
                            +
                            This is the example provided by Blackfire docs.
                            + +
                            + pressButton() + +  : mixed +
                            +
                            Presses button with specified id|name|title|alt|value.
                            + +
                            + + + + + + + +
                            +

                            + Methods + +

                            +
                            +

                            + assertAtPath() + +

                            + + +

                            Visit a given path, and additionally check for HTTP response code 200.

                            + + + public + assertAtPath(mixed $path) : mixed + + +
                            Parameters
                            +
                            +
                            + $path + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Given +
                            +
                            + +

                            I am at :path

                            +
                            + +
                            +
                            + When +
                            +
                            + +

                            I visit :path

                            +
                            + +
                            +
                            + throws +
                            +
                            + UnsupportedDriverActionException + + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + assertHeading() + +

                            + + + + + public + assertHeading(mixed $heading) : mixed + + +
                            Parameters
                            +
                            +
                            + $heading + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Then +
                            +
                            + +

                            I (should )see the heading :heading

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + assertHttpResponse() + +

                            + + + + + public + assertHttpResponse(mixed $code) : mixed + + +
                            Parameters
                            +
                            +
                            + $code + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Then +
                            +
                            + +

                            I should get a :code HTTP response

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + assertNotHttpResponse() + +

                            + + + + + public + assertNotHttpResponse(mixed $code) : mixed + + +
                            Parameters
                            +
                            +
                            + $code + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Then +
                            +
                            + +

                            I should not get a :code HTTP response

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + assertNotTextVisible() + +

                            + + + + + public + assertNotTextVisible(mixed $text) : mixed + + +
                            Parameters
                            +
                            +
                            + $text + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Then +
                            +
                            + +

                            I should not see the text :text

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + assertRegionLinkFollow() + +

                            + + + + + public + assertRegionLinkFollow(mixed $link, mixed $region) : mixed + + +
                            Parameters
                            +
                            +
                            + $link + : mixed +
                            +
                            +
                            + +
                            +
                            + $region + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + When +
                            +
                            + +

                            I follow/click :link in the :region( region)

                            +
                            + +
                            +
                            + throws +
                            +
                            + Exception + +

                            If region or link within it cannot be found.

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + assertTextVisible() + +

                            + + + + + public + assertTextVisible(mixed $text) : mixed + + +
                            Parameters
                            +
                            +
                            + $text + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Then +
                            +
                            + +

                            I (should )see the text :text

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + iAmOnLandingPage() + +

                            + + +

                            This is the example provided by Blackfire docs.

                            + + + public + iAmOnLandingPage(mixed $landingPage) : mixed + + +
                            Parameters
                            +
                            +
                            + $landingPage + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + Given +
                            +
                            + +

                            I am on ":landingPage" landing page

                            +
                            + +
                            +
                            + When +
                            +
                            + +

                            I go to ":landingPage" landing page

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            +

                            + pressButton() + +

                            + + +

                            Presses button with specified id|name|title|alt|value.

                            + + + public + pressButton(mixed $button) : mixed + + +
                            Parameters
                            +
                            +
                            + $button + : mixed +
                            +
                            +
                            + +
                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + When +
                            +
                            + +

                            I press the :button button

                            +
                            + +
                            +
                            + +
                            Return values
                            + mixed + — + + +
                            +
                            + +
                            +
                            +
                            +
                            +
                            
                            +        
                            + +
                            +
                            + + + +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + + + + + diff --git a/docs/css/base.css b/docs/css/base.css new file mode 100644 index 000000000..631cde96f --- /dev/null +++ b/docs/css/base.css @@ -0,0 +1,1106 @@ + +:root { + /* Typography */ + --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-monospace: 'Source Code Pro', monospace; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + /* Colors */ + --primary-color-hue: 96; + --primary-color-saturation: 57%; + --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%); + --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%); + --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 20%); + --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%); + --primary-color-lighten: hsl(var(--primary-color-hue), var(--primary-color-saturation), 80%); + --primary-color-lighter: hsl(var(--primary-color-hue), var(--primary-color-saturation), 99%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: var(--primary-color-darkest); + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: var(--primary-color-lighter); + --code-border-color: --primary-color-lighten; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darken); + --link-hover-color-primary: var(--primary-color-darker); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); + width: 100%; +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; +} + +.phpdocumentor h1:hover .headerlink, +.phpdocumentor h2:hover .headerlink, +.phpdocumentor h3:hover .headerlink, +.phpdocumentor h4:hover .headerlink, +.phpdocumentor h5:hover .headerlink, +.phpdocumentor h6:hover .headerlink +{ + opacity: 1; +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor figcaption { + text-align: center; + font-style: italic; + font-size: 80%; +} + +.phpdocumentor-uml-diagram svg { + max-width: 100%; + height: auto !important; +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-lg); + position: relative; + width: 100%; +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle; +} + +.phpdocumentor-column ol, +div.phpdocumentor-list > ol, +ol.phpdocumentor-list { + list-style: decimal; +} + + +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: 1rem; + margin-bottom: var(--spacing-md); +} + +dl { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-column ul ul, +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); +} + +.phpdocumentor-column ul li, +.phpdocumentor-list li { + padding-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dt { + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dd { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + font-family: var(--font-monospace); + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +.phpdocumentor-code.-dark { + background: var(--primary-color-darkest); + color: var(--light-gray); + box-shadow: 0 2px 3px var(--dark-gray); +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color-darken); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; +} + +.phpdocumentor blockquote p:last-of-type { + margin-bottom: 0; +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 30.6666666667%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding: var(--spacing-xs) var(--spacing-md); + list-style: none; + margin: 0; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover, +.phpdocumentor .phpdocumentor-sidebar a.-active { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + padding: var(--spacing-lg); + margin: var(--spacing-lg) 0; + display: flex; + flex-direction: row; + align-items: flex-start; +} + +.phpdocumentor-admonition p:last-of-type { + margin-bottom: 0; +} + +.phpdocumentor-admonition--success, +.phpdocumentor-admonition.-success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + margin-right: var(--spacing-md); + color: var(--primary-color); + max-width: 3rem; +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-content { + position: relative; +} + +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} +.phpdocumentor-modal { + position: fixed; + width: 100vw; + height: 100vh; + opacity: 0; + visibility: hidden; + transition: all 0.3s ease; + top: 0; + left: 0; + display: flex; + align-items: center; + justify-content: center; + z-index: 1; +} + +.phpdocumentor-modal__open { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} + +.phpdocumentor-modal-bg { + position: absolute; + background: gray; + opacity: 50%; + width: 100%; + height: 100%; +} + +.phpdocumentor-modal-container { + border-radius: 1em; + background: #fff; + position: relative; + padding: 2em; + box-sizing: border-box; + max-width:100vw; +} + +.phpdocumentor-modal__close { + position: absolute; + right: 0.75em; + top: 0.75em; + outline: none; + appearance: none; + color: var(--primary-color); + background: none; + border: 0px; + font-weight: bold; + cursor: pointer; +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} + +.float-right { + float: right; +} + +.float-left { + float: left; +} diff --git a/docs/css/normalize.css b/docs/css/normalize.css new file mode 100644 index 000000000..653dc00aa --- /dev/null +++ b/docs/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none !important; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: var(--font-monospace); + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/docs/css/template.css b/docs/css/template.css new file mode 100644 index 000000000..f7178281e --- /dev/null +++ b/docs/css/template.css @@ -0,0 +1,192 @@ +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} + +.phpdocumentor-element:not(:last-child) { + border-bottom: 1px solid var(--primary-color-lighten); + padding-bottom: var(--spacing-lg); +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} +.phpdocumentor-signature { + display: inline-block; + font-size: var(--text-sm); + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + padding-top: var(--spacing-xs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-enum:before { + content: 'E' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + position: absolute; + top: 0; + right: 0; + font-size: var(--text-sm); + color: gray; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { + flex: 0 1 auto; + display: inline-flex; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + left: 0; + border-radius: 50%; + font-weight: 600; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/docs/files/resources-blackfire-blackfireminkcontext.html b/docs/files/resources-blackfire-blackfireminkcontext.html new file mode 100644 index 000000000..1802a2956 --- /dev/null +++ b/docs/files/resources-blackfire-blackfireminkcontext.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                              +

                              Documentation

                              + + + + + +
                              + +
                              +
                              + + + + +
                              +
                                +
                              + +
                              +

                              BlackfireMinkContext.php

                              + + +
                              + + + + + + +

                              + Interfaces, Classes, Traits and Enums + +

                              + +
                              + +
                              BlackfireMinkContext
                              +
                              Extends Behat MinkContext and add steps from Drupal MinkContext.
                              + + +
                              + + + + + + + + +
                              +
                              +
                              +
                              +
                              
                              +        
                              + +
                              +
                              + + + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-buildcommands.html b/docs/files/src-taskrunner-commands-buildcommands.html new file mode 100644 index 000000000..cdcc2a440 --- /dev/null +++ b/docs/files/src-taskrunner-commands-buildcommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + + + + +
                                + +
                                +
                                + + + + +
                                +
                                  +
                                + +
                                +

                                BuildCommands.php

                                + + +
                                + + + + + + +

                                + Interfaces, Classes, Traits and Enums + +

                                + +
                                + +
                                BuildCommands
                                +
                                Provides commands to build a site for development and a production artifact.
                                + + +
                                + + + + + + + + +
                                +
                                +
                                +
                                +
                                
                                +        
                                + +
                                +
                                + + + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-clonecommands.html b/docs/files/src-taskrunner-commands-clonecommands.html new file mode 100644 index 000000000..b7b73295e --- /dev/null +++ b/docs/files/src-taskrunner-commands-clonecommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + + + + +
                                  + +
                                  +
                                  + + + + +
                                  +
                                    +
                                  + +
                                  +

                                  CloneCommands.php

                                  + + +
                                  + + + + + + +

                                  + Interfaces, Classes, Traits and Enums + +

                                  + +
                                  + +
                                  CloneCommands
                                  +
                                  Provides commands to clone a site for development and a production artifact.
                                  + + +
                                  + + + + + + + + +
                                  +
                                  +
                                  +
                                  +
                                  
                                  +        
                                  + +
                                  +
                                  + + + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-drupalcommands.html b/docs/files/src-taskrunner-commands-drupalcommands.html new file mode 100644 index 000000000..d37c06b95 --- /dev/null +++ b/docs/files/src-taskrunner-commands-drupalcommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + + + + +
                                    + +
                                    +
                                    + + + + +
                                    +
                                      +
                                    + +
                                    +

                                    DrupalCommands.php

                                    + + +
                                    + + + + + + +

                                    + Interfaces, Classes, Traits and Enums + +

                                    + +
                                    + +
                                    DrupalCommands
                                    +
                                    Drupal commands to setup and install a Drupal 8 site.
                                    + + +
                                    + + + + + + + + +
                                    +
                                    +
                                    +
                                    +
                                    
                                    +        
                                    + +
                                    +
                                    + + + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-installcommands.html b/docs/files/src-taskrunner-commands-installcommands.html new file mode 100644 index 000000000..bbd4a4f44 --- /dev/null +++ b/docs/files/src-taskrunner-commands-installcommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + + + + +
                                      + +
                                      +
                                      + + + + +
                                      +
                                        +
                                      + +
                                      +

                                      InstallCommands.php

                                      + + +
                                      + + + + + + +

                                      + Interfaces, Classes, Traits and Enums + +

                                      + +
                                      + +
                                      InstallCommands
                                      +
                                      Class ToolkitCommands.
                                      + + +
                                      + + + + + + + + +
                                      +
                                      +
                                      +
                                      +
                                      
                                      +        
                                      + +
                                      +
                                      + + + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-loaddefaultconfigcommands.html b/docs/files/src-taskrunner-commands-loaddefaultconfigcommands.html new file mode 100644 index 000000000..8da2aba59 --- /dev/null +++ b/docs/files/src-taskrunner-commands-loaddefaultconfigcommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + + + + +
                                        + +
                                        +
                                        + + + + +
                                        +
                                          +
                                        + +
                                        +

                                        LoadDefaultConfigCommands.php

                                        + + +
                                        + + + + + + +

                                        + Interfaces, Classes, Traits and Enums + +

                                        + +
                                        + +
                                        LoadDefaultConfigCommands
                                        +
                                        Default configuration loader.
                                        + + +
                                        + + + + + + + + +
                                        +
                                        +
                                        +
                                        +
                                        
                                        +        
                                        + +
                                        +
                                        + + + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-testscommands.html b/docs/files/src-taskrunner-commands-testscommands.html new file mode 100644 index 000000000..297b0d784 --- /dev/null +++ b/docs/files/src-taskrunner-commands-testscommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + + + + +
                                          + +
                                          +
                                          + + + + +
                                          +
                                            +
                                          + +
                                          +

                                          TestsCommands.php

                                          + + +
                                          + + + + + + +

                                          + Interfaces, Classes, Traits and Enums + +

                                          + +
                                          + +
                                          TestsCommands
                                          +
                                          Class TestsCommands.
                                          + + +
                                          + + + + + + + + +
                                          +
                                          +
                                          +
                                          +
                                          
                                          +        
                                          + +
                                          +
                                          + + + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + + diff --git a/docs/files/src-taskrunner-commands-toolcommands.html b/docs/files/src-taskrunner-commands-toolcommands.html new file mode 100644 index 000000000..68cf769ab --- /dev/null +++ b/docs/files/src-taskrunner-commands-toolcommands.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

                                            + + + + + +
                                            + +
                                            +
                                            + + + + +
                                            +
                                              +
                                            + +
                                            +

                                            ToolCommands.php

                                            + + +
                                            + + + + + + +

                                            + Interfaces, Classes, Traits and Enums + +

                                            + +
                                            + +
                                            ToolCommands
                                            +
                                            Generic tools.
                                            + + +
                                            + + + + + + + + +
                                            +
                                            +
                                            +
                                            +
                                            
                                            +        
                                            + +
                                            +
                                            + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + + + + + diff --git a/docs/files/src-toolkit.html b/docs/files/src-toolkit.html new file mode 100644 index 000000000..59326ab4d --- /dev/null +++ b/docs/files/src-toolkit.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

                                              + + + + + +
                                              + +
                                              +
                                              + + + + +
                                              +
                                                +
                                              + +
                                              +

                                              Toolkit.php

                                              + + +
                                              + + + + + + +

                                              + Interfaces, Classes, Traits and Enums + +

                                              + +
                                              + +
                                              Toolkit
                                              +
                                              Provides default Toolkit class.
                                              + + +
                                              + + + + + + + + +
                                              +
                                              +
                                              +
                                              +
                                              
                                              +        
                                              + +
                                              +
                                              + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + + + + + diff --git a/docs/files/tests-abstracttest.html b/docs/files/tests-abstracttest.html new file mode 100644 index 000000000..ceee3d3c9 --- /dev/null +++ b/docs/files/tests-abstracttest.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

                                                + + + + + +
                                                + +
                                                +
                                                + + + + +
                                                +
                                                  +
                                                + +
                                                +

                                                AbstractTest.php

                                                + + +
                                                + + + + + + +

                                                + Interfaces, Classes, Traits and Enums + +

                                                + +
                                                + +
                                                AbstractTest
                                                +
                                                Abstract test class for Toolkit commands.
                                                + + +
                                                + + + + + + + + +
                                                +
                                                +
                                                +
                                                +
                                                
                                                +        
                                                + +
                                                +
                                                + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + + + + + diff --git a/docs/files/tests-commands-buildcommandstest.html b/docs/files/tests-commands-buildcommandstest.html new file mode 100644 index 000000000..074f15f94 --- /dev/null +++ b/docs/files/tests-commands-buildcommandstest.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

                                                  + + + + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  +
                                                    +
                                                  + +
                                                  +

                                                  BuildCommandsTest.php

                                                  + + +
                                                  + + + + + + +

                                                  + Interfaces, Classes, Traits and Enums + +

                                                  + +
                                                  + +
                                                  BuildCommandsTest
                                                  +
                                                  Abstract test class for Toolkit commands.
                                                  + + +
                                                  + + + + + + + + +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  
                                                  +        
                                                  + +
                                                  +
                                                  + + + +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + + + + + diff --git a/docs/files/tests-commands-clonecommandstest.html b/docs/files/tests-commands-clonecommandstest.html new file mode 100644 index 000000000..03575db3c --- /dev/null +++ b/docs/files/tests-commands-clonecommandstest.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

                                                    + + + + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    +
                                                      +
                                                    + +
                                                    +

                                                    CloneCommandsTest.php

                                                    + + +
                                                    + + + + + + +

                                                    + Interfaces, Classes, Traits and Enums + +

                                                    + +
                                                    + +
                                                    CloneCommandsTest
                                                    +
                                                    Abstract test class for Toolkit commands.
                                                    + + +
                                                    + + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    
                                                    +        
                                                    + +
                                                    +
                                                    + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + + + + + diff --git a/docs/files/tests-commands-drupalcommandstest.html b/docs/files/tests-commands-drupalcommandstest.html new file mode 100644 index 000000000..96a452d60 --- /dev/null +++ b/docs/files/tests-commands-drupalcommandstest.html @@ -0,0 +1,307 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

                                                      + + + + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      +
                                                        +
                                                      + +
                                                      +

                                                      DrupalCommandsTest.php

                                                      + + +
                                                      + + + + + + +

                                                      + Interfaces, Classes, Traits and Enums + +

                                                      + +
                                                      + +
                                                      DrupalCommandsTest
                                                      +
                                                      Abstract test class for Toolkit commands.
                                                      + + +
                                                      + + +

                                                      + Table of Contents + +

                                                      + +
                                                      +
                                                      + random_bytes() + +  : mixed +
                                                      +
                                                      Override random_bytes function for test.
                                                      + +
                                                      + + + + + +
                                                      +

                                                      + Functions + +

                                                      +
                                                      +

                                                      + random_bytes() + +

                                                      + + +

                                                      Override random_bytes function for test.

                                                      + + + + random_bytes() : mixed + + + + +
                                                      + Tags + +
                                                      +
                                                      +
                                                      + +
                                                      Return values
                                                      + mixed + — + + +
                                                      +
                                                      + +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      
                                                      +        
                                                      + +
                                                      +
                                                      + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + + + + + diff --git a/docs/files/tests-commands-installcommandstest.html b/docs/files/tests-commands-installcommandstest.html new file mode 100644 index 000000000..3b0ad4f8a --- /dev/null +++ b/docs/files/tests-commands-installcommandstest.html @@ -0,0 +1,253 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

                                                        + + + + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        +
                                                          +
                                                        + +
                                                        +

                                                        InstallCommandsTest.php

                                                        + + +
                                                        + + + + + + +

                                                        + Interfaces, Classes, Traits and Enums + +

                                                        + +
                                                        + +
                                                        InstallCommandsTest
                                                        +
                                                        Abstract test class for Toolkit commands.
                                                        + + +
                                                        + + + + + + + + +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        
                                                        +        
                                                        + +
                                                        +
                                                        + + + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + + + + + diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html new file mode 100644 index 000000000..09ef76d7a --- /dev/null +++ b/docs/graphs/classes.html @@ -0,0 +1,126 @@ + + + + + Documentation + + + + + + + + + +
                                                          +

                                                          Documentation

                                                          + + + + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          +
                                                          + +
                                                          + +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + + + + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..5ddb38d26 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,154 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

                                                            + + + + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            +

                                                            Documentation

                                                            + + +

                                                            + Packages + +

                                                            + +
                                                            +
                                                            Application
                                                            +
                                                            + +

                                                            + Namespaces + +

                                                            + +
                                                            +
                                                            OpenEuropa
                                                            +
                                                            EcEuropa
                                                            +
                                                            + + + + + + + +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + + + + + diff --git a/docs/indices/files.html b/docs/indices/files.html new file mode 100644 index 000000000..0e21d57f2 --- /dev/null +++ b/docs/indices/files.html @@ -0,0 +1,163 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + + + + +
                                                              + +
                                                              +
                                                              + + + + + +
                                                              + + +
                                                              + + + + + + + + diff --git a/docs/js/search.js b/docs/js/search.js new file mode 100644 index 000000000..093d6d03f --- /dev/null +++ b/docs/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                              ' + result.name + "

                                                              \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                              ' + result.summary + '
                                                              '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js new file mode 100644 index 000000000..4adaf75f5 --- /dev/null +++ b/docs/js/searchIndex.js @@ -0,0 +1,649 @@ +Search.appendIndex( + [ + { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext", + "name": "BlackfireMinkContext", + "summary": "Extends\u0020Behat\u0020MinkContext\u0020and\u0020add\u0020steps\u0020from\u0020Drupal\u0020MinkContext.", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertAtPath\u0028\u0029", + "name": "assertAtPath", + "summary": "Visit\u0020a\u0020given\u0020path,\u0020and\u0020additionally\u0020check\u0020for\u0020HTTP\u0020response\u0020code\u0020200.", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertAtPath" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertTextVisible\u0028\u0029", + "name": "assertTextVisible", + "summary": "", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertTextVisible" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertNotTextVisible\u0028\u0029", + "name": "assertNotTextVisible", + "summary": "", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertNotTextVisible" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertHttpResponse\u0028\u0029", + "name": "assertHttpResponse", + "summary": "", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertHttpResponse" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertNotHttpResponse\u0028\u0029", + "name": "assertNotHttpResponse", + "summary": "", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertNotHttpResponse" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003ApressButton\u0028\u0029", + "name": "pressButton", + "summary": "Presses\u0020button\u0020with\u0020specified\u0020id\u007Cname\u007Ctitle\u007Calt\u007Cvalue.", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_pressButton" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertHeading\u0028\u0029", + "name": "assertHeading", + "summary": "", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertHeading" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AassertRegionLinkFollow\u0028\u0029", + "name": "assertRegionLinkFollow", + "summary": "", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_assertRegionLinkFollow" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat\\BlackfireMinkContext\u003A\u003AiAmOnLandingPage\u0028\u0029", + "name": "iAmOnLandingPage", + "summary": "This\u0020is\u0020the\u0020example\u0020provided\u0020by\u0020Blackfire\u0020docs.", + "url": "classes/OpenEuropa-Site-Tests-Behat-BlackfireMinkContext.html#method_iAmOnLandingPage" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands", + "name": "BuildCommands", + "summary": "Provides\u0020commands\u0020to\u0020build\u0020a\u0020site\u0020for\u0020development\u0020and\u0020a\u0020production\u0020artifact.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AgetConfigurationFile\u0028\u0029", + "name": "getConfigurationFile", + "summary": "\u007B\u0040inheritdoc\u007D", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_getConfigurationFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AbuildDist\u0028\u0029", + "name": "buildDist", + "summary": "Build\u0020the\u0020distribution\u0020package.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_buildDist" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AbuildDev\u0028\u0029", + "name": "buildDev", + "summary": "Build\u0020site\u0020for\u0020local\u0020development.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_buildDev" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AbuildDevReset\u0028\u0029", + "name": "buildDevReset", + "summary": "Build\u0020site\u0020for\u0020local\u0020development\u0020from\u0020scratch\u0020with\u0020a\u0020clean\u0020git.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_buildDevReset" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AgetGitTag\u0028\u0029", + "name": "getGitTag", + "summary": "Returns\u0020the\u0020current\u0020Git\u0020tag.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_getGitTag" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AgetGitCommitHash\u0028\u0029", + "name": "getGitCommitHash", + "summary": "Returns\u0020the\u0020current\u0020Git\u0020commit\u0020hash.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_getGitCommitHash" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\BuildCommands\u003A\u003AbuildAssets\u0028\u0029", + "name": "buildAssets", + "summary": "Build\u0020theme\u0020assets\u0020\u0028Css\u0020and\u0020Js\u0029.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html#method_buildAssets" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands", + "name": "CloneCommands", + "summary": "Provides\u0020commands\u0020to\u0020clone\u0020a\u0020site\u0020for\u0020development\u0020and\u0020a\u0020production\u0020artifact.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AgetConfigurationFile\u0028\u0029", + "name": "getConfigurationFile", + "summary": "\u007B\u0040inheritdoc\u007D", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_getConfigurationFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003ArunDeploy\u0028\u0029", + "name": "runDeploy", + "summary": "Run\u0020deployment\u0020sequence.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_runDeploy" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AinstallDump\u0028\u0029", + "name": "installDump", + "summary": "Import\u0020the\u0020production\u0020snapshot.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_installDump" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AdownloadDump\u0028\u0029", + "name": "downloadDump", + "summary": "Download\u0020ASDA\u0020snapshot.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_downloadDump" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AcheckForNewerDump\u0028\u0029", + "name": "checkForNewerDump", + "summary": "Check\u0020if\u0020a\u0020newer\u0020dump\u0020exists\u0020on\u0020the\u0020server.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_checkForNewerDump" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AasdaProcessFile\u0028\u0029", + "name": "asdaProcessFile", + "summary": "Helper\u0020to\u0020download\u0020and\u0020process\u0020a\u0020ASDA\u0020file.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_asdaProcessFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AgenerateAsdaWgetInputFile\u0028\u0029", + "name": "generateAsdaWgetInputFile", + "summary": "Create\u0020file\u0020containing\u0020a\u0020url\u0020for\u0020usage\u0020in\u0020wget\u0020\u002D\u002Dinput\u002Dfile\u0020argument.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_generateAsdaWgetInputFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AwgetDownloadFile\u0028\u0029", + "name": "wgetDownloadFile", + "summary": "Download\u0020the\u0020file\u0020present\u0020in\u0020the\u0020tmp\u0020file.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_wgetDownloadFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\CloneCommands\u003A\u003AtmpDirectory\u0028\u0029", + "name": "tmpDirectory", + "summary": "Return\u0020the\u0020tmp\u0020folder\u0020path,\u0020folder\u0020is\u0020created\u0020if\u0020missing.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-CloneCommands.html#method_tmpDirectory" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DrupalCommands", + "name": "DrupalCommands", + "summary": "Drupal\u0020commands\u0020to\u0020setup\u0020and\u0020install\u0020a\u0020Drupal\u00208\u0020site.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DrupalCommands\u003A\u003AsettingsSetup\u0028\u0029", + "name": "settingsSetup", + "summary": "Setup\u0020Drupal\u0020settings.php\u0020file\u0020in\u0020compliance\u0020with\u0020Toolkit\u0020conventions.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html#method_settingsSetup" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DrupalCommands\u003A\u003AgetSettingsBlockRegex\u0028\u0029", + "name": "getSettingsBlockRegex", + "summary": "Remove\u0020settings\u0020block\u0020from\u0020given\u0020content.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html#method_getSettingsBlockRegex" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DrupalCommands\u003A\u003AgetToolkitSettingsBlock\u0028\u0029", + "name": "getToolkitSettingsBlock", + "summary": "Helper\u0020function\u0020to\u0020update\u0020settings.php\u0020file.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html#method_getToolkitSettingsBlock" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DrupalCommands\u003A\u003A\u0024blockEnd", + "name": "blockEnd", + "summary": "Comment\u0020ending\u0020the\u0020Toolkit\u0020settings\u0020block.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html#property_blockEnd" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DrupalCommands\u003A\u003A\u0024blockStart", + "name": "blockStart", + "summary": "Comment\u0020starting\u0020the\u0020Toolkit\u0020settings\u0020block.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html#property_blockStart" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\InstallCommands", + "name": "InstallCommands", + "summary": "Class\u0020ToolkitCommands.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\InstallCommands\u003A\u003AgetConfigurationFile\u0028\u0029", + "name": "getConfigurationFile", + "summary": "\u007B\u0040inheritdoc\u007D", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html#method_getConfigurationFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\InstallCommands\u003A\u003AinstallClean\u0028\u0029", + "name": "installClean", + "summary": "Install\u0020a\u0020clean\u0020website.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html#method_installClean" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\InstallCommands\u003A\u003AinstallClone\u0028\u0029", + "name": "installClone", + "summary": "Install\u0020a\u0020clone\u0020website.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html#method_installClone" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\InstallCommands\u003A\u003AimportConfig\u0028\u0029", + "name": "importConfig", + "summary": "Import\u0020config.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-InstallCommands.html#method_importConfig" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\LoadDefaultConfigCommands", + "name": "LoadDefaultConfigCommands", + "summary": "Default\u0020configuration\u0020loader.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\LoadDefaultConfigCommands\u003A\u003AgetDefaultConfigurationFile\u0028\u0029", + "name": "getDefaultConfigurationFile", + "summary": "Path\u0020to\u0020YAML\u0020configuration\u0020file\u0020containing\u0020command\u0020defaults.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html#method_getDefaultConfigurationFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\LoadDefaultConfigCommands\u003A\u003AloadDefaultConfig\u0028\u0029", + "name": "loadDefaultConfig", + "summary": "Load\u0020default\u0020Toolkit\u0020configuration.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-LoadDefaultConfigCommands.html#method_loadDefaultConfig" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands", + "name": "TestsCommands", + "summary": "Class\u0020TestsCommands.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AgetConfigurationFile\u0028\u0029", + "name": "getConfigurationFile", + "summary": "\u007B\u0040inheritdoc\u007D", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_getConfigurationFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitSetupPhpcs\u0028\u0029", + "name": "toolkitSetupPhpcs", + "summary": "Setup\u0020PHP\u0020code\u0020sniffer\u0020for\u0020standalone\u0020execution.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitSetupPhpcs" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitPhpcs\u0028\u0029", + "name": "toolkitPhpcs", + "summary": "Run\u0020PHP\u0020code\u0020sniffer.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitPhpcs" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitPhpmd\u0028\u0029", + "name": "toolkitPhpmd", + "summary": "Run\u0020PHPMD\u0020standalone.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitPhpmd" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003ArunGrumphp\u0028\u0029", + "name": "runGrumphp", + "summary": "Run\u0020PHP\u0020code\u0020sniffer\u0020within\u0020GrumPHP.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_runGrumphp" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003ArunPhpcs\u0028\u0029", + "name": "runPhpcs", + "summary": "Run\u0020PHP\u0020code\u0020sniffer\u0020in\u0020standalone\u0020mode.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_runPhpcs" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AcheckPhpCsRequirements\u0028\u0029", + "name": "checkPhpCsRequirements", + "summary": "Make\u0020sure\u0020that\u0020the\u0020config\u0020file\u0020exists\u0020and\u0020configuration\u0020is\u0020correct.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_checkPhpCsRequirements" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitBehat\u0028\u0029", + "name": "toolkitBehat", + "summary": "Run\u0020Behat\u0020tests.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitBehat" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitPhpUnit\u0028\u0029", + "name": "toolkitPhpUnit", + "summary": "Run\u0020PHPUnit\u0020tests.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitPhpUnit" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitPhpcbf\u0028\u0029", + "name": "toolkitPhpcbf", + "summary": "Run\u0020PHP\u0020code\u0020autofixing.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitPhpcbf" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitPhpcbfStandalone\u0028\u0029", + "name": "toolkitPhpcbfStandalone", + "summary": "Run\u0020PHP\u0020code\u0020autofixing\u0020in\u0020standalone\u0020mode.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitPhpcbfStandalone" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitLintYaml\u0028\u0029", + "name": "toolkitLintYaml", + "summary": "Run\u0020lint\u0020YAML.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitLintYaml" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitLintPhp\u0028\u0029", + "name": "toolkitLintPhp", + "summary": "Run\u0020lint\u0020PHP.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitLintPhp" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\TestsCommands\u003A\u003AtoolkitBlackfire\u0028\u0029", + "name": "toolkitBlackfire", + "summary": "Run\u0020Blackfire.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-TestsCommands.html#method_toolkitBlackfire" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands", + "name": "ToolCommands", + "summary": "Generic\u0020tools.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetConfigurationFile\u0028\u0029", + "name": "getConfigurationFile", + "summary": "\u007B\u0040inheritdoc\u007D", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getConfigurationFile" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AdisableDrupalCache\u0028\u0029", + "name": "disableDrupalCache", + "summary": "Disable\u0020aggregation\u0020and\u0020clear\u0020cache.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_disableDrupalCache" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AdisplayNotifications\u0028\u0029", + "name": "displayNotifications", + "summary": "Display\u0020toolkit\u0020notifications.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_displayNotifications" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcomponentCheck\u0028\u0029", + "name": "componentCheck", + "summary": "Check\u0020composer.json\u0020for\u0020components\u0020that\u0020are\u0020not\u0020whitelisted\/blacklisted.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_componentCheck" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AprintComponentResults\u0028\u0029", + "name": "printComponentResults", + "summary": "Helper\u0020function\u0020to\u0020validate\u0020the\u0020component.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_printComponentResults" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AvalidateComponent\u0028\u0029", + "name": "validateComponent", + "summary": "Helper\u0020function\u0020to\u0020validate\u0020the\u0020component.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_validateComponent" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcomponentMandatory\u0028\u0029", + "name": "componentMandatory", + "summary": "Helper\u0020function\u0020to\u0020check\u0020component\u0027s\u0020review\u0020information.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_componentMandatory" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcomponentRecommended\u0028\u0029", + "name": "componentRecommended", + "summary": "Helper\u0020function\u0020to\u0020check\u0020component\u0027s\u0020review\u0020information.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_componentRecommended" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcomponentInsecure\u0028\u0029", + "name": "componentInsecure", + "summary": "Helper\u0020function\u0020to\u0020check\u0020component\u0027s\u0020review\u0020information.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_componentInsecure" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcomponentOutdated\u0028\u0029", + "name": "componentOutdated", + "summary": "Helper\u0020function\u0020to\u0020check\u0020component\u0027s\u0020review\u0020information.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_componentOutdated" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetQaEndpointContent\u0028\u0029", + "name": "getQaEndpointContent", + "summary": "Curl\u0020function\u0020to\u0020access\u0020endpoint\u0020with\u0020or\u0020without\u0020authentication.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getQaEndpointContent" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetQaSessionToken\u0028\u0029", + "name": "getQaSessionToken", + "summary": "Helper\u0020to\u0020return\u0020the\u0020session\u0020token.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getQaSessionToken" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003ApostQaContent\u0028\u0029", + "name": "postQaContent", + "summary": "Helper\u0020to\u0020send\u0020a\u0020payload\u0020to\u0020the\u0020QA\u0020Website.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_postQaContent" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003Ad9Compatibility\u0028\u0029", + "name": "d9Compatibility", + "summary": "Check\u0020project\u0020compatibility\u0020for\u0020Drupal\u00209\u0020upgrade.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_d9Compatibility" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcomposerLockCheck\u0028\u0029", + "name": "composerLockCheck", + "summary": "Check\u0020if\u0020\u0027composer.lock\u0027\u0020exists\u0020on\u0020the\u0020project\u0020root\u0020folder.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_composerLockCheck" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AoptsReview\u0028\u0029", + "name": "optsReview", + "summary": "Check\u0020project\u0027s\u0020.opts.yml\u0020file\u0020for\u0020forbidden\u0020commands.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_optsReview" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AcheckCommitMessage\u0028\u0029", + "name": "checkCommitMessage", + "summary": "Check\u0020the\u0020commit\u0020message\u0020for\u0020SKIPPING\u0020tokens.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_checkCommitMessage" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AsetupBlackfireBehat\u0028\u0029", + "name": "setupBlackfireBehat", + "summary": "Copy\u0020the\u0020needed\u0020resources\u0020to\u0020run\u0020Behat\u0020with\u0020Blackfire.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_setupBlackfireBehat" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetPackageDetails\u0028\u0029", + "name": "getPackageDetails", + "summary": "Call\u0020release\u0020history\u0020of\u0020d.org\u0020to\u0020confirm\u0020security\u0020alert.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getPackageDetails" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AtoolkitRequirements\u0028\u0029", + "name": "toolkitRequirements", + "summary": "Check\u0020the\u0020Toolkit\u0020Requirements.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_toolkitRequirements" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AfixPermissions\u0028\u0029", + "name": "fixPermissions", + "summary": "Run\u0020script\u0020to\u0020fix\u0020permissions\u0020\u0028experimental\u0029.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_fixPermissions" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AtoolkitVersion\u0028\u0029", + "name": "toolkitVersion", + "summary": "Check\u0020the\u0020Toolkit\u0020version.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_toolkitVersion" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetPackagePropertyFromComposer\u0028\u0029", + "name": "getPackagePropertyFromComposer", + "summary": "Helper\u0020to\u0020return\u0020a\u0020property\u0020from\u0020a\u0020package\u0020in\u0020the\u0020composer.lock\u0020file.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getPackagePropertyFromComposer" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AtoolkitVendorList\u0028\u0029", + "name": "toolkitVendorList", + "summary": "Check\u0020\u0027Vendor\u0027\u0020packages\u0020being\u0020monitorised.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_toolkitVendorList" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetQaApiBasicAuth\u0028\u0029", + "name": "getQaApiBasicAuth", + "summary": "Return\u0020the\u0020QA\u0020API\u0020BASIC\u0020AUTH\u0020from\u0020token\u0020or\u0020from\u0020questions.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getQaApiBasicAuth" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetDeploymentEnvironment\u0028\u0029", + "name": "getDeploymentEnvironment", + "summary": "Returns\u0020the\u0020current\u0020environment\u0020based\u0020on\u0020env\u0020vars.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getDeploymentEnvironment" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AtoolkitCodeReview\u0028\u0029", + "name": "toolkitCodeReview", + "summary": "This\u0020command\u0020will\u0020execute\u0020all\u0020the\u0020testing\u0020tools.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_toolkitCodeReview" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AformatBytes\u0028\u0029", + "name": "formatBytes", + "summary": "Helper\u0020to\u0020convert\u0020bytes\u0020to\u0020human\u002Dreadable\u0020unit.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_formatBytes" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ToolCommands\u003A\u003AgetQaProjectInformation\u0028\u0029", + "name": "getQaProjectInformation", + "summary": "Returns\u0020the\u0020Project\u0020information\u0020from\u0020the\u0020QA\u0020Website.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ToolCommands.html#method_getQaProjectInformation" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit", + "name": "Toolkit", + "summary": "Provides\u0020default\u0020Toolkit\u0020class.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AgetQaWebsiteUrl\u0028\u0029", + "name": "getQaWebsiteUrl", + "summary": "Returns\u0020the\u0020QA\u0020base\u0020url.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#method_getQaWebsiteUrl" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AisCiCd\u0028\u0029", + "name": "isCiCd", + "summary": "Returns\u0020whether\u0020is\u0020running\u0020in\u0020CI\/CD\u0020environment.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#method_isCiCd" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AgetAsdaUser\u0028\u0029", + "name": "getAsdaUser", + "summary": "Returns\u0020the\u0020ASDA\u0020user.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#method_getAsdaUser" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AgetAsdaPass\u0028\u0029", + "name": "getAsdaPass", + "summary": "Returns\u0020the\u0020ASDA\u0020password.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#method_getAsdaPass" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AgetNextcloudUser\u0028\u0029", + "name": "getNextcloudUser", + "summary": "Returns\u0020the\u0020NEXTCLOUD\u0020user.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#method_getNextcloudUser" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AgetNextcloudPass\u0028\u0029", + "name": "getNextcloudPass", + "summary": "Returns\u0020the\u0020NEXTCLOUD\u0020password.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#method_getNextcloudPass" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Toolkit\u003A\u003AVERSION", + "name": "VERSION", + "summary": "Constant\u0020holding\u0020the\u0020current\u0020version.", + "url": "classes/EcEuropa-Toolkit-Toolkit.html#constant_VERSION" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest", + "name": "AbstractTest", + "summary": "Abstract\u0020test\u0020class\u0020for\u0020Toolkit\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AsetUp\u0028\u0029", + "name": "setUp", + "summary": "\u007B\u0040inheritdoc\u007D", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_setUp" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AassertContainsNotContains\u0028\u0029", + "name": "assertContainsNotContains", + "summary": "Helper\u0020function\u0020to\u0020assert\u0020contain\u0020\/\u0020not\u0020contain\u0020expectations.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_assertContainsNotContains" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AtrimEachLine\u0028\u0029", + "name": "trimEachLine", + "summary": "Trim\u0020each\u0020line\u0020of\u0020a\u0020blob\u0020of\u0020text,\u0020used\u0020when\u0020asserting\u0020on\u0020multiline\u0020strings.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_trimEachLine" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AgetClassLoader\u0028\u0029", + "name": "getClassLoader", + "summary": "Get\u0020class\u0020loader.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_getClassLoader" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AgetFixtureRoot\u0028\u0029", + "name": "getFixtureRoot", + "summary": "Get\u0020fixture\u0020root.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_getFixtureRoot" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AgetFixtureFilepath\u0028\u0029", + "name": "getFixtureFilepath", + "summary": "Get\u0020fixture\u0020filepath.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_getFixtureFilepath" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AgetFixtureContent\u0028\u0029", + "name": "getFixtureContent", + "summary": "Get\u0020fixture\u0020content.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_getFixtureContent" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AgetSandboxFilepath\u0028\u0029", + "name": "getSandboxFilepath", + "summary": "Get\u0020sandbox\u0020filepath.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_getSandboxFilepath" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\AbstractTest\u003A\u003AgetSandboxRoot\u0028\u0029", + "name": "getSandboxRoot", + "summary": "Get\u0020sandbox\u0020root\u0020path.", + "url": "classes/EcEuropa-Toolkit-Tests-AbstractTest.html#method_getSandboxRoot" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\BuildCommandsTest", + "name": "BuildCommandsTest", + "summary": "Abstract\u0020test\u0020class\u0020for\u0020Toolkit\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\BuildCommandsTest\u003A\u003AdataProvider\u0028\u0029", + "name": "dataProvider", + "summary": "Data\u0020provider\u0020for\u0020testBuild.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html#method_dataProvider" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\BuildCommandsTest\u003A\u003AtestBuild\u0028\u0029", + "name": "testBuild", + "summary": "Test\u0020\u0022toolkit\u003Abuild\u002D\u002A\u0022\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-BuildCommandsTest.html#method_testBuild" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\CloneCommandsTest", + "name": "CloneCommandsTest", + "summary": "Abstract\u0020test\u0020class\u0020for\u0020Toolkit\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\CloneCommandsTest\u003A\u003AdataProvider\u0028\u0029", + "name": "dataProvider", + "summary": "Data\u0020provider\u0020for\u0020testClone.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html#method_dataProvider" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\CloneCommandsTest\u003A\u003AtestClone\u0028\u0029", + "name": "testClone", + "summary": "Test\u0020\u0022toolkit\u003Aclone\u002D\u002A\u0022\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-CloneCommandsTest.html#method_testClone" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\random_bytes\u0028\u0029", + "name": "random_bytes", + "summary": "Override\u0020random_bytes\u0020function\u0020for\u0020test.", + "url": "namespaces/eceuropa-toolkit-taskrunner-commands.html#function_random_bytes" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\DrupalCommandsTest", + "name": "DrupalCommandsTest", + "summary": "Abstract\u0020test\u0020class\u0020for\u0020Toolkit\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\DrupalCommandsTest\u003A\u003AdataProvider\u0028\u0029", + "name": "dataProvider", + "summary": "Data\u0020provider\u0020for\u0020testDrupalSettingsSetup.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html#method_dataProvider" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\DrupalCommandsTest\u003A\u003AtestDrupalSettingsSetup\u0028\u0029", + "name": "testDrupalSettingsSetup", + "summary": "Test\u0020Toolkit\u0020very\u0020own\u0020\u0022drupal\u003Asettings\u002Dsetup\u0022\u0020command.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-DrupalCommandsTest.html#method_testDrupalSettingsSetup" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\InstallCommandsTest", + "name": "InstallCommandsTest", + "summary": "Abstract\u0020test\u0020class\u0020for\u0020Toolkit\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\InstallCommandsTest\u003A\u003AdataProvider\u0028\u0029", + "name": "dataProvider", + "summary": "Data\u0020provider\u0020for\u0020testInstall.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html#method_dataProvider" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands\\InstallCommandsTest\u003A\u003AtestInstall\u0028\u0029", + "name": "testInstall", + "summary": "Test\u0020\u0022toolkit\u003Ainstall\u002D\u002A\u0022\u0020commands.", + "url": "classes/EcEuropa-Toolkit-Tests-Commands-InstallCommandsTest.html#method_testInstall" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests\\Behat", + "name": "Behat", + "summary": "", + "url": "namespaces/openeuropa-site-tests-behat.html" + }, { + "fqsen": "\\OpenEuropa\\Site\\Tests", + "name": "Tests", + "summary": "", + "url": "namespaces/openeuropa-site-tests.html" + }, { + "fqsen": "\\OpenEuropa\\Site", + "name": "Site", + "summary": "", + "url": "namespaces/openeuropa-site.html" + }, { + "fqsen": "\\OpenEuropa", + "name": "OpenEuropa", + "summary": "", + "url": "namespaces/openeuropa.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands", + "name": "Commands", + "summary": "", + "url": "namespaces/eceuropa-toolkit-taskrunner-commands.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner", + "name": "TaskRunner", + "summary": "", + "url": "namespaces/eceuropa-toolkit-taskrunner.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit", + "name": "Toolkit", + "summary": "", + "url": "namespaces/eceuropa-toolkit.html" + }, { + "fqsen": "\\EcEuropa", + "name": "EcEuropa", + "summary": "", + "url": "namespaces/eceuropa.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests", + "name": "Tests", + "summary": "", + "url": "namespaces/eceuropa-toolkit-tests.html" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\Tests\\Commands", + "name": "Commands", + "summary": "", + "url": "namespaces/eceuropa-toolkit-tests-commands.html" + } ] +); diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html new file mode 100644 index 000000000..582584c63 --- /dev/null +++ b/docs/namespaces/default.html @@ -0,0 +1,242 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + + + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              +
                                                                +
                                                              + +
                                                              +

                                                              API Documentation

                                                              + + +

                                                              + Namespaces + +

                                                              + +
                                                              +
                                                              OpenEuropa
                                                              +
                                                              EcEuropa
                                                              +
                                                              + + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              
                                                              +        
                                                              + +
                                                              +
                                                              + + + +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + + + + + diff --git a/docs/namespaces/eceuropa-toolkit-taskrunner-commands.html b/docs/namespaces/eceuropa-toolkit-taskrunner-commands.html new file mode 100644 index 000000000..625d12b89 --- /dev/null +++ b/docs/namespaces/eceuropa-toolkit-taskrunner-commands.html @@ -0,0 +1,314 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

                                                                + + + + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                + + +
                                                                +

                                                                Commands

                                                                + + + +

                                                                + Interfaces, Classes, Traits and Enums + +

                                                                + +
                                                                + +
                                                                BuildCommands
                                                                +
                                                                Provides commands to build a site for development and a production artifact.
                                                                +
                                                                CloneCommands
                                                                +
                                                                Provides commands to clone a site for development and a production artifact.
                                                                +
                                                                DrupalCommands
                                                                +
                                                                Drupal commands to setup and install a Drupal 8 site.
                                                                +
                                                                InstallCommands
                                                                +
                                                                Class ToolkitCommands.
                                                                +
                                                                LoadDefaultConfigCommands
                                                                +
                                                                Default configuration loader.
                                                                +
                                                                TestsCommands
                                                                +
                                                                Class TestsCommands.
                                                                +
                                                                ToolCommands
                                                                +
                                                                Generic tools.
                                                                + + +
                                                                + + +

                                                                + Table of Contents + +

                                                                + +
                                                                +
                                                                + random_bytes() + +  : mixed +
                                                                +
                                                                Override random_bytes function for test.
                                                                + +
                                                                + + + +
                                                                +

                                                                + Functions + +

                                                                +
                                                                +

                                                                + random_bytes() + +

                                                                + + +

                                                                Override random_bytes function for test.

                                                                + + + + random_bytes() : mixed + + + + +
                                                                + Tags + +
                                                                +
                                                                +
                                                                + +
                                                                Return values
                                                                + mixed + — + + +
                                                                +
                                                                + +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                
                                                                +        
                                                                + +
                                                                +
                                                                + + + +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + + + + + diff --git a/docs/namespaces/eceuropa-toolkit-taskrunner.html b/docs/namespaces/eceuropa-toolkit-taskrunner.html new file mode 100644 index 000000000..020ec1f5d --- /dev/null +++ b/docs/namespaces/eceuropa-toolkit-taskrunner.html @@ -0,0 +1,243 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  Documentation

                                                                  + + + + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  + + +
                                                                  +

                                                                  TaskRunner

                                                                  + + +

                                                                  + Namespaces + +

                                                                  + +
                                                                  +
                                                                  Commands
                                                                  +
                                                                  + + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  
                                                                  +        
                                                                  + +
                                                                  +
                                                                  + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + + + + + diff --git a/docs/namespaces/eceuropa-toolkit-tests-commands.html b/docs/namespaces/eceuropa-toolkit-tests-commands.html new file mode 100644 index 000000000..d4a72cde4 --- /dev/null +++ b/docs/namespaces/eceuropa-toolkit-tests-commands.html @@ -0,0 +1,254 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                    +

                                                                    Documentation

                                                                    + + + + + +
                                                                    + +
                                                                    +
                                                                    + + + + +
                                                                    + + +
                                                                    +

                                                                    Commands

                                                                    + + + +

                                                                    + Interfaces, Classes, Traits and Enums + +

                                                                    + +
                                                                    + +
                                                                    BuildCommandsTest
                                                                    +
                                                                    Abstract test class for Toolkit commands.
                                                                    +
                                                                    CloneCommandsTest
                                                                    +
                                                                    Abstract test class for Toolkit commands.
                                                                    +
                                                                    DrupalCommandsTest
                                                                    +
                                                                    Abstract test class for Toolkit commands.
                                                                    +
                                                                    InstallCommandsTest
                                                                    +
                                                                    Abstract test class for Toolkit commands.
                                                                    + + +
                                                                    + + + + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    
                                                                    +        
                                                                    + +
                                                                    +
                                                                    + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + + + + + diff --git a/docs/namespaces/eceuropa-toolkit-tests.html b/docs/namespaces/eceuropa-toolkit-tests.html new file mode 100644 index 000000000..01acd0cd3 --- /dev/null +++ b/docs/namespaces/eceuropa-toolkit-tests.html @@ -0,0 +1,255 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                      +

                                                                      Documentation

                                                                      + + + + + +
                                                                      + +
                                                                      +
                                                                      + + + + +
                                                                      + + +
                                                                      +

                                                                      Tests

                                                                      + + +

                                                                      + Namespaces + +

                                                                      + +
                                                                      +
                                                                      Commands
                                                                      +
                                                                      + +

                                                                      + Interfaces, Classes, Traits and Enums + +

                                                                      + +
                                                                      + +
                                                                      AbstractTest
                                                                      +
                                                                      Abstract test class for Toolkit commands.
                                                                      + + +
                                                                      + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      
                                                                      +        
                                                                      + +
                                                                      +
                                                                      + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + + + + + diff --git a/docs/namespaces/eceuropa-toolkit.html b/docs/namespaces/eceuropa-toolkit.html new file mode 100644 index 000000000..c82ca4e88 --- /dev/null +++ b/docs/namespaces/eceuropa-toolkit.html @@ -0,0 +1,255 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                        +

                                                                        Documentation

                                                                        + + + + + +
                                                                        + +
                                                                        +
                                                                        + + + + +
                                                                        + + +
                                                                        +

                                                                        Toolkit

                                                                        + + +

                                                                        + Namespaces + +

                                                                        + +
                                                                        +
                                                                        TaskRunner
                                                                        +
                                                                        Tests
                                                                        +
                                                                        + +

                                                                        + Interfaces, Classes, Traits and Enums + +

                                                                        + +
                                                                        + +
                                                                        Toolkit
                                                                        +
                                                                        Provides default Toolkit class.
                                                                        + + +
                                                                        + + + + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        
                                                                        +        
                                                                        + +
                                                                        +
                                                                        + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + + + + + diff --git a/docs/namespaces/eceuropa.html b/docs/namespaces/eceuropa.html new file mode 100644 index 000000000..f70766c9c --- /dev/null +++ b/docs/namespaces/eceuropa.html @@ -0,0 +1,241 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                          +

                                                                          Documentation

                                                                          + + + + + +
                                                                          + +
                                                                          +
                                                                          + + + + +
                                                                          +
                                                                            +
                                                                          + +
                                                                          +

                                                                          EcEuropa

                                                                          + + +

                                                                          + Namespaces + +

                                                                          + +
                                                                          +
                                                                          Toolkit
                                                                          +
                                                                          + + + + + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          
                                                                          +        
                                                                          + +
                                                                          +
                                                                          + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + + + + + diff --git a/docs/namespaces/openeuropa-site-tests-behat.html b/docs/namespaces/openeuropa-site-tests-behat.html new file mode 100644 index 000000000..283cd9ffa --- /dev/null +++ b/docs/namespaces/openeuropa-site-tests-behat.html @@ -0,0 +1,248 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                            +

                                                                            Documentation

                                                                            + + + + + +
                                                                            + +
                                                                            +
                                                                            + + + + +
                                                                            + + +
                                                                            +

                                                                            Behat

                                                                            + + + +

                                                                            + Interfaces, Classes, Traits and Enums + +

                                                                            + +
                                                                            + +
                                                                            BlackfireMinkContext
                                                                            +
                                                                            Extends Behat MinkContext and add steps from Drupal MinkContext.
                                                                            + + +
                                                                            + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            
                                                                            +        
                                                                            + +
                                                                            +
                                                                            + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + + + + + diff --git a/docs/namespaces/openeuropa-site-tests.html b/docs/namespaces/openeuropa-site-tests.html new file mode 100644 index 000000000..3f8a830aa --- /dev/null +++ b/docs/namespaces/openeuropa-site-tests.html @@ -0,0 +1,243 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              Documentation

                                                                              + + + + + +
                                                                              + +
                                                                              +
                                                                              + + + + +
                                                                              + + +
                                                                              +

                                                                              Tests

                                                                              + + +

                                                                              + Namespaces + +

                                                                              + +
                                                                              +
                                                                              Behat
                                                                              +
                                                                              + + + + + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              
                                                                              +        
                                                                              + +
                                                                              +
                                                                              + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + + + + + diff --git a/docs/namespaces/openeuropa-site.html b/docs/namespaces/openeuropa-site.html new file mode 100644 index 000000000..cfe029091 --- /dev/null +++ b/docs/namespaces/openeuropa-site.html @@ -0,0 +1,242 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                Documentation

                                                                                + + + + + +
                                                                                + +
                                                                                +
                                                                                + + + + +
                                                                                + + +
                                                                                +

                                                                                Site

                                                                                + + +

                                                                                + Namespaces + +

                                                                                + +
                                                                                +
                                                                                Tests
                                                                                +
                                                                                + + + + + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                
                                                                                +        
                                                                                + +
                                                                                +
                                                                                + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + + + diff --git a/docs/namespaces/openeuropa.html b/docs/namespaces/openeuropa.html new file mode 100644 index 000000000..c5c024cac --- /dev/null +++ b/docs/namespaces/openeuropa.html @@ -0,0 +1,241 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  Documentation

                                                                                  + + + + + +
                                                                                  + +
                                                                                  +
                                                                                  + + + + +
                                                                                  +
                                                                                    +
                                                                                  + +
                                                                                  +

                                                                                  OpenEuropa

                                                                                  + + +

                                                                                  + Namespaces + +

                                                                                  + +
                                                                                  +
                                                                                  Site
                                                                                  +
                                                                                  + + + + + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  
                                                                                  +        
                                                                                  + +
                                                                                  +
                                                                                  + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + + + diff --git a/docs/packages/Application.html b/docs/packages/Application.html new file mode 100644 index 000000000..8c089de58 --- /dev/null +++ b/docs/packages/Application.html @@ -0,0 +1,325 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                    +

                                                                                    Documentation

                                                                                    + + + + + +
                                                                                    + +
                                                                                    +
                                                                                    + + + + +
                                                                                    +
                                                                                      +
                                                                                    + +
                                                                                    +

                                                                                    Application

                                                                                    + + + +

                                                                                    + Interfaces, Classes, Traits and Enums + +

                                                                                    + +
                                                                                    + +
                                                                                    BlackfireMinkContext
                                                                                    +
                                                                                    Extends Behat MinkContext and add steps from Drupal MinkContext.
                                                                                    +
                                                                                    BuildCommands
                                                                                    +
                                                                                    Provides commands to build a site for development and a production artifact.
                                                                                    +
                                                                                    CloneCommands
                                                                                    +
                                                                                    Provides commands to clone a site for development and a production artifact.
                                                                                    +
                                                                                    DrupalCommands
                                                                                    +
                                                                                    Drupal commands to setup and install a Drupal 8 site.
                                                                                    +
                                                                                    InstallCommands
                                                                                    +
                                                                                    Class ToolkitCommands.
                                                                                    +
                                                                                    LoadDefaultConfigCommands
                                                                                    +
                                                                                    Default configuration loader.
                                                                                    +
                                                                                    TestsCommands
                                                                                    +
                                                                                    Class TestsCommands.
                                                                                    +
                                                                                    ToolCommands
                                                                                    +
                                                                                    Generic tools.
                                                                                    +
                                                                                    Toolkit
                                                                                    +
                                                                                    Provides default Toolkit class.
                                                                                    +
                                                                                    AbstractTest
                                                                                    +
                                                                                    Abstract test class for Toolkit commands.
                                                                                    +
                                                                                    BuildCommandsTest
                                                                                    +
                                                                                    Abstract test class for Toolkit commands.
                                                                                    +
                                                                                    CloneCommandsTest
                                                                                    +
                                                                                    Abstract test class for Toolkit commands.
                                                                                    +
                                                                                    DrupalCommandsTest
                                                                                    +
                                                                                    Abstract test class for Toolkit commands.
                                                                                    +
                                                                                    InstallCommandsTest
                                                                                    +
                                                                                    Abstract test class for Toolkit commands.
                                                                                    + + +
                                                                                    + + +

                                                                                    + Table of Contents + +

                                                                                    + +
                                                                                    +
                                                                                    + random_bytes() + +  : mixed +
                                                                                    +
                                                                                    Override random_bytes function for test.
                                                                                    + +
                                                                                    + + + +
                                                                                    +

                                                                                    + Functions + +

                                                                                    +
                                                                                    +

                                                                                    + random_bytes() + +

                                                                                    + + +

                                                                                    Override random_bytes function for test.

                                                                                    + + + + random_bytes() : mixed + + + + +
                                                                                    + Tags + +
                                                                                    +
                                                                                    +
                                                                                    + +
                                                                                    Return values
                                                                                    + mixed + — + + +
                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    
                                                                                    +        
                                                                                    + +
                                                                                    +
                                                                                    + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    Search results

                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + + + diff --git a/docs/packages/default.html b/docs/packages/default.html new file mode 100644 index 000000000..8bebd47ea --- /dev/null +++ b/docs/packages/default.html @@ -0,0 +1,241 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
                                                                                      +

                                                                                      Documentation

                                                                                      + + + + + +
                                                                                      + +
                                                                                      +
                                                                                      + + + + +
                                                                                      +
                                                                                        +
                                                                                      + +
                                                                                      +

                                                                                      API Documentation

                                                                                      + +

                                                                                      + Packages + +

                                                                                      + +
                                                                                      +
                                                                                      Application
                                                                                      +
                                                                                      + + + + + + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      
                                                                                      +        
                                                                                      + +
                                                                                      +
                                                                                      + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Search results

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + + +
                                                                                        + + + + + + + + diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html new file mode 100644 index 000000000..2c2bafb18 --- /dev/null +++ b/docs/reports/deprecated.html @@ -0,0 +1,156 @@ + + + + + Documentation » Deprecated elements + + + + + + + + + + + + + + + + + + + + + +
                                                                                        +

                                                                                        Documentation

                                                                                        + + + + + +
                                                                                        + +
                                                                                        +
                                                                                        + + + + +
                                                                                        + + +
                                                                                        +

                                                                                        Deprecated

                                                                                        + +

                                                                                        Table of Contents

                                                                                        + + + + +
                                                                                        src/TaskRunner/Commands/ToolCommands.php
                                                                                        + + +

                                                                                        ToolCommands.php

                                                                                        + + + + + + + + + + + +
                                                                                        LineElementReason
                                                                                        65ToolCommands::displayNotifications()
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Search results

                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + + + diff --git a/docs/reports/errors.html b/docs/reports/errors.html new file mode 100644 index 000000000..537417eec --- /dev/null +++ b/docs/reports/errors.html @@ -0,0 +1,138 @@ + + + + + Documentation » Compilation errors + + + + + + + + + + + + + + + + + + + + + +
                                                                                          +

                                                                                          Documentation

                                                                                          + + + + + +
                                                                                          + +
                                                                                          +
                                                                                          + + + + +
                                                                                          + + +
                                                                                          +

                                                                                          Errors

                                                                                          + + +
                                                                                          No errors have been found in this project.
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Search results

                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + + + diff --git a/docs/reports/markers.html b/docs/reports/markers.html new file mode 100644 index 000000000..e618df57f --- /dev/null +++ b/docs/reports/markers.html @@ -0,0 +1,139 @@ + + + + + Documentation » Markers + + + + + + + + + + + + + + + + + + + + + +
                                                                                            +

                                                                                            Documentation

                                                                                            + + + + + +
                                                                                            + +
                                                                                            +
                                                                                            + + + + +
                                                                                            + + +
                                                                                            +

                                                                                            Markers

                                                                                            + +
                                                                                            + No markers have been found in this project. +
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Search results

                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + + + From cb636812fdb35993805dc835ba6e81c7f851121d Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Thu, 18 Aug 2022 11:06:33 +0000 Subject: [PATCH 09/12] DQA-3063: Rebuild documentation. --- docs/available-tasks.md | 1 + docs/building-assets.md | 1 + docs/configuring-project.md | 1 + docs/continuous-integration.md | 1 + docs/docker-environment.md | 1 + docs/index.rst | 21 +++++++++++++++++++++ docs/installing-project.md | 1 + docs/project-documentation.md | 29 +++++++++++++++++++++++++++++ docs/setting-up-project.md | 1 + docs/testing-project.md | 1 + 10 files changed, 58 insertions(+) create mode 100644 docs/index.rst create mode 100644 docs/project-documentation.md diff --git a/docs/available-tasks.md b/docs/available-tasks.md index d8e454339..24b95de8b 100644 --- a/docs/available-tasks.md +++ b/docs/available-tasks.md @@ -54,4 +54,5 @@ Available commands: - [Using Docker environment](/docs/docker-environment.md) - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/changelog.md) diff --git a/docs/building-assets.md b/docs/building-assets.md index 4084606bc..2b01da754 100644 --- a/docs/building-assets.md +++ b/docs/building-assets.md @@ -142,4 +142,5 @@ docker-compose exec web ./vendor/bin/run toolkit:build-assets --validate=fix - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) - [Available tasks](/docs/available-tasks.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) diff --git a/docs/configuring-project.md b/docs/configuring-project.md index 53bf0b991..4245f6d1a 100644 --- a/docs/configuring-project.md +++ b/docs/configuring-project.md @@ -70,4 +70,5 @@ Toolkit will load the credentials necessary to clone your subsite from your envi - [Using Docker environment](/docs/docker-environment.md) - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) diff --git a/docs/continuous-integration.md b/docs/continuous-integration.md index 680f87761..dd2cfb532 100644 --- a/docs/continuous-integration.md +++ b/docs/continuous-integration.md @@ -30,4 +30,5 @@ The pipeline allows for an automatic deployment to the acceptance environment. T - [Using Docker environment](/docs/docker-environment.md) - [Building assets](/docs/building-assets.md) - [Available tasks](/docs/available-tasks.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) diff --git a/docs/docker-environment.md b/docs/docker-environment.md index 26f7beeec..01cda3103 100644 --- a/docs/docker-environment.md +++ b/docs/docker-environment.md @@ -60,4 +60,5 @@ selenium: - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) - [Available tasks](/docs/available-tasks.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..f9066072f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +Getting started +=============== + +Is this the first time you work with |phpdoc|? You have come to the right section in the documentation! In the +chapters included of this section we will talk you through the installation, configuration and how to generate your +documentation. + +.. toctree:: + :maxdepth: 2 + + available-tasks + building-assets + configuring-project + continuous-integration + docker-environment + installing-project + project-documentation + setting-up-project + testing-project + +.. |phpdoc| replace:: phpDocumentor \ No newline at end of file diff --git a/docs/installing-project.md b/docs/installing-project.md index a6be24ab1..c3eafea92 100644 --- a/docs/installing-project.md +++ b/docs/installing-project.md @@ -80,4 +80,5 @@ These commands simulate the automated deployment that Drone provides through its - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) - [Available tasks](/docs/available-tasks.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) \ No newline at end of file diff --git a/docs/project-documentation.md b/docs/project-documentation.md new file mode 100644 index 000000000..eb027a63b --- /dev/null +++ b/docs/project-documentation.md @@ -0,0 +1,29 @@ +Update Project Documentation +============================ + +Use docker to update the documentation locally + +The Docker image comes with all dependencies pre-installed. + +To update the documentation run the following command. This will update +the content inside the folder ‘docs/phpdoc’. + +``` + + docker run --rm -v $(pwd):/data phpdoc/phpdoc run -d ./ -t ./docs/ + +``` + +Then push changes to ‘documentation’ branch (only phpdoc generated +files). + +### Other topics +- [Available tasks](/docs/available-tasks.md) +- [Setting up a project](/docs/setting-up-project.md) +- [Configuring a project](/docs/configuring-project.md) +- [Installing the project](/docs/installing-project.md) +- [Testing the project](/docs/testing-project.md) +- [Using Docker environment](/docs/docker-environment.md) +- [Continuous integration](/docs/continuous-integration.md) +- [Building assets](/docs/building-assets.md) +- [Changelog](/changelog.md) diff --git a/docs/setting-up-project.md b/docs/setting-up-project.md index 21cd7aa40..b4319ba7a 100644 --- a/docs/setting-up-project.md +++ b/docs/setting-up-project.md @@ -33,4 +33,5 @@ docker-compose exec web vendor/bin/run - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) - [Available tasks](/docs/available-tasks.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) diff --git a/docs/testing-project.md b/docs/testing-project.md index 91eb62002..a67bfb4a7 100644 --- a/docs/testing-project.md +++ b/docs/testing-project.md @@ -190,4 +190,5 @@ Any customization done in your project will be respected in Drone build. - [Using Docker environment](/docs/docker-environment.md) - [Continuous integration](/docs/continuous-integration.md) - [Building assets](/docs/building-assets.md) +- [Update Project Documentation](/docs/project-documentation.md) - [Changelog](/CHANGELOG.md) From 8115daca7914d7bea5b8d14b7b57b56fa2eb4994 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Thu, 18 Aug 2022 11:16:40 +0000 Subject: [PATCH 10/12] DQA-3063: Rebuild documentation. --- docs/project-documentation.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/project-documentation.md b/docs/project-documentation.md index eb027a63b..d51d85573 100644 --- a/docs/project-documentation.md +++ b/docs/project-documentation.md @@ -6,16 +6,15 @@ Use docker to update the documentation locally The Docker image comes with all dependencies pre-installed. To update the documentation run the following command. This will update -the content inside the folder ‘docs/phpdoc’. +the content inside the folder ‘docs’. ``` - docker run --rm -v $(pwd):/data phpdoc/phpdoc run -d ./ -t ./docs/ + docker run --rm -v $(pwd):/data phpdoc/phpdoc run -d ./ -t ./docs ``` -Then push changes to ‘documentation’ branch (only phpdoc generated -files). +Then push the changes generated. ### Other topics - [Available tasks](/docs/available-tasks.md) From 2d153c29bf375f08887832fe7665d651474e8217 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santos?= Date: Fri, 19 Aug 2022 09:21:49 +0200 Subject: [PATCH 11/12] DQA-0000: Update toolkit version. --- src/Toolkit.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Toolkit.php b/src/Toolkit.php index 355b20bbd..3fd4c1c09 100644 --- a/src/Toolkit.php +++ b/src/Toolkit.php @@ -12,7 +12,7 @@ final class Toolkit /** * Constant holding the current version. */ - public const VERSION = '8.6.15'; + public const VERSION = '8.6.17'; /** * Returns the QA base url. From 41b231e7aa42a5266307a595c02e275786a94821 Mon Sep 17 00:00:00 2001 From: Miguel Martins Date: Fri, 19 Aug 2022 11:49:46 +0000 Subject: [PATCH 12/12] DQA-4443: Target hotfix. --- docs/available-tasks.md | 2 +- src/TaskRunner/Commands/ToolCommands.php | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/available-tasks.md b/docs/available-tasks.md index 0f02bda09..5d3898575 100644 --- a/docs/available-tasks.md +++ b/docs/available-tasks.md @@ -41,7 +41,7 @@ Available commands: toolkit:run-phpcbf [tpb] Run PHP code autofixing. toolkit:test-behat [tb] Run Behat tests. toolkit:test-phpcs [tp] Run PHP code review. - toolkit:upgrade-status [tdus] Check project compatibility for Drupal 9/10 upgrade. + toolkit:drupal-upgrade-status [tdus] Check project compatibility for Drupal 9/10 upgrade. ``` diff --git a/src/TaskRunner/Commands/ToolCommands.php b/src/TaskRunner/Commands/ToolCommands.php index babcbcb85..fba316fd9 100644 --- a/src/TaskRunner/Commands/ToolCommands.php +++ b/src/TaskRunner/Commands/ToolCommands.php @@ -728,14 +728,14 @@ public function drupalUpgradeStatus(): int $drushBin = $this->getBin('drush'); $collection = $this->collectionBuilder(); // Require 'drupal/upgrade_status' if does not exist on the project. - if (self::getPackagePropertyFromComposer('drupal/upgrade_status') != false) { + if (self::getPackagePropertyFromComposer('drupal/upgrade_status') == false) { $collection->taskComposerRequire() ->dependency('drupal/upgrade_status', '^3') ->dev() ->run(); } // Require 'drupal/core-dev' if does not exist on the project. - if (self::getPackagePropertyFromComposer('drupal/core-dev') != false) { + if (self::getPackagePropertyFromComposer('drupal/core-dev') == false) { $collection->taskComposerRequire() ->dependency('drupal/core-dev') ->dev() @@ -771,7 +771,7 @@ public function drupalUpgradeStatus(): int } } echo $result . PHP_EOL; - + $drupal_version = self::getPackagePropertyFromComposer('drupal/core'); if ($qaCompatibilityResult) { $this->say('Looks the project need some attention, please check the report above.'); } else {