Class CronForm

Widget-ized wrapper methods for rendering cron forms and processing input.

CComponent

CBaseController

CWidget

X2Widget

CronForm

Package: application\components
Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/components/CronForm.php

Methods summary
`public mixed`	# `__call( type $name, type $parameters )` Override that skips anything and everything if it's not possible to control the cron table Override that skips anything and everything if it's not possible to control the cron table Parameters `$name` `type` $name `$parameters` `type` $parameters Returns `mixed` the method return value Throws `CException` if current class and its behaviors do not have a method or closure with the given name Overrides `CComponent::__call()`
`public`	# `__construct( CBaseController $owner = null )` Constructor. Constructor. Parameters `$owner` `CBaseController` $owner owner/creator of this widget. It could be either a widget or a controller. Overrides `X2Widget::__construct()`
`public`	# `getDisplayCmds( )`
`public type`	# `getJobTags( )` Getter for jobTags Getter for jobTags Returns `type`
`public type`	# `jobAttr( string $tag, string $index, mixed $ini = null )` Function to retrieve default initial values for job attributes. Function to retrieve default initial values for job attributes. Parameters `$tag` `string` $tag Tag of the job `$index` `string` $index Index in the job configuration `$ini` `mixed` $ini Initial value if none specified Returns `type`
`public`	# `save( mixed $formData )` Process form data and save in the cron table Process form data and save in the cron table
`public`	# `run( )` Run/render a set of inputs for each cron job that this form will manage. Run/render a set of inputs for each cron job that this form will manage. "enable_$tag" is the value stored in the cron job enablement checkbox. "$tag" will be the form data loaded from crontab. Overrides `CWidget::run()`
`public`	# `setDisplayCmds( array $value )`
`public`	# `setJobTags( array $value )` Setter for jobTags Setter for jobTags Parameters `$value` `array` $value

Methods inherited from X2Widget
`ajaxRender(), behaviors(), getModule(), init(), renderFile(), setModule()`

Methods inherited from CWidget
`actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderInternal(), widget()`

Methods inherited from CComponent
`__get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`protected CommandUtil`	`$cmdU`		# Command utility object Command utility object
`protected string`	`$crontab`		# Current cron table Current cron table
`protected array`	`$j`	`array()`	# Array storing cron jobs configuration Array storing cron jobs configuration
`protected boolean`	`$execute`	`false`	# Flag for executing or skipping due to inadequate permissions or unavailability of cron on the system. Flag for executing or skipping due to inadequate permissions or unavailability of cron on the system.
`public boolean`	`$allowUserCmdInput`	`false`	# If set to true, this will enable receiving input from the "cmd" input field on the form, thus allowing the user free reign to schedule any cron job they want. If set to true, this will enable receiving input from the "cmd" input field on the form, thus allowing the user free reign to schedule any cron job they want.
`public type`	`$formData`	`array()`	# Array containing form data, i.e. $_POST Array containing form data, i.e. $_POST
`public type`	`$jobs`		# An array specifying cron jobs for which to generate inputs. An array specifying cron jobs for which to generate inputs. The array is key-value pairs where keys are job tags and values are each an array with: cmd: the command to run (absolutely required, unless `CronForm::$allowUserCmdInput` input is set to true) title: title of the cron job desc: the short description, to be saved in the cron table as a comment longdesc: long user-friendly description instructions: additional info about the cron job, i.e. what exactly it does and any disclaimers they should know about
`public type`	`$jobSeparator`	`'<hr />'`	# In the case that form inputs for multiple cron jobs are being rendered, this is the string that will be included in output, separating them. In the case that form inputs for multiple cron jobs are being rendered, this is the string that will be included in output, separating them.
`public type`	`$labelCssClass`	`'cron-checkitem'`	# CSS class used by the label/title of each cron job section. CSS class used by the label/title of each cron job section.
`public type`	`$name`	`'cron'`	# Name (and thus index in form data) of the cron jobs. Name (and thus index in form data) of the cron jobs.
`public array`	`$titles`	`array()`	#

Properties inherited from X2Widget
`$_module`

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties summary
`public array`	`$jobTags`	# Array of cron line tags for which to generate the form. Array of cron line tags for which to generate the form.
`public array`	`$displayCmds`	# Array of commands for display purposes only. Array of commands for display purposes only.

Magic properties inherited from X2Widget
`$module`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Class CronForm

Parameters

Returns

Throws

Overrides

Parameters

Overrides

Returns

Parameters

Returns

Overrides

Parameters