ilUserCertificateTableProvider Class Reference

Collaboration diagram for ilUserCertificateTableProvider:

Public Member Functions
	__construct (private readonly ilDBInterface $database, private readonly ilLogger $logger, private readonly string $defaultTitle)
	fetchDataSet (int $userId, array $params, array $filter)

Data Fields
const	TABLE_NAME = 'il_cert_user_cert'

Protected Member Functions
	getOrderByPart (array $params, array $filter)

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilUserCertificateTableProvider::__construct	(	private readonly ilDBInterface	$database,
		private readonly ilLogger	$logger,
		private readonly string	$defaultTitle
	)

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

      {
    }

Member Function Documentation

fetchDataSet()

ilUserCertificateTableProvider::fetchDataSet	(	int	$userId,
		array	$params,
		array	$filter
	)

Parameters

array<string,mixed>	$params
array<string,mixed>	$filter

Returns

array{cnt: int, items: array<int, array>}

Definition at line 40 of file class.ilUserCertificateTableProvider.php.

References $data, getOrderByPart(), ILIAS\Repository\int(), and ILIAS\Repository\logger().

                                                                           : array
    {
        $this->logger->debug(sprintf('START - Fetching all active certificates for user: "%s"', $userId));
        $additional_select = '';
        if (
            $this->database->tableColumnExists('il_cert_user_cert', 'background_image_path') &&
            $this->database->tableColumnExists('il_cert_user_cert', 'tile_image_path')
        ) {
            $additional_select =
               self::TABLE_NAME . '.tile_image_path,
               ' . self::TABLE_NAME . '.tile_image_ident,';
        }

        $sql = 'SELECT 
  ' . self::TABLE_NAME . '.id,
  ' . self::TABLE_NAME . '.obj_type,
  ' . self::TABLE_NAME . '.acquired_timestamp,
  ' . self::TABLE_NAME . '.tile_image_ident,
  ' . $additional_select . ' usr_data.firstname,
  usr_data.lastname,
  ' . self::TABLE_NAME . '.obj_id,
  (CASE
    WHEN (trans.title IS NOT NULL AND LENGTH(trans.title) > 0) THEN trans.title
    WHEN (object_data.title IS NOT NULL AND LENGTH(object_data.title) > 0) THEN object_data.title 
    WHEN (object_data_del.title IS NOT NULL AND LENGTH(object_data_del.title) > 0) THEN object_data_del.title 
    ELSE ' . $this->database->quote($this->defaultTitle, 'text') . '
    END
  ) as title,
  (CASE
    WHEN (trans.description IS NOT NULL AND LENGTH(trans.description) > 0) THEN trans.description
    WHEN (object_data.description IS NOT NULL AND LENGTH(object_data.description) > 0) THEN object_data.description 
    WHEN (object_data_del.description IS NOT NULL AND LENGTH(object_data_del.description) > 0) THEN object_data_del.description 
    ELSE ""
    END
  ) as description
FROM ' . self::TABLE_NAME . '
LEFT JOIN object_data ON object_data.obj_id = ' . self::TABLE_NAME . '.obj_id
LEFT JOIN object_translation trans ON trans.obj_id = object_data.obj_id
AND trans.lang_code = ' . $this->database->quote($params['language'], 'text') . '
LEFT JOIN object_data_del ON object_data_del.obj_id = ' . self::TABLE_NAME . '.obj_id
LEFT JOIN usr_data ON usr_data.usr_id = ' . self::TABLE_NAME . '.usr_id
WHERE ' . self::TABLE_NAME . '.usr_id = ' . $this->database->quote($userId, 'integer') . ' AND currently_active = 1';

        if ([] !== $params) {
            $sql .= $this->getOrderByPart($params, $filter);
        }

        if (isset($params['limit'])) {
            if (!is_numeric($params['limit'])) {
                throw new InvalidArgumentException('Please provide a valid numerical limit.');
            }

            if (!isset($params['offset'])) {
                $params['offset'] = 0;
            } elseif (!is_numeric($params['offset'])) {
                throw new InvalidArgumentException('Please provide a valid numerical offset.');
            }

            $this->database->setLimit($params['limit'], $params['offset']);
        }

        $query = $this->database->query($sql);

        $data = [
            'items' => [],
        ];

        while ($row = $this->database->fetchAssoc($query)) {
            $title = $row['title'];

            $data['items'][] = [
                'id' => (int) $row['id'],
                'title' => $title,
                'obj_id' => (int) $row['obj_id'],
                'obj_type' => $row['obj_type'],
                'date' => (int) $row['acquired_timestamp'],
                'tile_image_path' => $row['tile_image_path'] ?? '',
                'tile_image_ident' => $row['tile_image_ident'],
                'description' => $row['description'],
                'firstname' => $row['firstname'],
                'lastname' => $row['lastname'],
            ];
        }

        if (isset($params['limit'])) {
            $cnt_sql = '
                                SELECT COUNT(*) cnt
                                FROM ' . self::TABLE_NAME . '
                                WHERE usr_id = ' . $this->database->quote($userId, 'integer') . ' AND currently_active = 1';

            $row_cnt = $this->database->fetchAssoc($this->database->query($cnt_sql));

            $data['cnt'] = (int) $row_cnt['cnt'];

            $this->logger->debug(
                sprintf(
                    'All active certificates for user: "%s" total: "%s"',
                    $userId,
                    $data['cnt']
                )
            );
        } else {
            $data['cnt'] = count($data['items']);
        }

        $this->logger->debug(sprintf('END - Actual results: "%s"', json_encode($data, JSON_THROW_ON_ERROR)));

        return $data;
    }

Here is the call graph for this function:

getOrderByPart()

ilUserCertificateTableProvider::getOrderByPart ( array  $params, array  $filter  )

protected

Definition at line 150 of file class.ilUserCertificateTableProvider.php.

Referenced by fetchDataSet().

                                                                   : string
    {
        if (isset($params['order_field'])) {
            if (!is_string($params['order_field'])) {
                throw new InvalidArgumentException('Please provide a valid order field.');
            }

            if (!in_array($params['order_field'], ['date', 'id', 'title'])) {
                throw new InvalidArgumentException('Please provide a valid order field.');
            }

            if ($params['order_field'] === 'date') {
                $params['order_field'] = 'acquired_timestamp';
            }

            if (!isset($params['order_direction'])) {
                $params['order_direction'] = 'ASC';
            } elseif (!in_array(strtolower($params['order_direction']), ['asc', 'desc'])) {
                throw new InvalidArgumentException('Please provide a valid order direction.');
            }

            return ' ORDER BY ' . $params['order_field'] . ' ' . $params['order_direction'];
        }

        return '';
    }

Here is the caller graph for this function:

Field Documentation

TABLE_NAME

const ilUserCertificateTableProvider::TABLE_NAME = 'il_cert_user_cert'

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

---

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

• components/ILIAS/Certificate/classes/User/class.ilUserCertificateTableProvider.php