Piwik\API\DocumentationGenerator::addExamples PHP Метод

addExamples() публичный Метод

public addExamples ( $class, $methodName, $prefixUrls )
    public function addExamples($class, $methodName, $prefixUrls)
    {
        $token_auth = "&token_auth=" . Piwik::getCurrentUserTokenAuth();
        $parametersToSet = array('idSite' => Common::getRequestVar('idSite', 1, 'int'), 'period' => Common::getRequestVar('period', 'day', 'string'), 'date' => Common::getRequestVar('date', 'today', 'string'));
        $str = '';
        // 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 = ", RSS of the last <a target='_blank' href='{$exampleUrlRss}&format=rss{$token_auth}&translateColumnNames=1'>10 days</a>";
            }
            $exampleUrl = $prefixUrls . $exampleUrl;
            $str .= " [ Example in\n                                                                    <a target='_blank' href='{$exampleUrl}&format=xml{$token_auth}'>XML</a>,\n                                                                    <a target='_blank' href='{$exampleUrl}&format=JSON{$token_auth}'>Json</a>,\n                                                                    <a target='_blank' href='{$exampleUrl}&format=Tsv{$token_auth}&translateColumnNames=1'>Tsv (Excel)</a>\n                                                                    {$lastNUrls}\n                                                                    ]";
        } else {
            $str .= " [ No example available ]";
        }
        $str .= "</span>";
        return $str;
    }