ILIAS  trunk Revision v11.0_alpha-1831-g8615d53dadb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager Class Reference
+ Inheritance diagram for ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager:
+ Collaboration diagram for ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager:

Public Member Functions

 __construct (protected JobManager $job_manager)
 
 runActiveJobs (\ilObjUser $actor)
 
 runJobManual (string $jobId, \ilObjUser $actor)
 
 resetJob (\ILIAS\Cron\CronJob $job, \ilObjUser $actor)
 
 activateJob (\ILIAS\Cron\CronJob $job, \ilObjUser $actor, bool $wasManuallyExecuted=false)
 
 deactivateJob (\ILIAS\Cron\CronJob $job, \ilObjUser $actor, bool $wasManuallyExecuted=false)
 
 isJobActive (string $jobId)
 
 isJobInactive (string $jobId)
 
 ping (string $jobId)
 

Private Member Functions

 getValidPhpApis ()
 

Detailed Description

Definition at line 25 of file StrictCliJobManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::__construct ( protected JobManager  $job_manager)

Definition at line 27 of file StrictCliJobManager.php.

28  {
29  }

Member Function Documentation

◆ activateJob()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::activateJob ( \ILIAS\Cron\CronJob  $job,
\ilObjUser  $actor,
bool  $wasManuallyExecuted = false 
)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 58 of file StrictCliJobManager.php.

58  : void
59  {
60  $this->job_manager->activateJob($job, $actor, $wasManuallyExecuted);
61  }

◆ deactivateJob()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::deactivateJob ( \ILIAS\Cron\CronJob  $job,
\ilObjUser  $actor,
bool  $wasManuallyExecuted = false 
)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 63 of file StrictCliJobManager.php.

63  : void
64  {
65  $this->job_manager->deactivateJob($job, $actor, $wasManuallyExecuted);
66  }

◆ getValidPhpApis()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::getValidPhpApis ( )
private
Returns
list<string>

Definition at line 34 of file StrictCliJobManager.php.

Referenced by ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager\runActiveJobs().

34  : array
35  {
36  return [
37  'cli'
38  ];
39  }
+ Here is the caller graph for this function:

◆ isJobActive()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::isJobActive ( string  $jobId)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 68 of file StrictCliJobManager.php.

68  : bool
69  {
70  return $this->job_manager->isJobActive($jobId);
71  }

◆ isJobInactive()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::isJobInactive ( string  $jobId)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 73 of file StrictCliJobManager.php.

73  : bool
74  {
75  return $this->job_manager->isJobInactive($jobId);
76  }

◆ ping()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::ping ( string  $jobId)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 78 of file StrictCliJobManager.php.

78  : void
79  {
80  $this->job_manager->ping($jobId);
81  }

◆ resetJob()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::resetJob ( \ILIAS\Cron\CronJob  $job,
\ilObjUser  $actor 
)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 53 of file StrictCliJobManager.php.

53  : void
54  {
55  $this->job_manager->resetJob($job, $actor);
56  }

◆ runActiveJobs()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::runActiveJobs ( \ilObjUser  $actor)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 41 of file StrictCliJobManager.php.

References ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager\getValidPhpApis().

Referenced by ILIAS\Cron\CLI\Commands\RunActiveJobsCommand\withAuthenticated().

41  : void
42  {
43  if (\in_array(PHP_SAPI, array_map('strtolower', $this->getValidPhpApis()), true)) {
44  $this->job_manager->runActiveJobs($actor);
45  }
46  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ runJobManual()

ILIAS\BackgroundTasks\Task\Job\Manager\StrictCliJobManager::runJobManual ( string  $jobId,
\ilObjUser  $actor 
)

Implements ILIAS\BackgroundTasks\Task\Job\JobManager.

Definition at line 48 of file StrictCliJobManager.php.

48  : bool
49  {
50  return $this->job_manager->runJobManual($jobId, $actor);
51  }

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