PHP Class Neos\Flow\Aop\Pointcut\PointcutFilter

Inheritance: implements Neos\Flow\Aop\Pointcut\PointcutFilterInterface
Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$aspectClassName string Name of the aspect class where the pointcut was declared
$pointcut Pointcut The pointcut this filter is based on
$pointcutMethodName string Name of the pointcut method
$proxyClassBuilder Neos\Flow\Aop\Builder\ProxyClassBuilder A reference to the AOP Proxy ClassBuilder

Public Methods

Method Description
__construct ( string $aspectClassName, string $pointcutMethodName ) The constructor - initializes the pointcut filter with the name of the pointcut we're referring to
getRuntimeEvaluationsDefinition ( ) : array Returns runtime evaluations for the pointcut.
hasRuntimeEvaluationsDefinition ( ) : boolean Returns TRUE if this filter holds runtime evaluations for a previously matched pointcut
injectProxyClassBuilder ( ProxyClassBuilder $proxyClassBuilder ) : void Injects the AOP Proxy Class Builder
matches ( string $className, string $methodName, string $methodDeclaringClassName, mixed $pointcutQueryIdentifier ) : boolean Checks if the specified class and method matches with the pointcut
reduceTargetClassNames ( ClassNameIndex $classNameIndex ) : ClassNameIndex This method is used to optimize the matching process.

Method Details

__construct() public method

The constructor - initializes the pointcut filter with the name of the pointcut we're referring to
public __construct ( string $aspectClassName, string $pointcutMethodName )
$aspectClassName string Name of the aspect class containing the pointcut
$pointcutMethodName string Name of the method which acts as an anchor for the pointcut name and expression

getRuntimeEvaluationsDefinition() public method

Returns runtime evaluations for the pointcut.
public getRuntimeEvaluationsDefinition ( ) : array
return array Runtime evaluations

hasRuntimeEvaluationsDefinition() public method

Returns TRUE if this filter holds runtime evaluations for a previously matched pointcut
public hasRuntimeEvaluationsDefinition ( ) : boolean
return boolean TRUE if this filter has runtime evaluations

injectProxyClassBuilder() public method

Injects the AOP Proxy Class Builder
public injectProxyClassBuilder ( ProxyClassBuilder $proxyClassBuilder ) : void
$proxyClassBuilder Neos\Flow\Aop\Builder\ProxyClassBuilder
return void

matches() public method

Checks if the specified class and method matches with the pointcut
public matches ( string $className, string $methodName, string $methodDeclaringClassName, mixed $pointcutQueryIdentifier ) : boolean
$className string Name of the class to check against
$methodName string Name of the method - not used here
$methodDeclaringClassName string Name of the class the method was originally declared in
$pointcutQueryIdentifier mixed Some identifier for this query - must at least differ from a previous identifier. Used for circular reference detection.
return boolean TRUE if the class matches, otherwise FALSE

reduceTargetClassNames() public method

This method is used to optimize the matching process.
public reduceTargetClassNames ( ClassNameIndex $classNameIndex ) : ClassNameIndex
$classNameIndex Neos\Flow\Aop\Builder\ClassNameIndex
return Neos\Flow\Aop\Builder\ClassNameIndex

Property Details

$aspectClassName protected property

Name of the aspect class where the pointcut was declared
protected string $aspectClassName
return string

$pointcut protected property

The pointcut this filter is based on
protected Pointcut,Neos\Flow\Aop\Pointcut $pointcut
return Pointcut

$pointcutMethodName protected property

Name of the pointcut method
protected string $pointcutMethodName
return string

$proxyClassBuilder protected property

A reference to the AOP Proxy ClassBuilder
protected ProxyClassBuilder,Neos\Flow\Aop\Builder $proxyClassBuilder
return Neos\Flow\Aop\Builder\ProxyClassBuilder