generateHtmlContent($httpMethod, $resourcePath, $arguments, $response); $filePath = $this->generateFileName(); if ($filePath === null) { return; } if (!is_writable(dirname($filePath))) { throw new \RuntimeException('Cannot write to documentation directory.'); } elseif (file_exists($filePath)) { $fileContent = file_get_contents($filePath); $endHtml = $this->generateHtmlFooter(); $fileContent = str_replace($endHtml, '', $fileContent); $content = "{$fileContent}{$content}"; unlink($filePath); file_put_contents($filePath, $content, FILE_APPEND); } else { file_put_contents($filePath, $content, FILE_APPEND); } } /** * Prepare HTML for the generated documentation. * * @param string $httpMethod * @param string $resourcePath * @param array $arguments * @param array $response * @return string */ protected function generateHtmlContent($httpMethod, $resourcePath, $arguments, $response) { if (empty($arguments)) { $arguments = 'This call does not accept a request body.'; $requestParametersHtml = ''; } else { $requestParameters = $this->retrieveParametersAsHtml($arguments); $arguments = json_encode($arguments, JSON_PRETTY_PRINT); $requestParametersHtml = << Request parameters: HTML; } if (is_array($response)) { $responseArrayKeys = array_keys($response); $responseParameters = "Parameters should be specified manually."; foreach ($responseArrayKeys as $key) { if (!is_int($key)) { $responseParameters = ''; break; } } } if (empty($responseParameters)) { $responseParameters = $this->retrieveParametersAsHtml($response); } $response = json_encode($response, JSON_PRETTY_PRINT); $responseParametersHtml = << Response attributes: HTML; $resourcePath = urldecode($resourcePath); $resource = str_replace('/', '-', preg_replace('#/\w*/V\d+/(.*)#', '${1}', $resourcePath)); $lowerCaseResource = strtolower($resource); $lowerCaseMethod = strtolower($httpMethod); $beginningHtml = <<
HTML; $headingHtml = <<$resource

$httpMethod $resourcePath

Request

HTML; $responseHtml = <<Response HTML; $requestResponseParametersHtml = <<Request and response parameters HTML; $endHtml = $this->generateHtmlFooter(); $content = "{$beginningHtml}{$headingHtml}
{$arguments}
{$responseHtml}
{$response}"
            . "
{$requestResponseParametersHtml}{$requestParametersHtml}{$responseParametersHtml}{$endHtml}"; return $content; } /** * Generate the end html text; * * @return string */ protected function generateHtmlFooter() { $endHtml = <<Response codes
Normal response codes:
  • SUCCESS_CODE - SUCCESS_DESCRIPTION
Error response codes:
  • ERROR_CODE - ERROR_DESCRIPTION
HTML; return $endHtml; } /** * Generate a name of file * * @return string|null * @throws \RuntimeException */ protected function generateFileName() { $varDir = realpath(__DIR__ . '/../../../../../../..') . '/var'; $documentationDir = $varDir . '/log/rest-documentation/'; $debugBackTrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); $pathToFile = $documentationDir; $fileName = null; foreach ($debugBackTrace as $traceItem) { /** Test invocation trace item is the only item which has 3 elements, other trace items have 5 elements */ if (count($traceItem) == 3) { /** Remove 'test' prefix from method name, e.g. testCreate => create */ $fileName = lcfirst(substr($traceItem['function'], 4)); /** Remove 'Test' suffix from test class name */ $pathToFile .= str_replace('\\', '/', substr($traceItem['class'], 0, -4)) . '/'; break; } } if (!file_exists($pathToFile)) { if (!mkdir($pathToFile, 0755, true)) { throw new \RuntimeException('Unable to create missing directory for REST documentation generation'); } } if ($fileName !== null) { $filePath = $pathToFile . $fileName . '.html'; return $filePath; } return null; } /** * Retrieve parameters of response/request * * @param array|string $parameters * @return string */ protected function retrieveParametersAsHtml($parameters) { $parametersAsHtml = ''; if (is_array($parameters)) { foreach (array_keys($parameters) as $parameter) { $parametersAsHtml = $parametersAsHtml . '
  • ' . $parameter . ' (Change type manually!) TBD.
    • '; } } else { $parametersAsHtml = '
  • ' . 'scalar_value' . ' (Change type manually!) TBD.
    • '; } return $parametersAsHtml; } }