Référence de la classe TaskModel

Graphe d'héritage de TaskModel:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	getForm ($data=array(), $loadData=true)
	getTable ($name='Task', $prefix='Table', $options=array())
	getItem ($pk=null)
	getTask (array $options=[])
	save ($data)
Fonctions membres publiques hérités de AdminModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	batch ($commands, $pks, $contexts)
	checkin ($pks=array())
	checkout ($pk=null)
	delete (&$pks)
	getItem ($pk=null)
	publish (&$pks, $value=1)
	reorder ($pks, $delta=0)
	save ($data)
	saveorder ($pks=array(), $order=null)
	generateTitle ($categoryId, $table)
	initBatch ()
	editAssociations ($data)
Fonctions membres publiques hérités de FormModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	checkin ($pk=null)
	checkout ($pk=null)
	validate ($form, $data, $group=null)
Fonctions membres publiques hérités de BaseDatabaseModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getTable ($name='', $prefix='', $options=array())
	isCheckedOut ($item)
	getDbo ()
	setDbo (DatabaseInterface $db=null)
	__get ($name)
Fonctions membres publiques hérités de BaseModel
	__construct ($config=array())
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
Fonctions membres publiques hérités de StatefulModelInterface
	getState ($property=null, $default=null)
	setState ($property, $value=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de CurrentUserInterface
	setCurrentUser (User $currentUser)
Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
	setCacheControllerFactory (CacheControllerFactoryInterface $factory)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres publiques statiques
static	configureTaskGetterOptions (OptionsResolver $resolver)
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')

Champs de données
const	TASK_TABLE = '#__scheduler_tasks'
	$typeAlias = 'com_scheduler.task'
Champs de données hérités de AdminModel
	$typeAlias

Fonctions membres protégées
	canDelete ($record)
	populateState ()
	preprocessForm (Form $form, $data, $group='content')
Fonctions membres protégées hérités de AdminModel
	batchAccess ($value, $pks, $contexts)
	batchCopy ($value, $pks, $contexts)
	cleanupPostBatchCopy (TableInterface $table, $newId, $oldId)
	batchLanguage ($value, $pks, $contexts)
	batchMove ($value, $pks, $contexts)
	batchTag ($value, $pks, $contexts)
	canDelete ($record)
	canEditState ($record)
	generateNewTitle ($categoryId, $alias, $title)
	getReorderConditions ($table)
	populateState ()
	prepareTable ($table)
	checkCategoryId ($categoryId)
	redirectToAssociations ($data)
Fonctions membres protégées hérités de BaseDatabaseModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix='Table', $config=array())
	bootComponent ($component)
	dispatchEvent (EventInterface $event)

Attributs protégés
const	TASK_STATES
	$text_prefix = 'COM_SCHEDULER'
	$app
	$event_before_unlock = null
	$event_unlock = null
Attributs protégés hérités de AdminModel
	$text_prefix = null
	$event_after_delete = null
	$event_after_save = null
	$event_before_delete = null
	$event_before_save = null
	$event_before_change_state = null
	$event_change_state = null
	$event_before_batch = null
	$batch_copymove = 'category_id'
	$batch_commands
	$associationsContext = null
	$batchSet = null
	$user = null
	$table = null
	$tableClassName = null
	$contentType = null
	$type = null
Attributs protégés hérités de FormModel
	$events_map = null
Attributs protégés hérités de BaseDatabaseModel
	$option = null
	$event_clean_cache = null
Attributs protégés hérités de BaseModel
	$name
Attributs protégés hérités de CMSObject
	$_errors = array()

Fonctions membres privées
	processExecutionRules (array $unprocessedRules)
	buildExecutionRules (array $executionRules)
	wildcardIfMatch (array $target, array $reference, bool $targetToInt=false)

Membres hérités additionnels
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

MVC Model to interact with the Scheduler DB. Implements methods to add, remove, edit tasks.

Depuis

4.1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(		$config = array(),
		MVCFactoryInterface	$factory = null,
		FormFactoryInterface	$formFactory = null
	)

TaskModel constructor. Needed just to set $app

Paramètres

array	$config	An array of configuration options
MVCFactoryInterface | null	$factory	The factory
FormFactoryInterface | null	$formFactory	The form factory

Depuis

4.1.0

Exceptions

Références $config, Symfony\Contracts\Service\__construct(), elseif, et Factory\getApplication().

Documentation des fonctions membres

buildExecutionRules()

buildExecutionRules ( array  $executionRules )

private

Private method to build execution expression from input execution rules. This expression is used internally to determine execution times/conditions.

Paramètres

array

$executionRules

Execution rules from the Task form, post-processing.

Renvoie

array

Depuis

4.1.0

Exceptions

canDelete()

canDelete (   $record )

protected

Determine whether a record may be deleted taking into consideration the user's permissions over the record.

Paramètres

object

$record

The database row/record in question

Renvoie

boolean True if the record may be deleted

Depuis

4.1.0

Exceptions

configureTaskGetterOptions()

static configureTaskGetterOptions ( OptionsResolver  $resolver )

static

Set up an {

Voir également

OptionsResolver} to resolve options compatible with the {

GetTask()} method.

Paramètres

OptionsResolver

$resolver

The {

Voir également

OptionsResolver} instance to set up.

Renvoie

OptionsResolver

Depuis

4.1.0

Exceptions

AccessException

Références OptionsResolver\setDefaults().

getForm()

getForm	(		$data = array(),
			$loadData = true
	)

Fetches the form object associated with this model. By default, loads the corresponding data from the DB and binds it with the form.

Paramètres

array	$data	Data that needs to go into the form
bool	$loadData	Should the form load its data from the DB?

Renvoie

Form|boolean A JForm object on success, false on failure.

Depuis

4.1.0

Exceptions

loadForm() (defined by FormBehaviourTrait) also loads the form data by calling loadFormData() : $data [implemented here] and binds it to the form by calling $form->bind($data).

Implémente FormModelInterface.

Références $form, $this, $user, Form\addFieldPath(), Joomla\CMS\MVC\Model\getState(), JPATH_ADMINISTRATOR, Joomla\CMS\MVC\Model\loadForm(), et null.

getItem()

getItem

(

$pk = null

)

Overloads the parent getItem() method.

Paramètres

integer

$pk

Primary key

Renvoie

object|boolean Object on success, false on failure

Depuis

4.1.0

Exceptions

Références $item, et $this.

getTable()

getTable	(		$name = 'Task',
			$prefix = 'Table',
			$options = array()
	)

Don't need to define this method since the parent getTable() implicitly deduces $name and $prefix anyways. This makes the object more transparent though.

Paramètres

string	$name	Name of the table
string	$prefix	Class prefix
array	$options	Model config array

Renvoie

Table

Depuis

4.1.0

Exceptions

Références $name, $options, et $prefix.

getTask()

getTask

(

array

$options = []

)

Get a task from the database, only if an exclusive "lock" on the task can be acquired. The method supports options to customise the limitations on the fetch.

Paramètres

array

$options

Array with options to fetch the task: id: Optional id of the task to fetch. allowDisabled: If true, disabled tasks can also be fetched. (default: false) bypassScheduling: If true, tasks that are not due can also be fetched. Should only be true if an id is targeted instead of the task queue. (default: false) allowConcurrent: If true, fetches even when another task is running ('locked'). (default: false) includeCliExclusive: If true, can also fetch CLI exclusive tasks. (default: true)

Renvoie

? Task entry as in the database.

Depuis

4.1.0

Exceptions

UndefinedOptionsException|InvalidOptionsException

Références $db, $now, $options, $task, Joomla\Database\getDatabase(), Factory\getDate(), ParameterType\INTEGER, null, et ParameterType\STRING.

populateState()

populateState ( )

protected

Populate the model state, we use these instead of toying with input or the global state

Renvoie

void

Depuis

4.1.0

Exceptions

Références $app, ComponentHelper\getParams(), et Joomla\CMS\MVC\Model\setState().

preprocessForm()

preprocessForm ( Form  $form,   $data,   $group = 'content'  )

protected

Method to allow derived classes to preprocess the form.

Paramètres

Form	$form	A Form object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie

void

Depuis

4.1.0

Exceptions

Références $data, $form, PluginHelper\importPlugin(), et Joomla\CMS\MVC\Model\preprocessForm().

processExecutionRules()

processExecutionRules ( array  $unprocessedRules )

private

Clean up and standardise execution rules

Paramètres

array

$unprocessedRules

The form data [? can just replace with execution_interval]

Renvoie

array Processed rules

Depuis

4.1.0

save()

save

(

$data

)

Paramètres

array

$data

The form data

Renvoie

boolean True on success, false on failure

Depuis

4.1.0

Exceptions

Références $data, $id, Factory\getDate(), Joomla\CMS\MVC\Model\getState(), et null.

wildcardIfMatch()

wildcardIfMatch ( array  $target, array  $reference, bool  $targetToInt = false  )

private

Determine if an array is populated by all its possible values by comparison to a reference array, if found a match a wildcard '*' is returned.

Paramètres

array	$target	The target array
array	$reference	The reference array, populated by the complete set of possible values in $target
bool	$targetToInt	If true, converts $target array values to integers before comparing

Renvoie

string A wildcard string if $target is fully populated, else $target itself.

Depuis

4.1.0

Références $target.

Documentation des champs

$app

AdministratorApplication $app

protected

The Application object, for convenience

Depuis

4.1.0

$event_before_unlock

$event_before_unlock = null

protected

$event_unlock

$event_unlock = null

protected

$text_prefix

$text_prefix = 'COM_SCHEDULER'

protected

$typeAlias

$typeAlias = 'com_scheduler.task'

TASK_STATES

const TASK_STATES

protected

Valeur initiale :

= [
        'enabled'  => 1

TASK_TABLE

const TASK_TABLE = '#__scheduler_tasks'

---

La documentation de cette classe a été générée à partir du fichier suivant :

• TaskModel.php