Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • AccountsGridViewProfileWidget
  • ActionMenu
  • ActionsGridViewProfileWidget
  • ActionsQuickCreateRelationshipBehavior
  • ActiveDateRangeInput
  • ApplicationConfigBehavior
  • Attachments
  • ChatBox
  • CommonControllerBehavior
  • ContactMapInlineTags
  • ContactsGridViewProfileWidget
  • CronForm
  • CSaveRelationsBehavior
  • DateRangeInputsWidget
  • DocsGridViewProfileWidget
  • DocViewer
  • DocViewerProfileWidget
  • EButtonColumnWithClearFilters
  • EmailDeliveryBehavior
  • EmailProgressControl
  • EncryptedFieldsBehavior
  • EventsChartProfileWidget
  • FileUploader
  • FontPickerInput
  • Formatter
  • FormView
  • GridViewWidget
  • History
  • IframeWidget
  • ImportExportBehavior
  • InlineActionForm
  • InlineEmailAction
  • InlineEmailForm
  • InlineEmailModelBehavior
  • InlineQuotes
  • JSONEmbeddedModelFieldsBehavior
  • JSONFieldsDefaultValuesBehavior
  • LeadRoutingBehavior
  • LeftWidget
  • LoginThemeHelper
  • LoginThemeHelperBase
  • MarketingGridViewProfileWidget
  • MediaBox
  • MessageBox
  • MobileFormatter
  • MobileFormLayoutRenderer
  • MobileLayoutRenderer
  • MobileLoginThemeHelper
  • MobileViewLayoutRenderer
  • ModelFileUploader
  • NewWebLeadsGridViewProfileWidget
  • NormalizedJSONFieldsBehavior
  • NoteBox
  • OnlineUsers
  • OpportunitiesGridViewProfileWidget
  • Panel
  • ProfileDashboardManager
  • ProfileGridViewWidget
  • ProfileLayoutEditor
  • ProfilesGridViewProfileWidget
  • Publisher
  • PublisherActionTab
  • PublisherCalendarEventTab
  • PublisherCallTab
  • PublisherCommentTab
  • PublisherEventTab
  • PublisherSmallCalendarEventTab
  • PublisherTab
  • PublisherTimeTab
  • QuickContact
  • QuickCreateRelationshipBehavior
  • QuotesGridViewProfileWidget
  • RecordAliasesWidget
  • RecordViewLayoutManager
  • RecordViewWidgetManager
  • RememberPagination
  • Reminders
  • ResponseBehavior
  • ResponsiveHtml
  • SearchIndexBehavior
  • ServicesGridViewProfileWidget
  • SmallCalendar
  • SmartActiveDataProvider
  • SmartDataProviderBehavior
  • SmartSort
  • SocialForm
  • SortableWidgetManager
  • SortableWidgets
  • TagBehavior
  • TagCloud
  • TemplatesGridViewProfileWidget
  • TimeZone
  • TopContacts
  • TopSites
  • TransformedFieldStorageBehavior
  • TranslationLogger
  • TwitterFeed
  • TwoColumnSortableWidgetManager
  • UpdaterBehavior
  • UpdatesForm
  • UserIdentity
  • UsersChartProfileWidget
  • WorkflowBehavior
  • X2ActiveGridView
  • X2ActiveGridViewForSortableWidgets
  • X2AssetManager
  • X2AuthManager
  • X2ChangeLogBehavior
  • X2ClientScript
  • X2Color
  • X2DateUtil
  • X2FixtureManager
  • X2FlowFormatter
  • X2GridView
  • X2GridViewBase
  • X2GridViewForSortableWidgets
  • X2GridViewSortableWidgetsBehavior
  • X2LeadsGridViewProfileWidget
  • X2LinkableBehavior
  • X2ListView
  • X2PillBox
  • X2ProgressBar
  • X2SmartSearchModelBehavior
  • X2TimestampBehavior
  • X2TranslationBehavior
  • X2UrlRule
  • X2WebModule
  • X2Widget
  • X2WidgetList
  • Overview
  • Package
  • Class
  • Tree

Class CronForm

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

CComponent
Extended by CBaseController
Extended by CWidget
Extended by X2Widget
Extended by 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
X2CRM Documentation API documentation generated by ApiGen 2.8.0