Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ExecRuleHelper

Fonctions membres publiques

 __construct ($task)
 
 nextExec (bool $string=true, bool $basisNow=false)
 

Fonctions membres privées

 getFromTask (string $property, $default=null)
 
 dateTimeToSql (\DateTime $dateTime)
 

Attributs privés

 $type
 
 $task
 
 $rule
 

Description détaillée

Helper class for supporting task execution rules.

Depuis
4.1.0
Voir également
Task} class.

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $task)
Paramètres
array | object$taskA task entry
Depuis
4.1.0

Références $task, et ArrayHelper\fromObject().

Documentation des fonctions membres

◆ dateTimeToSql()

dateTimeToSql ( \DateTime  $dateTime)
private

Returns a sql-formatted string for a DateTime object. Only needed for DateTime objects returned by CronExpression, JDate supports this as class method.

Paramètres
\DateTime$dateTimeA DateTime object to format
Renvoie
string
Depuis
4.1.0

Références $db, class, et Factory\getContainer().

◆ getFromTask()

getFromTask ( string  $property,
  $default = null 
)
private

Get a property from the task array

Paramètres
string$propertyThe property to get
mixed$defaultThe default value returned if property does not exist
Renvoie
mixed
Depuis
4.1.0

Références $default, et ArrayHelper\getValue().

◆ nextExec()

nextExec ( bool  $string = true,
bool  $basisNow = false 
)
Paramètres
boolean$stringIf true, an SQL formatted string is returned.
boolean$basisNowIf true, the current date-time is used as the basis for projecting the next execution.
Renvoie
?Date|string
Depuis
4.1.0
Exceptions

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

Documentation des champs

◆ $rule

$rule
private

◆ $task

$task
private

◆ $type

$type
private

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