Piwik\API\DocumentationGenerator::prepareMethodToDisplay PHP Method

prepareMethodToDisplay() public method

public prepareMethodToDisplay ( $moduleName, $info, $methods, $class, $outputExampleUrls, $prefixUrls )
    public function prepareMethodToDisplay($moduleName, $info, $methods, $class, $outputExampleUrls, $prefixUrls)
    {
        $str = '';
        $str .= "\n<a name='{$moduleName}' id='{$moduleName}'></a><div piwik-content-block content-title='Module " . $moduleName . "'>";
        $info['__documentation'] = $this->checkDocumentation($info['__documentation']);
        $str .= "<div class='apiDescription'> " . $info['__documentation'] . " </div>";
        foreach ($methods as $methodName) {
            if (Proxy::getInstance()->isDeprecatedMethod($class, $methodName)) {
                continue;
            }
            $params = $this->getParametersString($class, $methodName);
            $str .= "\n <div class='apiMethod'>- <b>{$moduleName}.{$methodName} </b>" . $params . "";
            $str .= '<small>';
            if ($outputExampleUrls) {
                $str .= $this->addExamples($class, $methodName, $prefixUrls);
            }
            $str .= '</small>';
            $str .= "</div>\n";
        }
        return $str . "</div>";
    }