From 70f9d3c596ad0369178d890dac3a73f0bf329b45 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Thu, 1 Nov 2018 12:43:34 +0100 Subject: [PATCH] documentation --- tests/Util/RendererMockTrait.php | 15 +++++++++++++++ .../Console/AutomaticInstallationConsoleTest.php | 7 +++++++ 2 files changed, 22 insertions(+) diff --git a/tests/Util/RendererMockTrait.php b/tests/Util/RendererMockTrait.php index 1fe3bd97dc..b12327f49c 100644 --- a/tests/Util/RendererMockTrait.php +++ b/tests/Util/RendererMockTrait.php @@ -18,6 +18,13 @@ trait RendererMockTrait */ private $rendererMock; + /** + * Mocking the method 'Renderer::getMarkupTemplate()' + * + * @param string $templateName The name of the template which should get + * @param string $return the return value of the mock (should be defined to have it later for followUp use) + * @param null|int $times How often the method will get used + */ public function mockGetMarkupTemplate($templateName, $return = '', $times = null) { if (!isset($this->rendererMock)) { @@ -31,6 +38,14 @@ trait RendererMockTrait ->andReturn($return); } + /** + * Mocking the method 'Renderer::replaceMacros()' + * + * @param string $template The template to use (normally, it is the mock result of 'mockGetMarkupTemplate()' + * @param array $args The arguments to pass to the macro + * @param string $return the return value of the mock + * @param null|int $times How often the method will get used + */ public function mockReplaceMacros($template, $args = [], $return = '', $times = null) { if (!isset($this->rendererMock)) { diff --git a/tests/src/Core/Console/AutomaticInstallationConsoleTest.php b/tests/src/Core/Console/AutomaticInstallationConsoleTest.php index 9882bf37e8..d8f78b483f 100644 --- a/tests/src/Core/Console/AutomaticInstallationConsoleTest.php +++ b/tests/src/Core/Console/AutomaticInstallationConsoleTest.php @@ -53,6 +53,13 @@ class AutomaticInstallationConsoleTest extends ConsoleTest $this->mockConfigGet('config', 'php_path', false); } + /** + * Creates the arguments which is asserted to be passed to 'replaceMacros()' for creating the local.ini.php + * + * @param bool $withDb if true, DB will get saved too + * + * @return array The arguments to pass to the mock for 'replaceMacros()' + */ private function createArgumentsForMacro($withDb) { $args = [