Phalcon Annotations

Annotations\Adapter\AbstractAdapter

This is the base class for Phalcon\Annotations adapters

Uses Phalcon\Annotations\Collection · Phalcon\Annotations\Exception · Phalcon\Annotations\Reader · Phalcon\Annotations\ReaderInterface · Phalcon\Annotations\Reflection

Method Summary

Properties

Methods

get()

public function get( mixed $className ): Reflection;

Parses or retrieves all the annotations found in a class

getAnnotationsLimit()

public function getAnnotationsLimit(): int;

Returns the configured annotations-cache cap (0 = unlimited). See setAnnotationsLimit().

getConstant()

public function getConstant(
    string $className,
    string $constantName
): Collection;

Returns the annotations found in a specific constant

getConstants()

public function getConstants( string $className ): array;

Returns the annotations found in all the class’ constants

getMethod()

public function getMethod(
    string $className,
    string $methodName
): Collection;

Returns the annotations found in a specific method

getMethods()

public function getMethods( string $className ): array;

Returns the annotations found in all the class’ methods

getProperties()

public function getProperties( string $className ): array;

Returns the annotations found in all the class’ properties

getProperty()

public function getProperty(
    string $className,
    string $propertyName
): Collection;

Returns the annotations found in a specific property

getReader()

public function getReader(): ReaderInterface;

Returns the annotation reader

setAnnotationsLimit()

public function setAnnotationsLimit( int $annotationsLimit );

Caps the number of class entries retained in the annotations cache. 0 disables the cap (the default; preserves the original unbounded behavior). When the cap is exceeded, the cache is cleared and repopulated on subsequent reads.

setReader()

public function setReader( ReaderInterface $reader );

Sets the annotations parser

Annotations\Adapter\AdapterInterface

This interface must be implemented by adapters in Phalcon\Annotations

Uses Phalcon\Annotations\Collection · Phalcon\Annotations\ReaderInterface · Phalcon\Annotations\Reflection

Method Summary

Methods

get()

public function get( string $className ): Reflection;

Parses or retrieves all the annotations found in a class

getConstant()

public function getConstant(
    string $className,
    string $constantName
): Collection;

Returns the annotations found in a specific constant

getConstants()

public function getConstants( string $className ): array;

Returns the annotations found in all the class’ constants

getMethod()

public function getMethod(
    string $className,
    string $methodName
): Collection;

Returns the annotations found in a specific method

getMethods()

public function getMethods( string $className ): array;

Returns the annotations found in all the class’ methods

getProperties()

public function getProperties( string $className ): array;

Returns the annotations found in all the class’ methods

getProperty()

public function getProperty(
    string $className,
    string $propertyName
): Collection;

Returns the annotations found in a specific property

getReader()

public function getReader(): ReaderInterface;

Returns the annotation reader

setReader()

public function setReader( ReaderInterface $reader );

Sets the annotations parser

Annotations\Adapter\Apcu

Stores the parsed annotations in APCu. This adapter is suitable for production

use Phalcon\Annotations\Adapter\Apcu;

$annotations = new Apcu();

Uses Phalcon\Annotations\Reflection

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Phalcon\Annotations\Adapter\Apcu constructor

read()

public function read( string $key ): Reflection|bool;

Reads parsed annotations from APCu

write()

public function write(
    string $key,
    Reflection $data
): bool;

Writes parsed annotations to APCu

Annotations\Adapter\Memory

Stores the parsed annotations in memory. This adapter is the suitable development/testing

Uses Phalcon\Annotations\Reflection

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

read()

public function read( string $key ): Reflection|bool;

Reads parsed annotations from memory

write()

public function write(
    string $key,
    Reflection $data
): void;

Writes parsed annotations to memory

Annotations\Adapter\Stream

Stores the parsed annotations in files. This adapter is suitable for production

use Phalcon\Annotations\Adapter\Stream;

$annotations = new Stream(
    [
        "annotationsDir" => "app/cache/annotations/",
    ]
);

Uses Phalcon\Annotations\Exception · Phalcon\Annotations\Exceptions\AnnotationsDirectoryNotWritable · Phalcon\Annotations\Exceptions\CannotReadAnnotationData · Phalcon\Annotations\Reflection · Phalcon\Traits\Php\FileTrait · RuntimeException

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Phalcon\Annotations\Adapter\Stream constructor

read()

public function read( string $key ): Reflection|bool|int;

Reads parsed annotations from files

write()

public function write(
    string $key,
    Reflection $data
): void;

Writes parsed annotations to files

Annotations\Annotation

Represents a single annotation in an annotations collection

Uses Phalcon\Annotations\Exceptions\UnknownAnnotationExpression

Method Summary

Properties

Methods

__construct()

public function __construct( array $reflectionData );

Phalcon\Annotations\Annotation constructor

getArgument()

public function getArgument( mixed $position ): mixed|null;

Returns an argument in a specific position

getArguments()

public function getArguments(): array;

Returns the expression arguments

getExprArguments()

public function getExprArguments(): array;

Returns the expression arguments without resolving

getExpression()

public function getExpression( array $expr ): mixed;

Resolves an annotation expression

getName()

public function getName(): null|string;

Returns the annotation’s name

getNamedArgument()

public function getNamedArgument( string $name ): mixed|null;

Returns a named argument

getNamedParameter()

public function getNamedParameter( string $name ): mixed;

Returns a named parameter

hasArgument()

public function hasArgument( mixed $position ): bool;

Returns an argument in a specific position

numberArguments()

public function numberArguments(): int;

Returns the number of arguments that the annotation has

Annotations\AnnotationsFactory

Factory to create annotations components

Uses Phalcon\Annotations\Adapter\AdapterInterface · Phalcon\Annotations\Adapter\Apcu · Phalcon\Annotations\Adapter\Memory · Phalcon\Annotations\Adapter\Stream · Phalcon\Factory\AbstractFactory · Phalcon\Traits\Support\Helper\Arr\GetTrait

Method Summary

Methods

__construct()

public function __construct( array $services = [] );

AdapterFactory constructor.

load()

public function load( mixed $config ): mixed;

Factory to create an instance from a Config object

newInstance()

public function newInstance(
    string $name,
    array $options = []
): AdapterInterface;

Create a new instance of the adapter

getExceptionClass()

protected function getExceptionClass(): string;

getServices()

protected function getServices(): array;

Returns the available adapters

Annotations\Collection

Represents a collection of annotations. This class allows to traverse a group of annotations easily

// Traverse annotations
foreach ($classAnnotations as $annotation) {
    echo "Name=", $annotation->getName(), PHP_EOL;
}

// Check if the annotations has a specific
var_dump($classAnnotations->has("Cacheable"));

// Get an specific annotation in the collection
$annotation = $classAnnotations->get("Cacheable");

Uses Countable · Iterator · Phalcon\Annotations\Exceptions\AnnotationNotFound

Method Summary

Properties

Methods

__construct()

public function __construct( array $reflectionData = [] );

Phalcon\Annotations\Collection constructor

count()

public function count(): int;

Returns the number of annotations in the collection

current()

public function current(): mixed;

Returns the current annotation in the iterator

get()

public function get( string $name ): Annotation;

Returns the first annotation that match a name

getAll()

public function getAll( string $name ): Annotation[];

Returns all the annotations that match a name

getAnnotations()

public function getAnnotations(): Annotation[];

Returns the internal annotations as an array

has()

public function has( string $name ): bool;

Check if an annotation exists in a collection

key()

public function key(): int;

Returns the current position/key in the iterator

next()

public function next(): void;

Moves the internal iteration pointer to the next position

rewind()

public function rewind(): void;

Rewinds the internal iterator

valid()

public function valid(): bool;

Check if the current annotation in the iterator is valid

Annotations\Exception

Class for exceptions thrown by Phalcon\Annotations

Annotations\Exceptions\AnnotationNotFound

Uses Phalcon\Annotations\Exception

Method Summary

Methods

__construct()

public function __construct( string $name );

Annotations\Exceptions\AnnotationsDirectoryNotWritable

Uses Phalcon\Annotations\Exception

Method Summary

Methods

__construct()

public function __construct();

Annotations\Exceptions\CannotReadAnnotationData

Uses RuntimeException

Method Summary

Methods

__construct()

public function __construct();

Annotations\Exceptions\UnknownAnnotationExpression

Uses Phalcon\Annotations\Exception

Method Summary

Methods

__construct()

public function __construct( string $type );

Annotations\Reader

Parses docblocks returning an array with the found annotations

Uses ReflectionClass

Method Summary

Methods

parse()

public function parse( string $className ): array;

Reads annotations from the class docblocks, its methods and/or properties

parseDocBlock()

public static function parseDocBlock(
    string $docBlock,
    mixed $file = null,
    mixed $line = null
): array;

Parses a raw doc block returning the annotations found

Annotations\ReaderInterface

Parses docblocks returning an array with the found annotations

Method Summary

Methods

parse()

public function parse( string $className ): array;

Reads annotations from the class docblocks, its constants, properties and methods

parseDocBlock()

public static function parseDocBlock(
    string $docBlock,
    mixed $file = null,
    mixed $line = null
): array;

Parses a raw docblock returning the annotations found

Annotations\Reflection

Allows to manipulate the annotations reflection in an OO manner

use Phalcon\Annotations\Reader;
use Phalcon\Annotations\Reflection;

// Parse the annotations in a class
$reader = new Reader();
$parsing = $reader->parse("MyComponent");

// Create the reflection
$reflection = new Reflection($parsing);

// Get the annotations in the class docblock
$classAnnotations = $reflection->getClassAnnotations();

Method Summary

Properties

Methods

__construct()

public function __construct( array $reflectionData = [] );

getClassAnnotations()

public function getClassAnnotations(): Collection|null;

Returns the annotations found in the class docblock

getConstantsAnnotations()

public function getConstantsAnnotations(): Collection[];

Returns the annotations found in the constants’ docblocks

getMethodsAnnotations()

public function getMethodsAnnotations(): Collection[];

Returns the annotations found in the methods’ docblocks

getPropertiesAnnotations()

public function getPropertiesAnnotations(): Collection[];

Returns the annotations found in the properties’ docblocks

getReflectionData()

public function getReflectionData(): array;

Returns the raw parsing intermediate definitions used to construct the reflection