ilCertificateQueueRepository Class Reference

Collaboration diagram for ilCertificateQueueRepository:

Public Member Functions
	__construct (private readonly ilDBInterface $database, private readonly ilLogger $logger)
	addToQueue (ilCertificateQueueEntry $certificateQueueEntry)
	removeFromQueue (int $id)
	getAllEntriesFromQueue ()
	removeFromQueueByUserId (int $user_id)

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 24 of file class.ilCertificateQueueRepository.php.

Constructor & Destructor Documentation

__construct()

ilCertificateQueueRepository::__construct	(	private readonly ilDBInterface	$database,
		private readonly ilLogger	$logger
	)

Definition at line 26 of file class.ilCertificateQueueRepository.php.

    {
    }

Member Function Documentation

addToQueue()

ilCertificateQueueRepository::addToQueue

(

ilCertificateQueueEntry

$certificateQueueEntry

)

Definition at line 30 of file class.ilCertificateQueueRepository.php.

References $id, ilCertificateQueueEntry\getAdapterClass(), ilCertificateQueueEntry\getObjId(), ilCertificateQueueEntry\getStartedTimestamp(), ilCertificateQueueEntry\getState(), ilCertificateQueueEntry\getTemplateId(), ilCertificateQueueEntry\getUserId(), and ILIAS\Repository\logger().

                                                                              : void
    {
        $this->logger->debug('START - Add new entry to certificate cron job queue');

        $id = $this->database->nextId('il_cert_cron_queue');

        $row = [
            'id' => ['integer', $id],
            'obj_id' => ['integer', $certificateQueueEntry->getObjId()],
            'usr_id' => ['integer', $certificateQueueEntry->getUserId()],
            'adapter_class' => ['text', $certificateQueueEntry->getAdapterClass()],
            'state' => ['text', $certificateQueueEntry->getState()],
            'started_timestamp' => ['integer', $certificateQueueEntry->getStartedTimestamp()],
            'template_id' => ['integer', $certificateQueueEntry->getTemplateId()],
        ];

        $this->logger->debug(sprintf(
            'Save queue entry with following values: %s',
            json_encode($row, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT)
        ));
        $this->logger->debug('END - Added entry to queue');

        $this->database->insert('il_cert_cron_queue', $row);
    }

Here is the call graph for this function:

getAllEntriesFromQueue()

ilCertificateQueueRepository::getAllEntriesFromQueue

(

)

Returns

ilCertificateQueueEntry[]

Definition at line 69 of file class.ilCertificateQueueRepository.php.

References ILIAS\Repository\logger().

                                            : array
    {
        $this->logger->debug('START - Fetch all entries from queue');

        $sql = 'SELECT * FROM il_cert_cron_queue';
        $query = $this->database->query($sql);

        $result = [];
        while ($row = $this->database->fetchAssoc($query)) {
            $this->logger->debug(sprintf(
                'Queue entry found: "%s"',
                json_encode($row, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT)
            ));

            $result[] = new ilCertificateQueueEntry(
                (int) $row['obj_id'],
                (int) $row['usr_id'],
                $row['adapter_class'],
                $row['state'],
                (int) $row['template_id'],
                (int) $row['started_timestamp'],
                (int) $row['id']
            );
        }

        $this->logger->debug(sprintf('END - All queue entries fetched(Total: "%s")', count($result)));

        return $result;
    }

Here is the call graph for this function:

removeFromQueue()

ilCertificateQueueRepository::removeFromQueue

(

int

$id

)

Definition at line 55 of file class.ilCertificateQueueRepository.php.

References ILIAS\Repository\logger().

                                            : void
    {
        $this->logger->debug(sprintf('START - Remove entry(id: "%s") from queue', $id));

        $sql = 'DELETE FROM il_cert_cron_queue WHERE id = ' . $this->database->quote($id, 'integer');

        $this->database->manipulate($sql);

        $this->logger->debug(sprintf('END - Entry(id: "%s") deleted from queue', $id));
    }

Here is the call graph for this function:

removeFromQueueByUserId()

ilCertificateQueueRepository::removeFromQueueByUserId

(

int

$user_id

)

Definition at line 99 of file class.ilCertificateQueueRepository.php.

References ILIAS\Repository\logger().

                                                         : void
    {
        $this->logger->debug(sprintf('START - Remove entries for user (usr_id: "%s") from queue', $user_id));

        $sql = 'DELETE FROM il_cert_cron_queue WHERE usr_id = ' . $this->database->quote($user_id, 'integer');

        $this->database->manipulate($sql);

        $this->logger->debug(sprintf('END - Entries for user (usr_id: "%s") deleted from queue', $user_id));
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Certificate/classes/Queue/class.ilCertificateQueueRepository.php