CheckAttributeValueDataQualityRuleCondition
extends CSRuleConditionPlugin
in package
The definition of the data quality condition plugin to check a specific attribute.
Tags
Table of Contents
- COMPARATOR_EMPTY = 1
- COMPARATOR_EQUAL = 7
- COMPARATOR_LARGER_OR_EQUAL = 4
- COMPARATOR_LARGER_THAN = 3
- COMPARATOR_NOT_EMPTY = 2
- COMPARATOR_NOT_EQUAL = 8
- COMPARATOR_SMALLER_OR_EQUAL = 6
- COMPARATOR_SMALLER_THAN = 5
- FIELD_ATTRIBUTE = 'CheckAttributeAttribute'
- FIELD_COMPARATOR = 'CheckAttributeComparator'
- FIELD_COMPARE_VALUE = 'CheckAttributeCompareValue'
- FIELD_INHERITANCE = 'CheckAttributeInheritance'
- __call() : mixed|string
- All method calls which are not defined within the plugin are forwarded to the module Therefore it is possible to get, e.g. the label by calling the getSuiteName() method.
- _construct() : void
- The construct method may be used to initialize custom plugin properties it is called immediately after instantiating the plugin all arguments passed to the getPlugins method are also available in this method.
- addAlternativePluginFolder() : void
- A path to a specific folder in which should be search for plugins.
- getAlternativePluginFolder() : array<string|int, mixed>
- getCondition() : CSRuleApiCondition
- Returns the rule condition object.
- getConditionDescription() : string
- Returns the condition description for the user.
- getConditionResult() : int
- Returns the rule condition status
- getConditionValue() : mixed
- Returns the condition value for a specific key.
- getConfigurationFields() : array<string|int, CSGuiField>
- Returns the defined field configurations.
- getLevel() : int
- The getLevel method may be overwritten in the plugins and defines the order, the plugins are called, where the highest level is called first.
- getMetaData() : CSMetaData
- Returns the CSMetaData of the current plugin.
- getModule() : CSModule
- Returns the module, if the plugin is defined within a module.
- getPlugin() : CSPlugin|null
- Returns a CSPlugin for the given plugin type and plugin class name.
- getPluginChooser() : array<string|int, mixed>
- Returns an array all defined CSPlugins for the current plugin type
- getPluginData() : mixed
- getPluginDefinitionFile() : string
- Returns the path to the file, the plugin is defined.
- getPluginName() : mixed
- getPlugins() : array<string|int, CSPlugin>
- Returns all defined CSPlugins for the current plugin type It should be used to get all matching plugins for a given plugin api.
- getPluginsInModule() : array<string|int, mixed>
- Returns all CSPlugins for the current plugin type which are defined within the given module It should be used to get all matching plugins for a given plugin api.
- getRule() : CSRuleApiRule
- Returns the rule object.
- isAvailable() : bool
- This method is called to check, whether the plugin is available.
- isAvailableForVisibilityType() : bool
- Checks if the current plugin is available for given visibility type.
- resetLoadedPlugins() : mixed
- reset the internal plugins cache for loaded plugins
Constants
COMPARATOR_EMPTY
public
mixed
COMPARATOR_EMPTY
= 1
Tags
COMPARATOR_EQUAL
public
mixed
COMPARATOR_EQUAL
= 7
Tags
COMPARATOR_LARGER_OR_EQUAL
public
mixed
COMPARATOR_LARGER_OR_EQUAL
= 4
Tags
COMPARATOR_LARGER_THAN
public
mixed
COMPARATOR_LARGER_THAN
= 3
Tags
COMPARATOR_NOT_EMPTY
public
mixed
COMPARATOR_NOT_EMPTY
= 2
Tags
COMPARATOR_NOT_EQUAL
public
mixed
COMPARATOR_NOT_EQUAL
= 8
Tags
COMPARATOR_SMALLER_OR_EQUAL
public
mixed
COMPARATOR_SMALLER_OR_EQUAL
= 6
Tags
COMPARATOR_SMALLER_THAN
public
mixed
COMPARATOR_SMALLER_THAN
= 5
Tags
FIELD_ATTRIBUTE
public
mixed
FIELD_ATTRIBUTE
= 'CheckAttributeAttribute'
Tags
FIELD_COMPARATOR
public
mixed
FIELD_COMPARATOR
= 'CheckAttributeComparator'
Tags
FIELD_COMPARE_VALUE
public
mixed
FIELD_COMPARE_VALUE
= 'CheckAttributeCompareValue'
Tags
FIELD_INHERITANCE
public
mixed
FIELD_INHERITANCE
= 'CheckAttributeInheritance'
Tags
Methods
__call()
All method calls which are not defined within the plugin are forwarded to the module Therefore it is possible to get, e.g. the label by calling the getSuiteName() method.
public
__call(mixed $methodName, mixed $methodArguments) : mixed|string
Parameters
- $methodName : mixed
- $methodArguments : mixed
Tags
Return values
mixed|string —_construct()
The construct method may be used to initialize custom plugin properties it is called immediately after instantiating the plugin all arguments passed to the getPlugins method are also available in this method.
public
_construct() : void
Tags
Return values
void —addAlternativePluginFolder()
A path to a specific folder in which should be search for plugins.
public
static addAlternativePluginFolder(mixed $sPluginFolder) : void
Parameters
- $sPluginFolder : mixed
Tags
Return values
void —getAlternativePluginFolder()
public
static getAlternativePluginFolder() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getCondition()
Returns the rule condition object.
public
final getCondition() : CSRuleApiCondition
Tags
Return values
CSRuleApiCondition —getConditionDescription()
Returns the condition description for the user.
public
final getConditionDescription() : string
Tags
Return values
string —with the condition description for the user.
getConditionResult()
Returns the rule condition status
public
final getConditionResult(CSRuleContext $oContext[, int $iLanguageId = null ]) : int
Parameters
- $oContext : CSRuleContext
-
The context object for which the rule has been applied.
- $iLanguageId : int = null
-
The current language id for the condition.
Tags
Return values
int —the rule status
getConditionValue()
Returns the condition value for a specific key.
public
final getConditionValue(string|int $mKey) : mixed
Parameters
- $mKey : string|int
-
The key for the condition value.
Tags
Return values
mixed —condition value for the specific key.
getConfigurationFields()
Returns the defined field configurations.
public
final getConfigurationFields() : array<string|int, CSGuiField>
Tags
Return values
array<string|int, CSGuiField> —An array with the configuration fields of the condition plugin.
getLevel()
The getLevel method may be overwritten in the plugins and defines the order, the plugins are called, where the highest level is called first.
public
getLevel() : int
The method can also be set for all plugins within a module by overwriting the modules getLevel method.
Tags
Return values
int —the level of the plugin where it is called
getMetaData()
Returns the CSMetaData of the current plugin.
public
getMetaData() : CSMetaData
Tags
Return values
CSMetaData —getModule()
Returns the module, if the plugin is defined within a module.
public
getModule() : CSModule
This method can be used in the plugin api and the plugin wherever access to the defining module is required. If it is used in the Api, it should be noticed that this method may return null, if the plugin is directly defined in the projects or admin.local plugins directory.
Tags
Return values
CSModule —the module object, if the plugin defined in a module or null otherwise
getPlugin()
Returns a CSPlugin for the given plugin type and plugin class name.
public
static getPlugin(string $pluginApiPath, string $className[, mixed $arguments = NULL ]) : CSPlugin|null
As standard behaviour the module subfolder is guessed from the forward URL parameter. If a plugin should point to something in a special module subfolder, this scope can be added by adding the module name in squared bracket at the end of the $pluginApiPath, e.g. 'core/api/plugins/CSRecordPlugin.php[pms]' to get all CSRecordPlugins defined for pms records.
Parameters
- $pluginApiPath : string
-
The relative path in filesystem for the requested plugin api (optional: ending with the module subfolder).
- $className : string
-
The target plugin class name, which should be loaded.
- $arguments : mixed = NULL
-
one or multiple arguments which should be passed to the isAvailable method.
Tags
Return values
CSPlugin|null —Returns the requested plugin for the given parameter.
getPluginChooser()
Returns an array all defined CSPlugins for the current plugin type
public
static getPluginChooser(string $pluginApiPath[, mixed $arguments = NULL ]) : array<string|int, mixed>
Parameters
- $pluginApiPath : string
-
the relative path in filesystem for the requested plugin api (optional: ending with the module subfolder).
- $arguments : mixed = NULL
-
one ore multiple arguments which should be passed to the isAvailable method.
Tags
Return values
array<string|int, mixed> —of CSPlugins in the form [CLASSNAME => LABEL] where the CLASSNAME may be used in the CSPlugin::getPlugin method
getPluginData()
public
getPluginData() : mixed
Tags
Return values
mixed —getPluginDefinitionFile()
Returns the path to the file, the plugin is defined.
public
getPluginDefinitionFile() : string
Tags
Return values
string —the path to the plugin
getPluginName()
public
getPluginName() : mixed
Tags
Return values
mixed —getPlugins()
Returns all defined CSPlugins for the current plugin type It should be used to get all matching plugins for a given plugin api.
public
static getPlugins(string $pluginApiPath[, mixed $arguments = NULL ]) : array<string|int, CSPlugin>
As standard behaviour the module subfolder is guessed from the forward URL parameter. If a plugin should point to something in a special module subfolder, this scope can be added by adding the module name in squared bracket at the end of the $pluginApiPath, e.g. 'core/api/plugins/CSRecordPlugin.php[pms]' to get all CSRecordPlugins defined for pms records.
Parameters
- $pluginApiPath : string
-
the relative path in filesystem for the requested plugin api (optional: ending with the module subfolder).
- $arguments : mixed = NULL
-
one ore multiple arguments which should be passed to the isAvailable method.
Tags
Return values
array<string|int, CSPlugin> —array of CSPlugin objects matching the defined plugin criteria
getPluginsInModule()
Returns all CSPlugins for the current plugin type which are defined within the given module It should be used to get all matching plugins for a given plugin api.
public
static getPluginsInModule(string $moduleName, string $pluginApiPath[, mixed $sFileNamePattern = '' ][, mixed $arguments = NULL ]) : array<string|int, mixed>
Parameters
- $moduleName : string
-
the module which should be searched for plugins
- $pluginApiPath : string
-
the relative path in filesystem for the requested plugin api.
- $sFileNamePattern : mixed = ''
- $arguments : mixed = NULL
-
one ore multiple arguments which should be passed to the isAvailable method.
Tags
Return values
array<string|int, mixed> —of CSPlugin objects matching the defined plugin criterias
getRule()
Returns the rule object.
public
final getRule() : CSRuleApiRule
Tags
Return values
CSRuleApiRule —isAvailable()
This method is called to check, whether the plugin is available.
public
final isAvailable([mixed $aPluginArguments = null ]) : bool
Parameters
- $aPluginArguments : mixed = null
Tags
Return values
bool —whether the plugin is available for the given arguments
isAvailableForVisibilityType()
Checks if the current plugin is available for given visibility type.
public
final isAvailableForVisibilityType(int $iVisibilityType) : bool
Available condition types:
- CSRuleApiCondition::VISIBILITY_TYPE_CONDITION => Only visible underneath the main conditions
- CSRuleApiCondition::VISIBILITY_TYPE_PRE_CONDITION => Only visible underneath the pre conditions
- CSRuleApiCondition::VISIBILITY_TYPE_ALL => Visible in both conditions (main & pre)
Parameters
- $iVisibilityType : int
-
The required visibility type
Tags
Return values
bool —whether the current plugin is available for given visibility type.
resetLoadedPlugins()
reset the internal plugins cache for loaded plugins
public
static resetLoadedPlugins() : mixed