프로퍼티 | 타입 | 설명 | |
---|---|---|---|
$_actions | array | This SHOULD be defined in each subclass. | |
$_categories | array | This SHOULD be defined in each subclass. | |
$_categoryFeatures | array | This is an associative array with the keys taken from $_actions, each value is a list of strings with the supported feature names. An absent key is interpreted as "all features supported". | |
$_features | array | A list of driver features. | |
$_generated | boolean | Have the recipes been generated yet? | |
$_params | array | The script class' additional parameters. | |
$_recipes | array | The recipes that make up the code. | |
$_special_types | array | A list of any special types that this driver supports. | |
$_tests | array | This SHOULD be defined in each subclass. | |
$_types | array | This SHOULD be defined in each subclass. |
메소드 | 설명 | |
---|---|---|
__construct ( array $params = [] ) | Constructor. | |
activate ( boolean $activate = true, boolean $auto_update = true ) | Connects to the backend, uploads the scripts and sets them active. | |
availableActions ( ) : array | Returns the available actions for this driver. | |
availableCategories ( ) : array | Returns the available categories for this driver. | |
availableCategoryFeatures ( $category ) : array | Returns the supported form fields for this driver. | |
availableTests ( ) : array | Returns the available tests for this driver. | |
availableTypes ( ) : array | Returns the available test types for this driver. | |
canPerform ( ) : boolean | Is the perform() function available right now? | |
excludeRegexp ( ) : string | Returns a regular expression that should catch mails coming from most daemons, mailing list, newsletters, and other bulk. | |
generate ( ) : array | Generates the scripts to do the filtering specified in the rules. | |
hasFeature ( string $feature ) : boolean | Returns whether the script driver supports a certain feature. | |
perform ( integer $change = null ) | Performs the filtering specified in the rules. | |
setParams ( array $params = [] ) : Ingo_Script | Updates the parameters. | |
specialTypes ( ) : array | Returns any test types that are special for this driver. |
메소드 | 설명 | |
---|---|---|
_addItem ( integer $rule, Ingo_Script_Item $item, string $name = null ) | Adds an item to the recipe list. | |
_generate ( ) | Generates the scripts to do the filtering specified in the rules. | |
_insertItem ( integer $rule, Ingo_Script_Item $item, string $name = null, $position ) | Inserts an item into the recipe list. | |
_perform ( $change ) | ||
_validRule ( Ingo_Rule $rule ) : boolean | Is this a valid rule? |
public __construct ( array $params = [] ) | ||
$params | array | A hash containing parameters needed. |
protected _generate ( ) |
protected _insertItem ( integer $rule, Ingo_Script_Item $item, string $name = null, $position ) | ||
$rule | integer | One of the Ingo::RULE_* constants. |
$item | Ingo_Script_Item | An item to add to the recipe list. |
$name | string | A script name. |
protected _validRule ( Ingo_Rule $rule ) : boolean | ||
$rule | Ingo_Rule | The rule object. |
리턴 | boolean | Whether the rule is valid for this driver. |
public availableActions ( ) : array | ||
리턴 | array | The list of available actions. |
public availableCategories ( ) : array | ||
리턴 | array | The list of categories. |
public availableCategoryFeatures ( $category ) : array | ||
리턴 | array | An array with the supported field names of the requested category. |
public availableTests ( ) : array | ||
리턴 | array | The list of tests actions. |
public availableTypes ( ) : array | ||
리턴 | array | The list of test types. |
public canPerform ( ) : boolean | ||
리턴 | boolean | True if perform() is available, false if not. |
public excludeRegexp ( ) : string | ||
리턴 | string | A regular expression. |
public hasFeature ( string $feature ) : boolean | ||
$feature | string | A feature name. |
리턴 | boolean | True if this feature is supported. |
public specialTypes ( ) : array | ||
리턴 | array | The list of special types |
protected array $_categories | ||
리턴 | array |
protected array $_categoryFeatures | ||
리턴 | array |
protected array $_special_types | ||
리턴 | array |