---
title: "Phalcon Annotations"
version: "6.0"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Annotations
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Annotations\AdapterFactory
Class
Factory to create Annotations adapters
@property SerializerFactory $serializerFactory
- [`Phalcon\Factory\AbstractConfigFactory`](/6.0/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/6.0/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Annotations\AdapterFactory`**
`Exception` · `Phalcon\Annotations\Adapter\AdapterInterface` · `Phalcon\Annotations\Adapter\Apcu` · `Phalcon\Annotations\Adapter\Libmemcached` · `Phalcon\Annotations\Adapter\Memory` · `Phalcon\Annotations\Adapter\Redis` · `Phalcon\Annotations\Adapter\Stream` · `Phalcon\Annotations\Adapter\Weak` · `Phalcon\Annotations\Parser\Exception` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Storage\SerializerFactory`
### Method Summary
AdapterFactory constructor.
Create a new instance of the adapter
Returns the available adapters
### Methods
__construct()
```php
public function __construct(
SerializerFactory $factory,
array $services = []
);
```
AdapterFactory constructor.
newInstance()
```php
public function newInstance(
string $name,
array $options = []
): AdapterInterface;
```
Create a new instance of the adapter
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Annotations\Adapter\AdapterInterface
Interface
This interface must be implemented by adapters in Phalcon\Components\Attributes
- [`Phalcon\Storage\Adapter\AdapterInterface`](/6.0/api/phalcon_storage/#storageadapteradapterinterface)
- **`Phalcon\Annotations\Adapter\AdapterInterface`**
`Phalcon\Storage\Adapter\AdapterInterface`
## Annotations\Adapter\Apcu
Class
Stores the parsed annotations in apcu.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/6.0/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Apcu`](/6.0/api/phalcon_storage/#storageadapterapcu)
- **`Phalcon\Annotations\Adapter\Apcu`** - implements [`Phalcon\Annotations\Adapter\AdapterInterface`](#annotationsadapteradapterinterface)
`Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\Apcu`
### Method Summary
### Methods
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
## Annotations\Adapter\Libmemcached
Class
Stores the parsed annotations in memory. This adapter is the suitable
development/testing
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/6.0/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Libmemcached`](/6.0/api/phalcon_storage/#storageadapterlibmemcached)
- **`Phalcon\Annotations\Adapter\Libmemcached`** - implements [`Phalcon\Annotations\Adapter\AdapterInterface`](#annotationsadapteradapterinterface)
`Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\Libmemcached`
### Method Summary
### Methods
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
## Annotations\Adapter\Memory
Class
Stores the parsed annotations in memory. This adapter is the suitable
development/testing
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/6.0/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Memory`](/6.0/api/phalcon_storage/#storageadaptermemory)
- **`Phalcon\Annotations\Adapter\Memory`** - implements [`Phalcon\Annotations\Adapter\AdapterInterface`](#annotationsadapteradapterinterface)
`Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\Memory`
### Method Summary
### Methods
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
## Annotations\Adapter\Redis
Class
Stores the parsed annotations in redis.
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/6.0/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Redis`](/6.0/api/phalcon_storage/#storageadapterredis)
- **`Phalcon\Annotations\Adapter\Redis`** - implements [`Phalcon\Annotations\Adapter\AdapterInterface`](#annotationsadapteradapterinterface)
`Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\Redis`
### Method Summary
### Methods
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
## Annotations\Adapter\Stream
Class
Stores the parsed annotations in memory. This adapter is the suitable
development/testing
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/6.0/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Stream`](/6.0/api/phalcon_storage/#storageadapterstream)
- **`Phalcon\Annotations\Adapter\Stream`** - implements [`Phalcon\Annotations\Adapter\AdapterInterface`](#annotationsadapteradapterinterface)
`Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\Stream`
### Method Summary
### Methods
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
## Annotations\Adapter\Weak
Class
Stores the parsed annotations in memory. This adapter is the suitable
development/testing
- [`Phalcon\Storage\Adapter\AbstractAdapter`](/6.0/api/phalcon_storage/#storageadapterabstractadapter)
- [`Phalcon\Storage\Adapter\Weak`](/6.0/api/phalcon_storage/#storageadapterweak)
- **`Phalcon\Annotations\Adapter\Weak`** - implements [`Phalcon\Annotations\Adapter\AdapterInterface`](#annotationsadapteradapterinterface)
`Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\Weak`
### Method Summary
### Methods
get()
```php
public function get(
string $key,
mixed $defaultValue = null
): mixed;
```
## Annotations\Annotations
Class
- **`Phalcon\Annotations\Annotations`**
`Phalcon\Annotations\Parser\Collection` · `Phalcon\Annotations\Parser\Reader` · `Phalcon\Annotations\Parser\ReaderInterface` · `Phalcon\Annotations\Parser\Reflection` · `Phalcon\Storage\Adapter\AdapterInterface`
### Method Summary
Parses or retrieves all the attributes found in a class
Returns the attributes found in a specific constant
Returns the attributes found in all the class' constants
Returns the attributes found in a specific method
Returns the attributes found in all the class' methods
Returns the attributes found in all the class' properties
Returns the attributes found in a specific property
Returns the annotation reader
Reads parsed annotations from memory
Sets the attributes parser
Writes parsed annotations to memory
### Constants
### Properties
### Methods
__construct()
```php
public function __construct( AdapterInterface $adapter );
```
get()
```php
public function get( mixed $className ): Reflection;
```
Parses or retrieves all the attributes found in a class
getConstant()
```php
public function getConstant(
string $className,
string $constantName
): Collection;
```
Returns the attributes found in a specific constant
getConstants()
```php
public function getConstants( string $className ): array;
```
Returns the attributes found in all the class' constants
getMethod()
```php
public function getMethod(
string $className,
string $methodName
): Collection;
```
Returns the attributes found in a specific method
getMethods()
```php
public function getMethods( string $className ): array;
```
Returns the attributes found in all the class' methods
getProperties()
```php
public function getProperties( string $className ): array;
```
Returns the attributes found in all the class' properties
getProperty()
```php
public function getProperty(
string $className,
string $propertyName
): Collection;
```
Returns the attributes found in a specific property
getReader()
```php
public function getReader(): ReaderInterface;
```
Returns the annotation reader
read()
```php
public function read( string $key ): bool|Reflection;
```
Reads parsed annotations from memory
setReader()
```php
public function setReader( ReaderInterface $reader ): void;
```
Sets the attributes parser
write()
```php
public function write(
string $key,
Reflection $data
): bool;
```
Writes parsed annotations to memory
## Annotations\Models\MetaData\Column
Class
- **`Phalcon\Annotations\Models\MetaData\Column`**
`Attribute`
### Method Summary
### Properties
### Methods
```php
public function __construct(
string|null $column = null,
string $type = "string",
int|null $length = null,
bool $nullable = false,
bool $skipOnInsert = false,
bool $skipOnUpdate = false,
bool $allowEmptyString = false,
mixed $default = null
);
```
## Annotations\Models\MetaData\Identity
Class
- **`Phalcon\Annotations\Models\MetaData\Identity`**
`Attribute`
## Annotations\Models\MetaData\Primary
Class
- **`Phalcon\Annotations\Models\MetaData\Primary`**
`Attribute`
## Annotations\Models\MetaData\Source
Class
- **`Phalcon\Annotations\Models\MetaData\Source`**
`Attribute`
### Method Summary
### Properties
### Methods
```php
public function __construct( string $table );
```
## Annotations\Parser\Annotation
Class
Represents a single attribute in an attributes collection
- **`Phalcon\Annotations\Parser\Annotation`**
`ReflectionAttribute`
### Method Summary
Constructor
Returns an argument in a specific position
Returns the expression arguments
Returns the attribute's base name
Returns the attribute's name
Returns a named argument
Returns a named parameter
Returns an argument in a specific position
Returns the number of arguments that the attribute has
### Properties
Attribute Arguments
Attribute Name
### Methods
__construct()
```php
public function __construct( ReflectionAttribute $reflectionData );
```
Constructor
getArgument()
```php
public function getArgument( int|string $position ): mixed;
```
Returns an argument in a specific position
getArguments()
```php
public function getArguments(): array;
```
Returns the expression arguments
getCleanName()
```php
public function getCleanName(): string;
```
Returns the attribute's base name
getName()
```php
public function getName(): string;
```
Returns the attribute's name
getNamedArgument()
```php
public function getNamedArgument( string $name ): mixed;
```
Returns a named argument
getNamedParameter()
```php
public function getNamedParameter( string $name ): mixed;
```
Returns a named parameter
hasArgument()
```php
public function hasArgument( int|string $position ): bool;
```
Returns an argument in a specific position
numberArguments()
```php
public function numberArguments(): int;
```
Returns the number of arguments that the attribute has
## Annotations\Parser\Collection
Class
Represents a collection of annotations. This class allows to traverse a group
of annotations easily
```php
// 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");
@template TKey of int
@template TValue of Annotation
```
- **`Phalcon\Annotations\Parser\Collection`** - implements `\IteratorAggregate`
`ArrayIterator` · `IteratorAggregate` · `Traversable`
### Method Summary
Constructor
Returns the first annotation that match a name
Returns all the annotations that match a name
Check if an annotation exists in a collection
### Properties
### Methods
__construct()
```php
public function __construct( array $reflectionData = [] );
```
Constructor
get()
```php
public function get( string $name ): Annotation;
```
Returns the first annotation that match a name
getAll()
```php
public function getAll( string $name ): array;
```
Returns all the annotations that match a name
getAnnotations()
```php
public function getAnnotations(): Traversable;
```
getIterator()
```php
public function getIterator(): Traversable;
```
has()
```php
public function has( string $name ): bool;
```
Check if an annotation exists in a collection
## Annotations\Parser\Exception
Class
Class for exceptions thrown by Phalcon\Annotations
- `\Exception`
- **`Phalcon\Annotations\Parser\Exception`**
## Annotations\Parser\Reader
Class
Parses classes returning an array with the found annotations
- **`Phalcon\Annotations\Parser\Reader`** - implements [`Phalcon\Annotations\Parser\ReaderInterface`](#annotationsparserreaderinterface)
`ReflectionClass` · `ReflectionException`
### Method Summary
Reads annotations from the class, its methods and/or properties
### Methods
parse()
```php
public function parse( string $className ): array;
```
Reads annotations from the class, its methods and/or properties
## Annotations\Parser\ReaderInterface
Interface
Parses attributes returning an array with the found attributes
- **`Phalcon\Annotations\Parser\ReaderInterface`**
### Method Summary
Reads attributes from the class, properties and methods
### Methods
parse()
```php
public function parse( string $className ): array;
```
Reads attributes from the class, properties and methods
## Annotations\Parser\Reflection
Class
Allows to manipulate the annotations reflection in an OO manner
```php
use Phalcon\Components\Annotations\Reader;
use Phalcon\Components\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 from the class
$classAnnotations = $reflection->getClassAnnotations();
```
- **`Phalcon\Annotations\Parser\Reflection`**
### Method Summary
Constructor
Returns the annotations found in the class docblock
Returns the annotations found as constants
Returns the annotations found at methods
Returns the annotations found at properties
Returns the raw parsing intermediate definitions used to construct the
### Properties
### Methods
__construct()
```php
public function __construct( array $reflectionData = [] );
```
Constructor
getClassAnnotations()
```php
public function getClassAnnotations(): Collection|null;
```
Returns the annotations found in the class docblock
getConstantsAnnotations()
```php
public function getConstantsAnnotations(): array;
```
Returns the annotations found as constants
getMethodsAnnotations()
```php
public function getMethodsAnnotations(): array;
```
Returns the annotations found at methods
getPropertiesAnnotations()
```php
public function getPropertiesAnnotations(): array;
```
Returns the annotations found at properties
getReflectionData()
```php
public function getReflectionData(): array;
```
Returns the raw parsing intermediate definitions used to construct the
reflection
## Annotations\Router\Connect
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Connect`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Delete
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Delete`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Get
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Get`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Head
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Head`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Options
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Options`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Patch
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Patch`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Post
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Post`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Purge
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Purge`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Put
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Put`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
## Annotations\Router\Route
Class
- **`Phalcon\Annotations\Router\Route`**
- [`Phalcon\Annotations\Router\Connect`](#annotationsrouterconnect)
- [`Phalcon\Annotations\Router\Delete`](#annotationsrouterdelete)
- [`Phalcon\Annotations\Router\Get`](#annotationsrouterget)
- [`Phalcon\Annotations\Router\Head`](#annotationsrouterhead)
- [`Phalcon\Annotations\Router\Options`](#annotationsrouteroptions)
- [`Phalcon\Annotations\Router\Patch`](#annotationsrouterpatch)
- [`Phalcon\Annotations\Router\Post`](#annotationsrouterpost)
- [`Phalcon\Annotations\Router\Purge`](#annotationsrouterpurge)
- [`Phalcon\Annotations\Router\Put`](#annotationsrouterput)
- [`Phalcon\Annotations\Router\Trace`](#annotationsroutertrace)
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Properties
### Methods
__construct()
```php
public function __construct(
string $route,
array|string $methods = [...],
string|null $name = null,
array $paths = [],
array $converters = [],
array|string|null $beforeMatch = null
);
```
## Annotations\Router\RoutePrefix
Class
- **`Phalcon\Annotations\Router\RoutePrefix`**
`Attribute`
### Method Summary
### Properties
### Methods
__construct()
```php
public function __construct( string $prefix );
```
## Annotations\Router\Trace
Class
- [`Phalcon\Annotations\Router\Route`](#annotationsrouterroute)
- **`Phalcon\Annotations\Router\Trace`**
`Attribute` · `Phalcon\Http\Message\RequestMethodInterface`
### Method Summary
### Methods
__construct()
```php
public function __construct( mixed $params );
```
Source: https://docs.phalcon.io/6.0/api/phalcon_annotations/index.mdx