app, $request, $response); $view->setTemplate('/Modules/Help/Theme/Backend/help'); return $view; } /** * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface { $view = new View($this->app, $request, $response); $path = $this->getHelpGeneralPath($request); $toParse = \file_get_contents($path); $summary = \file_get_contents(__DIR__ . '/../../../Documentation/SUMMARY.md'); $content = Markdown::parse($toParse === false ? '' : $toParse); $navigation = Markdown::parse($summary === false ? '' : $summary); $view->setTemplate('/Modules/Help/Theme/Backend/help-general'); $view->setData('content', $content); $view->setData('navigation', $navigation); return $view; } /** * Create markdown parsing path * * @param RequestAbstract $request Request * * @return string * * @since 1.0.0 * @codeCoverageIgnore */ private function getHelpGeneralPath(RequestAbstract $request) : string { if ($request->getData('page') === 'README' || $request->getData('page') === null) { $path = \realpath(__DIR__ . '/../../../Documentation/README.md'); } else { $path = \realpath(__DIR__ . '/../../../Documentation/' . $request->getData('page') . '.md'); } if ($path === false) { $path = \realpath(__DIR__ . '/../../../Documentation/README.md'); } return $path === false ? '' : $path; } /** * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpModuleList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface { $view = new View($this->app, $request, $response); $view->setTemplate('/Modules/Help/Theme/Backend/help-module-list'); return $view; } /** * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface { $active = $this->app->moduleManager->getActiveModules(); if ($request->getData('id') === null || !isset($active[$request->getData('id')])) { return $this->viewHelpModuleList($request, $response, $data); } $view = new View($this->app, $request, $response); $path = $this->getHelpModulePath($request); $toParse = \file_get_contents($path); $summary = \file_get_contents(__DIR__ . '/../../' . $request->getData('id') . '/Docs/Help/en/SUMMARY.md'); $content = Markdown::parse($toParse === false ? '' : $toParse); $navigation = Markdown::parse($summary === false ? '' : $summary); $view->setTemplate('/Modules/Help/Theme/Backend/help-module'); $view->setData('content', $content); $view->setData('navigation', $navigation); return $view; } /** * Create markdown parsing path * * @param RequestAbstract $request Request * * @return string * * @since 1.0.0 * @codeCoverageIgnore */ private function getHelpModulePath(RequestAbstract $request) : string { if ($request->getData('page') === 'table-of-contencts' || $request->getData('page') === null) { $path = \realpath(__DIR__ . '/../../' . $request->getData('id') . '/Docs/introduction.md'); } else { $path = \realpath(__DIR__ . '/../../' . $request->getData('id') . '/Docs/Help/en/' . $request->getData('page') . '.md'); } if ($path === false) { $path = \realpath(__DIR__ . '/../../' . $request->getData('id') . '/Docs/introduction.md'); } return $path === false ? '' : $path; } /** * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface { $view = new View($this->app, $request, $response); $path = $this->getHelpDeveloperPath($request); $toParse = \file_get_contents($path); $summary = \file_get_contents(__DIR__ . '/../../../Developer-Guide/SUMMARY.md'); $content = Markdown::parse($toParse === false ? '' : $toParse); $navigation = Markdown::parse($summary === false ? '' : $summary); $view->setTemplate('/Modules/Help/Theme/Backend/help-developer'); $view->setData('content', $content); $view->setData('navigation', $navigation); return $view; } /** * Create markdown parsing path * * @param RequestAbstract $request Request * * @return string * * @since 1.0.0 * @codeCoverageIgnore */ private function getHelpDeveloperPath(RequestAbstract $request) : string { if ($request->getData('page') === 'README' || $request->getData('page') === null) { $path = \realpath(__DIR__ . '/../../../Developer-Guide/README.md'); } else { $path = \realpath(__DIR__ . '/../../../Developer-Guide/' . $request->getData('page') . '.md'); } if ($path === false) { $path = \realpath(__DIR__ . '/../../../Developer-Guide/README.md'); } return $path === false ? '' : $path; } }