PHP Class Neos\Flow\Aop\Pointcut\PointcutSettingFilter

Example: setting(FooPackage.configuration.option = 'AOP is cool')
Inheritance: implements Neos\Flow\Aop\Pointcut\PointcutFilterInterface
Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$actualSettingValue mixed The value of the specified setting
$cachedResult boolean
$condition mixed The condition value to match against the configuration setting
$configurationManager Neos\Flow\Configuration\ConfigurationManager
$settingComparisonExpression string The path leading to the setting to match with

Public Methods

Method Description
__construct ( string $settingComparisonExpression ) The constructor - initializes the configuration filter with the path to a configuration option
getRuntimeEvaluationsDefinition ( ) : array Returns runtime evaluations for the pointcut.
hasRuntimeEvaluationsDefinition ( ) : boolean Returns TRUE if this filter holds runtime evaluations for a previously matched pointcut
injectConfigurationManager ( ConfigurationManager $configurationManager ) : void Injects the configuration manager
matches ( string $className, string $methodName, string $methodDeclaringClassName, mixed $pointcutQueryIdentifier ) : boolean Checks if the specified configuration option is set to TRUE or FALSE, or if it matches the specified condition
reduceTargetClassNames ( ClassNameIndex $classNameIndex ) : ClassNameIndex This method is used to optimize the matching process.

Protected Methods

Method Description
parseConfigurationOptionPath ( string $settingComparisonExpression ) : void Parses the given configuration path expression and sets $this->actualSettingValue and $this->condition accordingly

Method Details

__construct() public method

The constructor - initializes the configuration filter with the path to a configuration option
public __construct ( string $settingComparisonExpression )
$settingComparisonExpression string Path (and optional condition) leading to the setting

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

injectConfigurationManager() public method

Injects the configuration manager
public injectConfigurationManager ( ConfigurationManager $configurationManager ) : void
$configurationManager Neos\Flow\Configuration\ConfigurationManager
return void

matches() public method

Checks if the specified configuration option is set to TRUE or FALSE, or if it matches the specified condition
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 - not used here
$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

parseConfigurationOptionPath() protected method

Parses the given configuration path expression and sets $this->actualSettingValue and $this->condition accordingly
protected parseConfigurationOptionPath ( string $settingComparisonExpression ) : void
$settingComparisonExpression string The configuration expression (path + optional condition)
return void

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

$actualSettingValue protected property

The value of the specified setting
protected mixed $actualSettingValue
return mixed

$cachedResult protected property

protected bool $cachedResult
return boolean

$condition protected property

The condition value to match against the configuration setting
protected mixed $condition
return mixed

$configurationManager protected property

protected ConfigurationManager,Neos\Flow\Configuration $configurationManager
return Neos\Flow\Configuration\ConfigurationManager

$settingComparisonExpression protected property

The path leading to the setting to match with
protected string $settingComparisonExpression
return string