ilCertificateQueueRepository Class Reference

Collaboration diagram for ilCertificateQueueRepository:

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

Private Attributes
	$database
	$logger

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCertificateQueueRepository::__construct	(	\ilDBInterface	$database,
		ilLogger	$logger
	)

Parameters

ilDBInterface	$database
ilLogger	$logger

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

    {
        $this->database = $database;
        $this->logger = $logger;
    }

References $database, and $logger.

Member Function Documentation

addToQueue()

ilCertificateQueueRepository::addToQueue

(

ilCertificateQueueEntry

$certificateQueueEntry

)

Parameters

ilCertificateQueueEntry

$certificateQueueEntry

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

    {
        $this->logger->info('START - Add new entry to certificate cron job queue');
 
        $id = $this->database->nextId('il_cert_cron_queue');
 
        $row = array(
            'id' => array('integer', $id),
            'obj_id' => array('integer', $certificateQueueEntry->getObjId()),
            'usr_id' => array('integer', $certificateQueueEntry->getUserId()),
            'adapter_class' => array('text', $certificateQueueEntry->getAdapterClass()),
            'state' => array('text', $certificateQueueEntry->getState()),
            'started_timestamp' => array('integer', $certificateQueueEntry->getStartedTimestamp()),
            'template_id' => array('integer', $certificateQueueEntry->getTemplateId()),
 
        );
 
        $this->logger->debug(sprintf('Save queue entry with following values: %s', json_encode($row, JSON_PRETTY_PRINT)));
        $this->logger->info(sprintf('END - Added entry to queue'));
 
        $this->database->insert('il_cert_cron_queue', $row);
    }

References ilCertificateQueueEntry\getAdapterClass(), ilCertificateQueueEntry\getObjId(), ilCertificateQueueEntry\getStartedTimestamp(), ilCertificateQueueEntry\getState(), ilCertificateQueueEntry\getTemplateId(), and ilCertificateQueueEntry\getUserId().

Here is the call graph for this function:

getAllEntriesFromQueue()

ilCertificateQueueRepository::getAllEntriesFromQueue

(

)

Returns

array

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

    {
        $this->logger->info('START - Fetch all entries from queue');
 
        $sql = 'SELECT * FROM il_cert_cron_queue';
        $query = $this->database->query($sql);
 
        $result = array();
        while ($row = $this->database->fetchAssoc($query)) {
            $this->logger->debug(sprintf('Queue entry found: "%s"', json_encode($row, JSON_PRETTY_PRINT)));
 
            $result[] = new ilCertificateQueueEntry(
                $row['obj_id'],
                $row['usr_id'],
                $row['adapter_class'],
                $row['state'],
                $row['template_id'],
                $row['started_timestamp'],
                $row['id']
            );
        }
 
        $this->logger->info(sprintf('END - All queue entries fetched(Total: "%s")', count($result)));
 
        return $result;
    }

References $query, and $result.

removeFromQueue()

ilCertificateQueueRepository::removeFromQueue

(

$id

)

Parameters

integer

$id

Exceptions

ilDatabaseException

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

    {
        $this->logger->info(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->info(sprintf('END - Entry(id: "%s") deleted from queue', $id));
    }

removeFromQueueByUserId()

ilCertificateQueueRepository::removeFromQueueByUserId

(

int

$user_id

)

Parameters

int

$user_id

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

    {
        $this->logger->info(sprintf('START - Remove entries for user(user_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->info(sprintf('END - Entries for user(user_id: "%s") deleted from queue', $user_id));
    }

Field Documentation

$database

ilCertificateQueueRepository::$database

private

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

Referenced by __construct().

$logger

ilCertificateQueueRepository::$logger

private

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

Referenced by __construct().

---

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

• Services/Certificate/classes/Queue/class.ilCertificateQueueRepository.php