Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
CronjobTask Class Reference
Inheritance diagram for CronjobTask:
SimpleORMap

Public Member Functions

 isCore ()
 
 engage ($last_result, $parameters=[])
 
 getValue ($field)
 
 scheduleOnce ($timestamp, $priority=CronjobSchedule::PRIORITY_NORMAL, $parameters=[])
 
 schedulePeriodic ($minute=null, $hour=null, $day=null, $month=null, $day_of_week=null, $priority=CronjobSchedule::PRIORITY_NORMAL, $parameters=[])
 
 extractDefaultParameters ()
 
- Public Member Functions inherited from SimpleORMap
 __construct ($id=null)
 
 __clone ()
 
 getRelationOptions ($relation)
 
 getTableMetadata ()
 
 hasAutoIncrementColumn ()
 
 setId ($id)
 
 getId ()
 
 getNewId ()
 
 toArray ($only_these_fields=null)
 
 toRawArray ($only_these_fields=null)
 
 toArrayRecursive ($only_these_fields=null)
 
 getValue ($field)
 
 getRelationValue ($relation, $field)
 
 getDefaultValue ($field)
 
 setValue ($field, $value)
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 getIterator ()
 
 count ()
 
 isField ($field)
 
 isAdditionalField ($field)
 
 isAliasField ($field)
 
 isI18nField ($field)
 
 setData ($data, $reset=false)
 
 isNew ()
 
 isDeleted ()
 
 setNew ($is_new)
 
 getWhereQuery ()
 
 restore ()
 
 store ()
 
 triggerChdate ()
 
 delete ()
 
 isDirty ()
 
 isFieldDirty ($field)
 
 revertValue ($field)
 
 getPristineValue ($field)
 
 initRelation ($relation)
 
 resetRelation ($relation)
 
 cleanup ()
 

Data Fields

 $valid = false
 
- Data Fields inherited from SimpleORMap
const ID_SEPARATOR = '_'
 

Protected Member Functions

 loadClass ()
 
- Protected Member Functions inherited from SimpleORMap
 _getId ($field)
 
 _setId ($field, $value)
 
 _getAdditionalValueFromRelation ($field)
 
 _setAdditionalValueFromRelation ($field, $value)
 
 _getAdditionalValue ($field)
 
 _setAdditionalValue ($field, $value)
 
 parseRelationOptions ($type, $name, $options)
 
 storeRelations ($only_these=null)
 
 deleteRelations ()
 
 initializeContent ()
 
 applyCallbacks ($type)
 
 cbAutoIncrementColumn ($type)
 
 cbAutoKeyCreation ()
 
 cbNotificationMapper ($cb_type)
 
 cbAfterInitialize ($cb_type)
 
 setSerializedValue ($field, $value)
 
 setI18nValue ($field, $value)
 

Static Protected Member Functions

static configure ($config=[])
 
- Static Protected Member Functions inherited from SimpleORMap
static db_table ()
 
static db_fields ()
 
static pk ()
 
static default_values ()
 
static serialized_fields ()
 
static alias_fields ()
 
static i18n_fields ()
 
static additional_fields ()
 
static has_many ()
 
static has_one ()
 
static belongs_to ()
 
static has_and_belongs_to_many ()
 
static registered_callbacks ()
 
static known_slots ()
 
static notification_map ()
 
static getter_setter_map ()
 
static configure ($config=[])
 
static config ($key)
 
static registerCallback ($types, $cb)
 
static unregisterCallback ($types, $cb)
 

Additional Inherited Members

- Static Public Member Functions inherited from SimpleORMap
static tableScheme ($db_table)
 
static expireTableScheme ()
 
static exists ($id)
 
static countBySql ($sql= '1', $params=[])
 
static create ($data)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=[])
 
static findOneBySQL ($where, $params=[])
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=[])
 
static findMany ($pks=[], $order= '', $order_params=[])
 
static findEachMany ($callable, $pks=[], $order= '', $order_params=[])
 
static findAndMapBySQL ($callable, $where, $params=[])
 
static findAndMapMany ($callable, $pks=[], $order= '', $order_params=[])
 
static deleteBySQL ($where, $params=[])
 
static toObject ($id_or_object)
 
static __callStatic ($name, $arguments)
 
- Static Public Attributes inherited from SimpleORMap
static $schemes = null
 
- Protected Attributes inherited from SimpleORMap
 $content = []
 
 $content_db = []
 
 $is_new = true
 
 $is_deleted = false
 
 $relations = []
 
 $additional_data = []
 
- Static Protected Attributes inherited from SimpleORMap
static $config = []
 
static $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
 
static $performs_batch_operation = false
 

Member Function Documentation

static configure (   $config = [])
staticprotected

Configures the model.

Parameters
Array$configOptional configuration passed from derived class
engage (   $last_result,
  $parameters = [] 
)

Executes the task.

Parameters
String$last_resultResult of last executions
Array$parametersParameters to pass to the task
extractDefaultParameters ( )

Extracts the default parameter values from the associated task.

Returns
array
getValue (   $field)

Proxy the static methods "getDescription", "getName" and "getParameters" from the task class.

Parameters
String$fieldField which should be accessed.
Returns
mixed Value of the method call
isCore ( )

Returns whether the task is defined in the core system or via a plugin.

Returns
bool True if task is defined in core system
loadClass ( )
protected

Tries to load the underlying php class. This also determines the valid state of the task. If the class does not exists, the task is marked as not valid.

scheduleOnce (   $timestamp,
  $priority = CronjobSchedule::PRIORITY_NORMAL,
  $parameters = [] 
)

Schedules this task for a single execution at the provided time.

Parameters
int$timestampWhen the task should be executed
String$priorityPriority of the execution (low, normal, high), defaults to normal
Array$parametersOptional parameters passed to the task
Returns
CronjobSchedule The generated schedule object.
schedulePeriodic (   $minute = null,
  $hour = null,
  $day = null,
  $month = null,
  $day_of_week = null,
  $priority = CronjobSchedule::PRIORITY_NORMAL,
  $parameters = [] 
)

Schedules this task for periodic execution with the provided schedule.

Parameters
mixed$minuteMinute part of the schedule:
  • null for "every minute" a.k.a. "don't care"
  • x < 0 for "every x minutes"
  • x >= 0 for "only at minute x"
mixed$hourHour part of the schedule:
  • null for "every hour" a.k.a. "don't care"
  • x < 0 for "every x hours"
  • x >= 0 for "only at hour x"
mixed$dayDay part of the schedule:
  • null for "every day" a.k.a. "don't care"
  • x < 0 for "every x days"
  • x > 0 for "only at day x"
mixed$monthMonth part of the schedule:
  • null for "every month" a.k.a. "don't care"
  • x < 0 for "every x months"
  • x > 0 for "only at month x"
mixed$day_of_weekDay of week part of the schedule:
  • null for "every day" a.k.a. "don't care"
  • 1 >= x >= 7 for "exactly at day of week x" (x starts with monday at 1 and ends with sunday at 7)
String$priorityPriority of the execution (low, normal, high), defaults to normal
Array$parametersOptional parameters passed to the task
Returns
CronjobSchedule The generated schedule object.

Field Documentation

$valid = false

The documentation for this class was generated from the following file: