Inheritance diagram for ilECSCmsCourseCommandQueueHandler:

Collaboration diagram for ilECSCmsCourseCommandQueueHandler:

Public Member Functions
	__construct (ilECSSetting $server)
	Constructor. More...

	getServer ()
	Get server. More...

	getMid ()
	Get mid. More...

	checkAllocationActivation (ilECSSetting $server, $a_content_id)
	Check if course allocation is activated for one recipient of the. More...

	handleCreate (ilECSSetting $server, $a_content_id)
	Handle create. More...

	handleDelete (ilECSSetting $server, $a_content_id)
	Handle delete. More...

	handleUpdate (ilECSSetting $server, $a_content_id)
	Handle update. More...

Public Member Functions inherited from ilECSCommandQueueHandler
	handleCreate (ilECSSetting $server, int $a_content_id)
	Handle create event. More...

	handleUpdate (ilECSSetting $server, int $a_content_id)
	Handle update. More...

	handleDelete (ilECSSetting $server, int $a_content_id)
	Handle delete action. More...

Protected Member Functions
	doUpdate (int $a_content_id, $course)
	Perform update. More...

Private Member Functions
	readCourse (ilECSSetting $server, $a_content_id)
	Read course from ecs. More...

Private Attributes
ilLogger	$logger

ilECSSetting	$server

int	$mid = 0

Detailed Description

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 23 of file class.ilECSCmsCourseCommandQueueHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSCmsCourseCommandQueueHandler::__construct ( ilECSSetting $server )

Constructor.

Definition at line 34 of file class.ilECSCmsCourseCommandQueueHandler.php.

References $DIC, $server, ILIAS\Repository\logger(), and ILIAS\UI\examples\Progress\Bar\server().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->wsrv();
 
         $this->server = $server;
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkAllocationActivation()

ilECSCmsCourseCommandQueueHandler::checkAllocationActivation	(	ilECSSetting	$server,
			$a_content_id
	)

Check if course allocation is activated for one recipient of the.

Parameters

ilECSSetting	$server
	$a_content_id

Returns: bool

Definition at line 65 of file class.ilECSCmsCourseCommandQueueHandler.php.

References Vendor\Package\$e, ilECSParticipantSetting\getInstance(), ilECSNodeMappingSettings\getInstanceByServerMid(), getMid(), getServer(), and ILIAS\Repository\logger().

Referenced by handleCreate(), and handleUpdate().

                                                                                   : ?bool
     {
         try {
             $crs_reader = new ilECSCourseConnector($server);
             $details = $crs_reader->getCourse($a_content_id, true);
             $this->mid = $details->getMySender();
 
             // Check if import is enabled
             $part = ilECSParticipantSetting::getInstance($this->getServer()->getServerId(), $this->getMid());
             if (!$part->isImportEnabled()) {
                 $this->logger->info(__METHOD__ . ': Import disabled for mid ' . $this->getMid());
                 return false;
             }
             // Check course allocation setting
             $gl_settings = ilECSNodeMappingSettings::getInstanceByServerMid(
                 $this->getServer()->getServerId(),
                 $this->getMid()
             );
             $enabled = $gl_settings->isCourseAllocationEnabled();
             if (!$enabled) {
                 $this->logger->info(__METHOD__ . ': Course allocation disabled for ' . $this->getMid());
             }
             return $enabled;
         } catch (ilECSConnectorException $e) {
             $this->logger->error(__METHOD__ . ': Reading course details failed with message ' . $e->getMessage());
             return false;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilECSCmsCourseCommandQueueHandler::doUpdate	(	int	$a_content_id,
			$course
	)

protected

Perform update.

Definition at line 148 of file class.ilECSCmsCourseCommandQueueHandler.php.

References getServer(), and ILIAS\Repository\logger().

Referenced by handleCreate(), and handleUpdate().

                                                            : void
     {
         $this->logger->info(__METHOD__ . ': Starting course creation/update');
 
         $creation_handler = new ilECSCourseCreationHandler($this->getServer(), $this->mid);
         $creation_handler->handle($a_content_id, $course);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMid()

ilECSCmsCourseCommandQueueHandler::getMid ( )

Get mid.

Definition at line 54 of file class.ilECSCmsCourseCommandQueueHandler.php.

References $mid.

Referenced by checkAllocationActivation().

                             : int
     {
         return $this->mid;
     }

Here is the caller graph for this function:

◆ getServer()

ilECSCmsCourseCommandQueueHandler::getServer ( )

Get server.

Definition at line 46 of file class.ilECSCmsCourseCommandQueueHandler.php.

References $server.

Referenced by checkAllocationActivation(), and doUpdate().

                                : ilECSSetting
     {
         return $this->server;
     }

Here is the caller graph for this function:

◆ handleCreate()

ilECSCmsCourseCommandQueueHandler::handleCreate	(	ilECSSetting	$server,
			$a_content_id
	)

Handle create.

Definition at line 98 of file class.ilECSCmsCourseCommandQueueHandler.php.

References Vendor\Package\$e, checkAllocationActivation(), doUpdate(), ILIAS\Repository\logger(), and readCourse().

                                                                      : bool
     {
         if (!$this->checkAllocationActivation($server, $a_content_id)) {
             return true;
         }
         try {
             $course = $this->readCourse($server, $a_content_id);
             $this->logger->info(__METHOD__ . ': ' . print_r($course, true));
             $this->doUpdate($a_content_id, $course);
             return true;
         } catch (ilECSConnectorException $e) {
             $this->logger->error(__METHOD__ . ': Course creation failed  with mesage ' . $e->getMessage());
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ handleDelete()

ilECSCmsCourseCommandQueueHandler::handleDelete	(	ilECSSetting	$server,
			$a_content_id
	)

Handle delete.

Definition at line 118 of file class.ilECSCmsCourseCommandQueueHandler.php.

                                                                      : bool
     {
         // nothing todo
         return true;
     }

◆ handleUpdate()

ilECSCmsCourseCommandQueueHandler::handleUpdate	(	ilECSSetting	$server,
			$a_content_id
	)

Handle update.

Definition at line 127 of file class.ilECSCmsCourseCommandQueueHandler.php.

References Vendor\Package\$e, checkAllocationActivation(), doUpdate(), ILIAS\Repository\logger(), and readCourse().

                                                                      : bool
     {
         if (!$this->checkAllocationActivation($server, $a_content_id)) {
             return true;
         }
 
         try {
             $course = $this->readCourse($server, $a_content_id);
             $this->doUpdate($a_content_id, $course);
             return true;
         } catch (ilECSConnectorException $e) {
             $this->logger->error(__METHOD__ . ': Course creation failed  with mesage ' . $e->getMessage());
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ readCourse()

ilECSCmsCourseCommandQueueHandler::readCourse	(	ilECSSetting	$server,
			$a_content_id
	)

private

Read course from ecs.

Definition at line 159 of file class.ilECSCmsCourseCommandQueueHandler.php.

Referenced by handleCreate(), and handleUpdate().

     {
         return (new ilECSCourseConnector($server))->getCourse($a_content_id, false);
     }

Here is the caller graph for this function:

Field Documentation

◆ $logger

ilLogger ilECSCmsCourseCommandQueueHandler::$logger

private

Definition at line 25 of file class.ilECSCmsCourseCommandQueueHandler.php.

◆ $mid

int ilECSCmsCourseCommandQueueHandler::$mid = 0

private

Definition at line 28 of file class.ilECSCmsCourseCommandQueueHandler.php.

Referenced by getMid().

◆ $server

ilECSSetting ilECSCmsCourseCommandQueueHandler::$server

private

Definition at line 27 of file class.ilECSCmsCourseCommandQueueHandler.php.

Referenced by __construct(), and getServer().

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

components/ILIAS/WebServices/ECS/classes/Course/class.ilECSCmsCourseCommandQueueHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAllocationActivation()

◆ doUpdate()

◆ getMid()

◆ getServer()

◆ handleCreate()

◆ handleDelete()

◆ handleUpdate()

◆ readCourse()

Field Documentation

◆ $logger

◆ $mid

◆ $server