Flow Annotation Reference

This reference was automatically generated from code on 2023-12-06

After

Declares a method as an after advice to be triggered after any pointcut matching the given expression.

Applicable to:: Method

Arguments

pointcutExpression (string): The pointcut expression. (Can be given as anonymous argument.)

AfterReturning

Declares a method as an after returning advice to be triggered after any pointcut matching the given expression returns.

Applicable to:: Method

Arguments

pointcutExpression (string): The pointcut expression. (Can be given as anonymous argument.)

AfterThrowing

Declares a method as an after throwing advice to be triggered after any pointcut matching the given expression throws an exception.

Applicable to:: Method

Arguments

pointcutExpression (string): The pointcut expression. (Can be given as anonymous argument.)

Around

Declares a method as an around advice to be triggered around any pointcut matching the given expression.

Applicable to:: Method

Arguments

pointcutExpression (string): The pointcut expression. (Can be given as anonymous argument.)

Aspect

Marks a class as an aspect.

The class will be read by the AOP framework of Flow and inspected for pointcut expressions and advice.

Applicable to:: Class

Autowiring

Used to disable autowiring for Dependency Injection on the whole class or on the annotated property only.

Applicable to:: Method, Class

Arguments

enabled (boolean): Whether autowiring is enabled. (Can be given as anonymous argument.)

Before

Declares a method as an before advice to be triggered before any pointcut matching the given expression.

Applicable to:: Method

Arguments

pointcutExpression (string): The pointcut expression. (Can be given as anonymous argument.)

CompileStatic

Entity

Marks an object as an entity.

Behaves like DoctrineORMMappingEntity so it is interchangeable with that.

Applicable to:: Class

Arguments

repositoryClass (string|null): Name of the repository class to use for managing the entity.
readOnly (boolean): Whether the entity should be read-only.

FlushesCaches

Marks a CLI command as a cache-flushing command.

Usually used for framework purposes only.

Applicable to:: Method

Identity

Marks a property as being (part of) the identity of an object.

If multiple properties are annotated as Identity, a compound identity is created.

For Doctrine a unique key over all involved properties will be created - thus the limitations of that need to be observed.

Applicable to:: Property

IgnoreValidation

Used to ignore validation on a specific method argument or class property.

By default no validation will be executed for the given argument. To gather validation results for further processing, the “evaluate” option can be set to true (while still ignoring any validation error).

Applicable to:: Method, Property

Arguments

argumentName (string|null): Name of the argument to skip validation for. (Can be given as anonymous argument.)
evaluate (boolean): Whether to evaluate the validation results of the argument

Inject

Used to enable property injection.

Flow will build Dependency Injection code for the property and try to inject a value as specified by the var annotation.

Applicable to:: Property

Arguments

lazy (boolean): Whether the dependency should be injected instantly or if a lazy dependency proxy should be injected instead
name (string|null): Optional object name This is useful if the object name does not match the class name of the object to be injected: (at)Inject(name=”Some.Package:Some.Virtual.Object”)

InjectConfiguration

Used to enable property injection for configuration including settings.

Flow will build Dependency Injection code for the property and try to inject the configured configuration.

Applicable to:: Property

Arguments

path (string|null): Path of a configuration which should be injected into the property. Can be specified as anonymous argument: InjectConfiguration(“some.path”)

For type “Settings” this refers to the relative path (excluding the package key)

Example: session.name
package (string|null): Defines the package key to be used for retrieving settings. If no package key is specified, we’ll assume the package to be the same which contains the class where the InjectConfiguration annotation is used.

Note: This property is only supported for type “Settings”

Example: Neos.Flow
type (string one of the ConfigurationManager::CONFIGURATION_TYPE_* constants): Type of Configuration (defaults to “Settings”).

Internal

Used to mark a command as internal - it will not be shown in CLI help output.

Usually used for framework purposes only.

Applicable to:: Method

Introduce

Introduces the given interface or property into any target class matching the given pointcut expression.

Applicable to:: Class, Property

Arguments

pointcutExpression (string): The pointcut expression. (Can be given as anonymous argument.)
interfaceName (string|null): The interface name to introduce.
traitName (string|null): The trait name to introduce

Lazy

Marks a property or class as lazy-loaded.

This is only relevant for anything based on the generic persistence layer of Flow. For Doctrine based persistence this is ignored.

Applicable to:: Class, Property

MapRequestBody

Used to map the request body to a single action argument.

Normally, Flow will map the request body into the arguments as an associative array. With this it is possible to map the full body into a single argument without wrapping the request body.

Applicable to:: Method

Arguments

argumentName (string): Name of the argument to map the request body into. (Can be given as anonymous argument.)

Pointcut

Declares a named pointcut. The annotated method does not become an advice but can be used as a named pointcut instead of the given expression.

Applicable to:: Method

Arguments

expression (string): The pointcut expression. (Can be given as anonymous argument.)

Proxy

Used to disable proxy building for an object.

If disabled, neither Dependency Injection nor AOP can be used on the object.

Applicable to:: Class

Arguments

enabled (boolean): Whether proxy building for the target is disabled. (Can be given as anonymous argument.)

Scope

Used to set the scope of an object.

Applicable to:: Class

Arguments

value (string): The scope of an object: prototype, singleton, session. (Usually given as anonymous argument.)

Session

Used to control the behavior of session handling when the annotated method is called.

Applicable to:: Method

Arguments

autoStart (boolean): Whether the annotated method triggers the start of a session.

Signal

Marks a method as a signal for the signal/slot implementation of Flow. The method will be augmented as needed (using AOP) to be a usable signal.

Applicable to:: Method

SkipCsrfProtection

Action methods marked with this annotation will not be secured against CSRF.

Since CSRF is a risk for write operations, this is useful for read-only actions. The overhead for CRSF token generation and validation can be skipped in those cases.

Applicable to:: Method

Transient

Marks a property as transient - it will never be considered by the persistence layer for storage and retrieval.

Useful for calculated values and any other properties only needed during runtime.

Applicable to:: Property

Validate

Controls how a property or method argument will be validated by Flow.

Applicable to:: Method, Property

Arguments

type (string|null): The validator type, either a FQCN or a Flow validator class name.
options (array): Options for the validator, validator-specific.
argumentName (string): The name of the argument this annotation is attached to, if used on a method. (Can be given as anonymous argument.)
validationGroups (array): The validation groups for which this validator should be executed.

ValidationGroups

Arguments

validationGroups (array): The validation groups for which validation on this method should be executed. (Can be given as anonymous argument.)

ValueObject

Marks the annotate class as a value object.

The schema will be embedded into parent entities by default, unless “embedded=false” is specified. In that case, regarding Doctrine the object is treated like an entity, but Flow applies some optimizations internally, e.g. to store only one instance of the value object.

Applicable to:: Class

Arguments

embedded (boolean): Whether the value object should be embedded.