Class \Prado\Util\Cron\TCronModule

TCronModule class.

TCronModule runs time based services for the application. This will run a task at a given time. A task can be a task class or a module Id followed by '->' followed by a method with or without parameters. eg.

	<module id="cron" class="Prado\Util\Cron\TCronModule" DefaultUserName="admin">
	<job Name="cronclean" Schedule="0 0 1 * * *" Task="Prado\Util\Cron\TDbCronCleanLogTask" UserName="cron" />
	<job Name="dbcacheclean" Schedule="* * * * *" Task="dbcache->flushCacheExpired(true)" />
	<job Schedule="0 * * * *" Task="mymoduleid->taskmethod" />
</module>

The schedule is formatted like a linux crontab schedule expression. TTimeSchedule parses the schedule and supports 8 different languages. Advanced options, like @daily, and @hourly, are supported.

This module is designed to be run as a system Crontab prado-cli every minute. The application then decides what tasks to execute, or not, and when.

The following is an example for your system cron tab to run the PRADO application cron.

	* * * * *  php /dir_to_/vendor/bin/prado-cli app /dir_to_app/ cron

The default cron user can be set with set$DefaultUserName with its default being 'cron' user. The default user is used when no task specific user is specifiedThe 'cron' user should exist in the TUserManager to switched the application user properly.

Class hierarchy

\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`	`getAdditionalCronTasks() : array<string\|int, mixed>`
`public`	`getDefaultUserName() : string`
`public`	`getEnableRequestCron() : bool`
`public`	`getInCronShell() : null\|bool`
`public`	`getLastCronTime() : float`
`public`	`getPendingTasks() : array<string\|int, TCronTask>`
`public`	`getPermissions(TPermissionsManager $manager) : array<string\|int, TPermissionEvent>`
`public`	`getRawTasks() : array<string\|int, array<string\|int, mixed>>\|array<string\|int, TCronTask>` These are the tasks specified in the configuration and getAdditionalCronTasks until {@see ensureTasks} is called.
`public`	`getRequestCronProbability() : numeric-string\|int\|float`
`public`	`getTask(string $name) : TCronTask` This lazy loads the tasks.
`public`	`getTaskInfos([bool $forceupdate = false ]) : array<string\|int, TCronTaskInfo>` Objects should handle fxGetCronTasks($sender, $param)
`public`	`getTasks() : array<string\|int, TCronTask>` This lazy loads the tasks from configuration array to instance. This calls ensureTasks to get the tasks and their persistent data.
`public`	`getTasksByType(string $type) : array<string\|int, TCronTask>` Filters the Tasks for a specific class.
`public`	`getUserManager() : null\|IUserManager`
`public`	`init(array<string\|int, mixed>\|TXmlElement $config) : mixed` Initializes the module. Read the configuration, installs Shell Actions, should Request cron be activated.
`public`	`instanceTask(string $taskExec) : TCronTask` .
`public`	`processPendingTasks() : int` processPendingTasks executes pending tasks
`public`	`registerShellAction(object $sender, null\|mixed $param) : mixed`
`public`	`runTask(TCronTask $task) : mixed` Runs a specific task. Sets the user to the Task user or the cron module {@see getDefaultUserName}.
`public`	`setAdditionalCronTasks(null\|array<string\|int, mixed>\|string $tasks) : mixed` This will take a string that is an array of tasks that has been through serialize(), or json_encode, or is an xml file of additional tasks. If one task is set, then it is automatically placed into an array.
`public`	`setDefaultUserName(string $id) : mixed`
`public`	`setEnableRequestCron(mixed $allow) : mixed`
`public`	`setInCronShell(null\|bool $inCronShell) : mixed`
`public`	`setLastCronTime(float $time) : mixed`
`public`	`setRequestCronProbability(numeric-string\|int\|float $probability) : mixed`
`public`	`setUserManager(null\|IUserManager\|string $provider) : mixed`
`public`	`validateTask(array<string\|int, mixed> $properties) : mixed` Validates that schedule and task are present. Subclasses overload this method to add their own validation.
`protected`	`ensureTasks() : array<string\|int, TCronTask>` makes the tasks from the configuration array into task objects.
`protected`	`filterStaleTasks() : mixed` This removes any stale tasks in the global state.
`protected`	`logCron(int $numtasks) : mixed`
`protected`	`logCronTask(TCronTask $task, string $username) : mixed` Logs the cron task being run with the system log and output on cli
`protected`	`logCronTaskEnd(TCronTask $task) : mixed` Logs the end of the task.
`protected`	`readConfiguration(array<string\|int, mixed>\|TXmlElement $config) : mixed` This reads the configuration and stores the specified tasks, for lazy loading, until needed.
`protected`	`setPersistentData(string $name, TCronTask $task) : bool` when instancing and then loading the tasks, this sets the persisting data of the task from the global state. When there is no instance in the global state, the lastExecTime is initialized.
`protected`	`updateTaskInfo(TCronTask $task) : mixed` sets the lastExecTime to now and increments the processCount. This saves the new data to the global state.

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, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`DEFAULT_CRON_USER` The name of the cron user	`'cron'`
`public mixed`	`LAST_CRON_TIME` Key to global state of the last time SystemCron was run	`'prado:cron:lastcron'`
`public mixed`	`METHOD_SEPARATOR` The separator for TCronMethodTask	`'->'`
`public mixed`	`NAME_KEY`	`'name'`
`public mixed`	`PERM_CRON_SHELL` The permission for the cron shell	`'cron_shell'`
`public mixed`	`SCHEDULE_KEY`	`'schedule'`
`public mixed`	`SHELL_LOG_BEHAVIOR` The behavior name for the Shell Log behavior	`'shellLog'`
`public mixed`	`TASK_KEY`	`'task'`
`public mixed`	`TASKS_INFO` Key to global state of each task, lastExecTime and ProcessCount	`'prado:cron:tasksinfo'`
`public mixed`	`USERNAME_KEY`	`'username'`

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Util\Cron\TCronModule

Class hierarchy