Ubiquity 2.5.2
php rapid development framework
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
AnnotationsEngine Class Reference
+ Inheritance diagram for AnnotationsEngine:

Public Member Functions

 start (string $cacheDirectory)
 Start the annotations engine for dev mode.
 
 registerAnnotations (array $nameClasses)
 
 getAnnotsOfClass (string $class, ?string $annotationType=null)
 
 getAnnotationByKey (?string $key=null)
 
 getAnnotsOfProperty (string $class, string $property, ?string $annotationType=null)
 
 getAnnotsOfMethod (string $class, string $method, ?string $annotationType=null)
 
 getAnnotation (?object $container, string $key, array $parameters=[])
 
 getAnnotationsStr (array $annotations, string $prefix="\t")
 
 is (string $key, object $annotation)
 
 getUses ()
 
 registerAcls ()
 

Static Public Member Functions

static isManyToOne (object $annotation)
 
static isMany (object $annotation)
 
static isOneToMany (object $annotation)
 
static isManyToMany (object $annotation)
 

Protected Member Functions

 register (AnnotationManager $annotationManager)
 

Static Protected Attributes

static $registry
 

Detailed Description

Definition at line 11 of file AnnotationsEngine.php.

Member Function Documentation

◆ getAnnotation()

getAnnotation ( ?object  $container,
string  $key,
array  $parameters = [] 
)
Parameters
NULL | object$container
string$key
array$parameters
Returns
object|NULL

Implements AnnotationsEngineInterface.

Definition at line 92 of file AnnotationsEngine.php.

◆ getAnnotationByKey()

getAnnotationByKey ( ?string  $key = null)
Parameters
?string$key
Returns
string|NULL

Implements AnnotationsEngineInterface.

Definition at line 75 of file AnnotationsEngine.php.

◆ getAnnotationsStr()

getAnnotationsStr ( array  $annotations,
string  $prefix = "\t" 
)
Parameters
array$annotations
Returns
string

Implements AnnotationsEngineInterface.

Definition at line 102 of file AnnotationsEngine.php.

◆ getAnnotsOfClass()

getAnnotsOfClass ( string  $class,
?string  $annotationType = null 
)
Parameters
string$class
?string$annotationType
Returns
array

Implements AnnotationsEngineInterface.

Definition at line 71 of file AnnotationsEngine.php.

◆ getAnnotsOfMethod()

getAnnotsOfMethod ( string  $class,
string  $method,
?string  $annotationType = null 
)
Parameters
string$class
string$method
?string$annotationType
Returns
array

Implements AnnotationsEngineInterface.

Definition at line 88 of file AnnotationsEngine.php.

◆ getAnnotsOfProperty()

getAnnotsOfProperty ( string  $class,
string  $property,
?string  $annotationType = null 
)
Parameters
string$class
string$property
?string$annotationType
Returns
array

Implements AnnotationsEngineInterface.

Definition at line 84 of file AnnotationsEngine.php.

◆ getUses()

getUses ( )

Definition at line 145 of file AnnotationsEngine.php.

◆ is()

is ( string  $key,
object  $annotation 
)

Implements AnnotationsEngineInterface.

Definition at line 137 of file AnnotationsEngine.php.

◆ isMany()

static isMany ( object  $annotation)
static

Implements AnnotationsEngineInterface.

Definition at line 125 of file AnnotationsEngine.php.

◆ isManyToMany()

static isManyToMany ( object  $annotation)
static

Implements AnnotationsEngineInterface.

Definition at line 133 of file AnnotationsEngine.php.

◆ isManyToOne()

static isManyToOne ( object  $annotation)
static

Implements AnnotationsEngineInterface.

Definition at line 121 of file AnnotationsEngine.php.

◆ isOneToMany()

static isOneToMany ( object  $annotation)
static

Implements AnnotationsEngineInterface.

Definition at line 129 of file AnnotationsEngine.php.

◆ register()

register ( AnnotationManager  $annotationManager)
protected

Definition at line 67 of file AnnotationsEngine.php.

◆ registerAcls()

registerAcls ( )

Implements AnnotationsEngineInterface.

Definition at line 149 of file AnnotationsEngine.php.

◆ registerAnnotations()

registerAnnotations ( array  $nameClasses)
Parameters
array$nameClassesan array of name=>class annotations

Implements AnnotationsEngineInterface.

Definition at line 59 of file AnnotationsEngine.php.

◆ start()

start ( string  $cacheDirectory)

Start the annotations engine for dev mode.

Parameters
string$cacheDirectory

Implements AnnotationsEngineInterface.

Definition at line 19 of file AnnotationsEngine.php.

Field Documentation

◆ $registry

$registry
staticprotected

Definition at line 17 of file AnnotationsEngine.php.

The documentation for this class was generated from the following file: