Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Settings\Developer\ScheduledTasks::

Allows tasks to be scheduled to run at a certain time

Class Methods

The following static methods are available on this class:
array analyticsGetSums($strColumn, $strDateStart, $strDateEnd, $strInterval, $arrProperties)
Description
Returns the sums of a column over a period
Parameters
$strColumn
string
$strDateStart
string
$strDateEnd
string
$strInterval
string
hour|day|month|year
$arrProperties
array
Return
array
string classGetFolder()
Description
Returns the folder where the class exists
Parameters
none
Return
string
string classGetFolderResources()
Description
Returns the folder where the class's resources exist
Parameters
none
Return
string
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
void deleteAllWithCode($strCode)
Description
Deletes all scheduled tasks with the specified code
Parameters
$strCode
mixed
Return
void
array fieldsCustomGetAll()
Description
Returns all the columns in the custom fields table
Parameters
none
Return
array
array fieldsCustomGetAllExt($bPublic, $bShowInLists, $bSearchable, $arrCustomFilter)
Description
Returns all the columns in the custom fields table
Parameters
$bPublic
mixed
$bShowInLists
mixed
$bSearchable
mixed
$arrCustomFilter
mixed
Return
array
array fieldsGetAll($bCached)
Description
Returns all the columns this component supports
Parameters
$bCached
mixed
Return
array
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of ScheduledTasks
void getAutoIncrementId($arrEntity)
Description
Returns the last inserted id
Parameters
$arrEntity
mixed
Return
void
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
scheduled_task_code
varchar (255)
scheduled_task_datetime
datetime
scheduled_task_id
varchar (16)
scheduled_task_pid
int unsigned (10)
scheduled_task_title
varchar (255)