Class \Prado\Util\Cron\TDbCronModule

TDbCronModule class.

TDbCronModule does everything that TCronModule does but stores the tasks and persistent data in its own database table.

The TDbCronModule allows for adding, updating, and removing tasks from the application and shell. It can log executing tasks to the table as well.

There are log maintenance methods and TDbCronCleanLogTask for cleaning the cron logs.

Runtime Tasks can be added for execution onEndRequest. Singleton tasks can be added to TDbCronModule, and scheduled to execute during Runtime at onEndRequest. Then if it does not execute onEndRequest, then the next shell cron will execute the task. This could occur if the user presses stop before the page completes.

Class hierarchy

\Prado\Util\Cron\TDbCronModule implements IDbModule

\Prado\Util\Cron\TCronModule implements IPermissions

\Prado\TModule implements IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Brad Anderson <belisoful@icloud.com>
Since: 4.2.0

Methods summary
`public`	`__construct() : mixed` constructs the instances, sets the _shellClass.
`public`	`addRuntimeTask(TCronTask $task) : mixed` Adds a task to being run time. If this is the first runtime task this method adds {@see executeRuntimeTasks} to TApplication::onEndRequest.
`public`	`addTask(TCronTask $task[, bool $runtime = false ]) : bool` Adds a task to the database. Validates the name and cannot add a task with an existing name. This updates the table row data as well.
`public`	`clearCronLog(int $seconds) : mixed` deletes the cron log items before time minus $seconds.
`public`	`clearRuntimeTasks() : mixed` Clears all tasks from being run time, and removes the handler from onEndRequest.
`public`	`executeRuntimeTasks([null\|TApplication $sender = null ][, null\|mixed $param = null ]) : int` This executes the Run Time Tasks, this method is automatically added to TApplication::onEndRequest when there are RuntimeTasks via {@see addRuntimeTask}.
`public`	`fxGetCronTaskInfos(TDbCronModule $cron, null $param) : mixed` the global event handling requests for cron task info
`public`	`getAutoCreateCronTable() : bool`
`public`	`getConnectionID() : null\|string`
`public`	`getCronLog(null\|string $name, int $pageSize, int $offset[, null\|bool $sortingDesc = null ]) : mixed` Gets the cron log table of specific named or all tasks.
`public`	`getCronLogCount([null\|string $name = null ]) : int`
`public`	`getDbConnection() : TDbConnection`
`public`	`getLogCronTasks() : bool`
`public`	`getPermissions(TPermissionsManager $manager) : array<string\|int, TPermissionEvent>`
`public`	`getRuntimeTasks() : TCronTask` Gets the runtime tasks.
`public`	`getTableName() : string`
`public`	`getTask(string $taskName[, bool $checkExisting = true ][, bool $asObject = true ]) : TCronTask` This lazy loads the tasks.
`public`	`getTasks() : mixed` This lazy loads the tasks from configuration array to instance.
`public`	`init(array<string\|int, mixed>\|TXmlElement $config) : mixed` Initializes the module. Keeps track of the configured tasks different than db tasks.
`public`	`removeCronLogItem(int $taskUID) : mixed` Deletes one cron log item from the database
`public`	`removeRuntimeTask(TCronTask $untask) : mixed` Removes a task from being run time. If there are no runtime tasks left then it removes {@see executeRuntimeTasks} from TApplication::onEndRequest.
`public`	`removeTask(string\|TCronTask $untask) : bool` Removes a task from the database table. This also removes the task from the current tasks, the taskRow, and runtime Tasks. This cannot remove tasks that are current configuration tasks. Only tasks that exist can be removed.
`public`	`setAutoCreateCronTable(bool $value) : mixed`
`public`	`setConnectionID(string $value) : mixed` Sets the ID of a TDataSourceConfig module. The datasource module will be used to establish the DB connection for this cron module.
`public`	`setLogCronTasks(bool $log) : mixed`
`public`	`setTableName(string $table) : mixed`
`public`	`taskExists(string $name) : bool` taskExists checks for a task or task name in the database
`public`	`updateTask(TCronTask $task) : bool` Updates a task from its unique name. If the Task is not in the DB it returns false
`public`	`validateTask(array<string\|int, mixed> $properties) : mixed` This checks for "name". The name cannot by '*' or have spaces, `, ', ", <, or >t characters.
`protected`	`addTaskInternal(TCronTask $task[, bool $runtime = false ]) : bool` Adds a task to the database. Validates the name and cannot add a task with an existing name. This updates the table row data as well.
`protected`	`createDbConnection() : TDbConnection` Creates the DB connection. If no ConnectionId is provided, then this creates a sqlite database in runtime named 'cron.jobs'.
`protected`	`createDbTable() : mixed` creates the module table
`protected`	`ensureTable() : mixed` checks for the table, and if not there and autoCreate, then creates the table else throw error.
`protected`	`ensureTasks([bool $initConfigTasks = true ]) : array<string\|int, TCronTask>` reads in all the tasks from the db, instances them if they are active db tasks. otherwise the rows are kept for persistent data.
`protected`	`filterStaleTasks() : mixed` this removes any stale database rows from changing configTasks
`protected`	`logCronTask(TCronTask $task, string $username) : mixed` logCronTask adds a task log to the table.
`protected`	`removeTaskInternal(TCronTask\|string $untask) : bool` Removes a task from the database table. This also removes the task from the current tasks, the taskRow, and runtime Tasks. This cannot remove tasks that are current configuration tasks. Only tasks that exist can be removed.
`protected`	`setPersistentData(string $name, object $task) : bool` Sets the lastExecTime and processCount for a task from the DB. Also resets the lastExecTime when not in the DB
`protected`	`updateTaskInfo(TCronTask $task) : mixed` This updates the LastExecTime and ProcessCount in the database
`protected`	`updateTaskInternal(TCronTask $task) : bool` Updates a task from its unique name. If the Task is not in the DB it returns false

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAdditionalCronTasks, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getDefaultUserName, getEnableRequestCron, getEventHandlers, getID, getInCronShell, getLastCronTime, getListeningToGlobalEvents, getPendingTasks, getPermissions, getRawTasks, getRequest, getRequestCronProbability, getResponse, getService, getSession, getSubProperty, getTask, getTaskInfos, getTasks, getTasksByType, getUser, getUserManager, hasEvent, hasEventHandler, hasMethod, hasProperty, init, instanceTask, isa, listen, processPendingTasks, publishAsset, publishFilePath, raiseEvent, registerShellAction, runTask, setAdditionalCronTasks, setDefaultUserName, setEnableRequestCron, setID, setInCronShell, setLastCronTime, setRequestCronProbability, setSubProperty, setUserManager, unlisten, validateTask, _getZappableSleepProps, ensureTasks, filterStaleTasks, getCallChain, getClassFxEvents, instanceBehavior, logCron, logCronTask, logCronTaskEnd, readConfiguration, setPersistentData, updateTaskInfo, filter_prado_fx

Constants summary
`public mixed`	`NAME_VALIDATOR_REGEX` Name Regular Expression, no spaces, single or double quotes, less than or greater than, no percent, and cannot start with star	'/^[^\\s`\'\\"\\<>%][^\\s`\'\\"<>%]$/i'
`public mixed`	`PERM_CRON_ADD_TASK`	`'cron_add_task'`
`public mixed`	`PERM_CRON_LOG_DELETE`	`'cron_log_delete'`
`public mixed`	`PERM_CRON_LOG_READ`	`'cron_log_read'`
`public mixed`	`PERM_CRON_REMOVE_TASK`	`'cron_remove_task'`
`public mixed`	`PERM_CRON_UPDATE_TASK`	`'cron_update_task'`

Inherited constants
\Prado\Util\Cron\TCronModule::DEFAULT_CRON_USER, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Util\Cron\TCronModule::LAST_CRON_TIME, \Prado\Util\Cron\TCronModule::METHOD_SEPARATOR, \Prado\Util\Cron\TCronModule::NAME_KEY, \Prado\Util\Cron\TCronModule::PERM_CRON_SHELL, \Prado\Util\Cron\TCronModule::SCHEDULE_KEY, \Prado\Util\Cron\TCronModule::SHELL_LOG_BEHAVIOR, \Prado\Util\Cron\TCronModule::TASK_KEY, \Prado\Util\Cron\TCronModule::TASKS_INFO, \Prado\Util\Cron\TCronModule::USERNAME_KEY

Classes

Interfaces

Traits

Search results

Class \Prado\Util\Cron\TDbCronModule

Class hierarchy