Public Member Functions

AcronPlugin Class Reference
[Plugins_generic_acron]

Removes dependency on 'cron' for scheduled tasks. More...

Inheritance diagram for AcronPlugin:
GenericPlugin Plugin

List of all members.

Public Member Functions

 checkFrequency ($className, $frequency, $lastRunTime)
 isInNumericRange ($value, $min, $max)
 isInRange ($rangeStr, $currentValue, $lastTimestamp, $timeCompareStr, $cutoffTimestamp)
 register ($category, $path)

Detailed Description

Removes dependency on 'cron' for scheduled tasks.

Definition at line 28 of file AcronPlugin.inc.php.


Member Function Documentation

AcronPlugin.checkFrequency ( className,
frequency,
lastRunTime 
)

Check if the specified task should be executed according to the specified frequency and its last run time.

Parameters:
$className string
$frequency XMLNode
Returns:
string

Definition at line 154 of file AcronPlugin.inc.php.

References isInRange().

AcronPlugin.isInNumericRange ( value,
min,
max 
)

Check if a numeric value is within the specified range.

Parameters:
$value int
$min int
$max int
Returns:
boolean

Definition at line 253 of file AcronPlugin.inc.php.

Referenced by isInRange().

AcronPlugin.isInRange ( rangeStr,
currentValue,
lastTimestamp,
timeCompareStr,
cutoffTimestamp 
)

Check if a value is within the specified range.

Parameters:
$rangeStr string the range (e.g., 0, 1-5, *, etc.)
$currentValue int value to check if its in the range
$lastTimestamp int the last time the task was executed
$timeCompareStr string value to use in strtotime("-X $timeCompareStr")
$cutoffTimestamp int value will be considered valid if older than this
Returns:
boolean

Definition at line 202 of file AcronPlugin.inc.php.

References isInNumericRange().

Referenced by checkFrequency().

AcronPlugin.register ( category,
path 
)

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Parameters:
$category String Name of category plugin was registered to
$path String The path the plugin was found in
Returns:
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

Definition at line 35 of file AcronPlugin.inc.php.


The documentation for this class was generated from the following file: