Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe TaskTable
+ Graphe d'héritage de TaskTable:

Fonctions membres publiques

 __construct (DatabaseDriver $db)
 
 check ()
 
 store ($updateNulls=true)
 
 bind ($src, $ignore=array())
 
 unlock (array $pks=[], ?int $userId=null)
 
- Fonctions membres publiques hérités de Table
 __construct ($table, $key, DatabaseDriver $db, DispatcherInterface $dispatcher=null)
 
 getFields ($reload=false)
 
 appendPrimaryKeys ($query, $pk=null)
 
 getTableName ()
 
 getKeyName ($multiple=false)
 
 getId ()
 
 getDbo ()
 
 setDbo (DatabaseDriver $db)
 
 setRules ($input)
 
 getRules ()
 
 reset ()
 
 bind ($src, $ignore=array())
 
 load ($keys=null, $reset=true)
 
 check ()
 
 save ($src, $orderingFilter='', $ignore='')
 
 checkOut ($userId, $pk=null)
 
 checkIn ($pk=null)
 
 hasPrimaryKey ()
 
 hit ($pk=null)
 
 isCheckedOut ($with=0, $against=null)
 
 getNextOrder ($where='')
 
 getPrimaryKey (array $keys=array())
 
 reorder ($where='')
 
 move ($delta, $where='')
 
 publish ($pks=null, $state=1, $userId=0)
 
 getColumnAlias ($column)
 
 setColumnAlias ($column, $columnAlias)
 
 hasField ($key)
 
- 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 TableInterface
 delete ($pk=null)
 
 getKeyName ()
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 

Champs de données

 $created
 
 $title
 
 $typeAlias = 'com_scheduler.task'
 
- Champs de données hérités de Table
 $typeAlias = null
 

Fonctions membres protégées

 _getAssetName ()
 
- Fonctions membres protégées hérités de Table
 _getAssetName ()
 
 _getAssetTitle ()
 
 _lock ()
 
 _unlock ()
 

Attributs protégés

 $_supportNullValue = true
 
 $_jsonEncode = ['params', 'execution_rules', 'cron_rules']
 
- Attributs protégés hérités de Table
 $_tbl = ''
 
 $_tbl_key = ''
 
 $_tbl_keys = array()
 
 $_db
 
 $_trackAssets = false
 
 $_rules
 
 $_locked = false
 
 $_autoincrement = true
 
 $_columnAlias = array()
 
 $_jsonEncode = array()
 
 $_supportNullValue = false
 
- Attributs protégés hérités de CMSObject
 $_errors = array()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Table
static getInstance ($type, $prefix='JTable', $config=array())
 
static addIncludePath ($path=null)
 

Description détaillée

Table class for tasks scheduled through com_scheduler. The type alias for Task table entries is com_scheduler.task.

Depuis
4.1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( DatabaseDriver  $db)

TaskTable constructor override, needed to pass the DB table name and primary key to {

Voir également
Table::__construct()}.
Paramètres
DatabaseDriver$dbA database connector object.
Depuis
4.1.0

Références $db, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ _getAssetName()

_getAssetName ( )
protected

Returns the asset name of the entry as it appears in the {

Voir également
Asset} table.
Renvoie
string The asset name.
Depuis
4.1.0

◆ bind()

bind (   $src,
  $ignore = array() 
)

Override {

Voir également
Table::bind()} to bind some fields even if they're null given they're present in $src. This override is needed specifically for DATETIME fields, of which the next_execution field is updated to null if a task is configured to execute only on manual trigger.
Paramètres
array | object$srcAn associative array or object to bind to the Table instance.
array | string$ignoreAn optional array or space separated list of properties to ignore while binding.
Renvoie
boolean
Depuis
4.1.0

Implémente TableInterface.

Références $field, et $fields.

◆ check()

check ( )

Overloads {

Voir également
Table::check()} to perform sanity checks on properties and make sure they're safe to store.
Renvoie
boolean True if checks pass.
Depuis
4.1.0
Exceptions

Implémente TableInterface.

Références ENT_QUOTES, Factory\getApplication(), et Factory\getDate().

◆ store()

store (   $updateNulls = true)

Override {

Voir également
Table::store()} to update null fields as a default, which is needed when DATETIME fields need to be updated to NULL. This override is needed because {
AdminModel::save()} does not expose an option to pass true to Table::store(). Also ensures the created and created_by fields are set.
Paramètres
boolean$updateNullsTrue to update fields even if they're null.
Renvoie
boolean True if successful.
Depuis
4.1.0
Exceptions

Implémente TableInterface.

Références Factory\getApplication(), et Factory\getDate().

◆ unlock()

unlock ( array  $pks = [],
?int  $userId = null 
)

Release pseudo-locks on a set of task records. If an empty set is passed, this method releases lock on its instance primary key, if available.

Paramètres
integer[]$pks An optional array of primary key values to update. If not set the instance property value is used.
?int$userId ID of the user unlocking the tasks.
Renvoie
boolean True on success; false if $pks is empty.
Depuis
4.1.0
Exceptions
QueryTypeAlreadyDefinedException|

Références $key, $query, $this, $userId, Text\_(), AbstractEvent\create(), Joomla\CMS\Application\getDispatcher(), et null.

Documentation des champs

◆ $_jsonEncode

$_jsonEncode = ['params', 'execution_rules', 'cron_rules']
protected

◆ $_supportNullValue

$_supportNullValue = true
protected

◆ $created

$created

◆ $title

$title

◆ $typeAlias

$typeAlias = 'com_scheduler.task'

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