HumHub Documentation (unofficial)

Annotation
in package

Simple annotation parser. Take only key-value annotations for methods or class.

Table of Contents

Properties

$currentReflectedItem  : mixed
$lastReflected  : mixed
$reflectedClass  : ReflectionClass
$reflectedClasses  : mixed
$regex  : mixed

Methods

__construct()  : mixed
arrayValue()  : array<string|int, mixed>|mixed|string
Returns an associative array value of annotation Either JSON or Doctrine-annotation style allowed Returns null if not a valid array data
fetch()  : null
fetchAll()  : array<string|int, mixed>
fetchAllAnnotationsFromDocblock()  : array<string|int, mixed>
Fetches all available annotations
fetchAnnotationsFromDocblock()  : array<string|int, mixed>
Parses raw comment for annotations
forClass()  : $this
Grabs annotation values.
forMethod()  : $this
method()  : $this
raw()  : mixed

Properties

$currentReflectedItem

protected mixed $currentReflectedItem

$lastReflected

protected static mixed $lastReflected = null

$reflectedClass

protected ReflectionClass $reflectedClass

$reflectedClasses

protected static mixed $reflectedClasses = []

$regex

protected static mixed $regex = '/@%s(?:[ \t]*(.*?))?[ \t]*(?:\*\/)?\r?$/m'

Methods

__construct()

public __construct(ReflectionClass $class) : mixed
Parameters
$class : ReflectionClass

arrayValue()

Returns an associative array value of annotation Either JSON or Doctrine-annotation style allowed Returns null if not a valid array data

public static arrayValue(mixed $annotation) : array<string|int, mixed>|mixed|string
Parameters
$annotation : mixed
Return values
array<string|int, mixed>|mixed|string

fetch()

public fetch(mixed $annotation) : null
Parameters
$annotation : mixed
Return values
null

fetchAll()

public fetchAll(mixed $annotation) : array<string|int, mixed>
Parameters
$annotation : mixed
Return values
array<string|int, mixed>

fetchAllAnnotationsFromDocblock()

Fetches all available annotations

public static fetchAllAnnotationsFromDocblock(mixed $docblock) : array<string|int, mixed>
Parameters
$docblock : mixed
Return values
array<string|int, mixed>

fetchAnnotationsFromDocblock()

Parses raw comment for annotations

public static fetchAnnotationsFromDocblock(mixed $annotation, mixed $docblock) : array<string|int, mixed>
Parameters
$annotation : mixed
$docblock : mixed
Return values
array<string|int, mixed>

forClass()

Grabs annotation values.

public static forClass(mixed $class) : $this

Usage example:

<?php
Annotation::forClass('MyTestCase')->fetch('guy');
Annotation::forClass('MyTestCase')->method('testData')->fetch('depends');
Annotation::forClass('MyTestCase')->method('testData')->fetchAll('depends');

?>
Parameters
$class : mixed
Return values
$this

forMethod()

public static forMethod(mixed $class, mixed $method) : $this
Parameters
$class : mixed
$method : mixed
Return values
$this

method()

public method(mixed $method) : $this
Parameters
$method : mixed
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results