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

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

Check if documentation contains @hide annotation and deletes it
public checkDocumentation ( $moduleToCheck ) : mixed
$moduleToCheck
Результат mixed
    public function checkDocumentation($moduleToCheck)
    {
        if (strpos($moduleToCheck, '@hide') == true) {
            $moduleToCheck = str_replace(strtok(strstr($moduleToCheck, '@hide'), "\n"), "", $moduleToCheck);
        }
        return $moduleToCheck;
    }

Usage Example

 public function test_CheckDocumentation()
 {
     $moduleToCheck = 'this is documentation which contains @hideExceptForSuperUser';
     $documentationAfterCheck = 'this is documentation which contains ';
     $documentationGenerator = new DocumentationGenerator();
     $this->assertEquals($documentationGenerator->checkDocumentation($moduleToCheck), $documentationAfterCheck);
 }