Piwik\API\DocumentationGenerator::getMethodString PHP Method

getMethodString() private method

private getMethodString ( $moduleName, $class, $parametersToSet, $outputExampleUrls, $prefixUrls, $methodName )
    private function getMethodString($moduleName, $class, $parametersToSet, $outputExampleUrls, $prefixUrls, $methodName)
    {
        $str = '';
        $token_auth = "&token_auth=" . Piwik::getCurrentUserTokenAuth();
        $params = $this->getParametersString($class, $methodName);
        $str .= "\n <div class='apiMethod'>- <b>{$moduleName}.{$methodName} </b>" . $params . "";
        $str .= '<small>';
        if ($outputExampleUrls) {
            // we prefix all URLs with $prefixUrls
            // used when we include this output in the Piwik official documentation for example
            $str .= "<span class=\"example\">";
            $exampleUrl = $this->getExampleUrl($class, $methodName, $parametersToSet);
            if ($exampleUrl !== false) {
                $lastNUrls = '';
                if (preg_match('/(&period)|(&date)/', $exampleUrl)) {
                    $exampleUrlRss = $prefixUrls . $this->getExampleUrl($class, $methodName, array('date' => 'last10', 'period' => 'day') + $parametersToSet);
                    $lastNUrls = ",\tRSS of the last <a target='_blank' href='{$exampleUrlRss}&format=rss{$token_auth}&translateColumnNames=1'>10 days</a>";
                }
                $exampleUrl = $prefixUrls . $exampleUrl;
                $str .= " [ Example in\n\t\t\t\t\t\t\t\t\t<a target='_blank' href='{$exampleUrl}&format=xml{$token_auth}'>XML</a>,\n\t\t\t\t\t\t\t\t\t<a target='_blank' href='{$exampleUrl}&format=JSON{$token_auth}'>Json</a>,\n\t\t\t\t\t\t\t\t\t<a target='_blank' href='{$exampleUrl}&format=Tsv{$token_auth}&translateColumnNames=1'>Tsv (Excel)</a>\n\t\t\t\t\t\t\t\t\t{$lastNUrls}\n\t\t\t\t\t\t\t\t\t]";
            } else {
                $str .= " [ No example available ]";
            }
            $str .= "</span>";
        }
        $str .= '</small>';
        $str .= "</div>\n";
        return $str;
    }