PHP Piwik\API DocumentationGenerator::checkIfClassCommentContainsHideAnnotation Examples

checkIfClassCommentContainsHideAnnotation() public method

Check if Class contains @hide

public checkIfClassCommentContainsHideAnnotation ( ReflectionClass $rClass ) : boolean
$rClass	ReflectionClass	instance of ReflectionMethod
return	boolean

Example #1

File: DocumentationGeneratorTest.php Project: FluentDevelopment/piwik

 public function test_CheckIfModule_ContainsHideAnnotation()
 {
     $annotation = '@hideExceptForSuperUser test test';
     $mock = $this->getMockBuilder('ReflectionClass')->disableOriginalConstructor()->setMethods(array('getDocComment'))->getMock();
     $mock->expects($this->once())->method('getDocComment')->willReturn($annotation);
     $documentationGenerator = new DocumentationGenerator();
     $this->assertTrue($documentationGenerator->checkIfClassCommentContainsHideAnnotation($mock));
 }