Basicis - Core

Logo

As the name says, it is made to be basic and direct.

View the Project on GitHub basicis/core

Basicis\Core\Annotations

Annotations Class Describes a Annotations instance, and works with the comment blocks

Methods

Name Description
__construct Function __construct
Receives a class as an argument, and works with the comment blocks  
getClass Function getClass
Getting a annotations ReflectionClass  
getClassCommentByTag Function getCommentByTag
Get a documentation bloc line by any tag, and return this line  
getMethod Function getMethod
Getting a annotations ReflectionMethod  
getMethodCommentByTag Function getCommentByTag
Get a documentation bloc line by any tag, and return this line  
setClass Function setClass
Setting class for extract annotations  
setMethod Function setMethod
Setting a method into a instance of ReflectionClass for extract annotations  

Annotations::__construct

Description

public __construct (string $class)

Function __construct Receives a class as an argument, and works with the comment blocks

Parameters

Return Values

void


Annotations::getClass

Description

public getClass (void)

Function getClass Getting a annotations ReflectionClass

Parameters

This function has no parameters.

Return Values

\ReflectionClass|null


Annotations::getClassCommentByTag

Description

public getClassCommentByTag (string $method, string $tag, int $index)

Function getCommentByTag Get a documentation bloc line by any tag, and return this line

Parameters

Return Values

string|null


Annotations::getMethod

Description

public getMethod (void)

Function getMethod Getting a annotations ReflectionMethod

Parameters

This function has no parameters.

Return Values

\ReflectionMethod|null


Annotations::getMethodCommentByTag

Description

public getMethodCommentByTag (string $method, string $tag, int $index)

Function getCommentByTag Get a documentation bloc line by any tag, and return this line

Parameters

Return Values

string|null


Annotations::setClass

Description

public setClass (string $class)

Function setClass Setting class for extract annotations

Parameters

Return Values

\Annotations


Annotations::setMethod

Description

public setMethod (string $method)

Function setMethod Setting a method into a instance of ReflectionClass for extract annotations

Parameters

Return Values

\Annotations