AnnotationsEngineInterface Interface Reference

Ubiquity\annotations$AnnotationsInterface This class is part of Ubiquity. More...

Inheritance diagram for AnnotationsEngineInterface:

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

Static Public Member Functions
static	isManyToOne (object $annotation)
static	isMany (object $annotation)
static	isOneToMany (object $annotation)
static	isManyToMany (object $annotation)

Detailed Description

Ubiquity\annotations$AnnotationsInterface This class is part of Ubiquity.

Author

jc

Version

1.0.0

Definition at line 12 of file AnnotationsEngineInterface.php.

Member Function Documentation

getAnnotation()

getAnnotation	(	?object	$container,
		string	$key,
		array	$parameters = []
	)

Parameters

NULL | object	$container
string	$key
array	$parameters

Returns

object|NULL

Implemented in AnnotationsEngine, and AttributesEngine.

getAnnotationByKey()

getAnnotationByKey

(

?string

$key = null

)

Parameters

?string

$key

Returns

string|NULL

Implemented in AnnotationsEngine, and AttributesEngine.

getAnnotationsStr()

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

Parameters

array

$annotations

Returns

string

Implemented in AnnotationsEngine, and AttributesEngine.

getAnnotsOfClass()

getAnnotsOfClass	(	string	$class,
		?string	$annotationType = null
	)

Parameters

string	$class
	?string	$annotationType

Returns

array

Implemented in AnnotationsEngine, and AttributesEngine.

getAnnotsOfMethod()

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

Parameters

string	$class
string	$method
	?string	$annotationType

Returns

array

Implemented in AnnotationsEngine, and AttributesEngine.

getAnnotsOfProperty()

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

Parameters

string	$class
string	$property
	?string	$annotationType

Returns

array

Implemented in AnnotationsEngine, and AttributesEngine.

is()

is	(	string	$key,
		object	$annotation
	)

Implemented in AnnotationsEngine, and AttributesEngine.

isMany()

static isMany ( object  $annotation )

static

Implemented in AnnotationsEngine, and AttributesEngine.

isManyToMany()

static isManyToMany ( object  $annotation )

static

Implemented in AnnotationsEngine, and AttributesEngine.

isManyToOne()

static isManyToOne ( object  $annotation )

static

Implemented in AnnotationsEngine, and AttributesEngine.

isOneToMany()

static isOneToMany ( object  $annotation )

static

Implemented in AnnotationsEngine, and AttributesEngine.

registerAcls()

registerAcls

(

)

Implemented in AnnotationsEngine, and AttributesEngine.

registerAnnotations()

registerAnnotations

(

array

$nameClasses

)

Parameters

array

$nameClasses

an array of name=>class annotations

Implemented in AnnotationsEngine, and AttributesEngine.

start()

start

(

string

$cacheDirectory

)

Start the annotations engine for dev mode.

Parameters

string

$cacheDirectory

Implemented in AnnotationsEngine, and AttributesEngine.

---

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

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity/src/Ubiquity/annotations/AnnotationsEngineInterface.php