This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilStudyProgrammeAutoCategoryDBRepository:

Collaboration diagram for ilStudyProgrammeAutoCategoryDBRepository:

Public Member Functions

__construct (ilDBInterface $db, int $current_usr_id)

getFor (int $prg_obj_id)

Read category-surveillance settings of programme.

Returns: ilStudyProgrammeAutoCategory[]

More...

create (int $prg_obj_id, int $category_ref_id, int $last_edited_usr_id=null, DateTimeImmutable $last_edited=null)

Build an auto-category object. More...

update (ilStudyProgrammeAutoCategory $ac)

Store a category-surveillance setting. More...

delete (int $prg_obj_id, array $cat_ref_ids)

Delete a single category-surveillance.

Parameters

int[] $cat_ref_ids

More...

deleteFor (int $prg_obj_id)

Delete all category-surveillance settings for a StudyProgramme. More...

getFor (int $prg_obj_id)

Read category-surveillance settings of programme. More...

create (int $prg_obj_id, int $category_ref_id, int $last_edited_usr_id=null, DateTimeImmutable $last_edited=null)

Build an auto-category object. More...

update (ilStudyProgrammeAutoCategory $ac)

Store a category-surveillance setting. More...

delete (int $prg_obj_id, array $cat_ref_ids)

Delete a single category-surveillance. More...

deleteFor (int $prg_obj_id)

Delete all category-surveillance settings for a StudyProgramme. More...

Static Public Member Functions
static	getProgrammesFor (int $cat_ref_id)
	Get all programmes' ref_ids monitoring the given category. Returns int[] More...

static	getProgrammesFor (int $cat_ref_id)
	Get all programmes' ref_ids monitoring the given category. More...

Protected Attributes
ilDBInterface	$db

int	$current_usr_id

Private Attributes
const	TABLE = 'prg_auto_content'

const	FIELD_PRG_OBJ_ID = 'prg_obj_id'

const	FIELD_CAT_REF_ID = 'cat_ref_id'

const	FIELD_EDITOR_ID = 'last_usr_id'

const	FIELD_LAST_EDITED = 'last_edited'

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilStudyProgrammeAutoCategoryDBRepository

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeAutoCategoryDBRepository::__construct	(	ilDBInterface	$db,
		int	$current_usr_id
	)

Definition at line 37 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

      {
        $this->db = $db;
        $this->current_usr_id = $current_usr_id;
    }

References $current_usr_id, and $db.

Member Function Documentation

◆ create()

ilStudyProgrammeAutoCategoryDBRepository::create	(	int	$prg_obj_id,
		int	$category_ref_id,
		int	$last_edited_usr_id = `null`,
		DateTimeImmutable	$last_edited = `null`
	)

Build an auto-category object.

Implements ilStudyProgrammeAutoCategoryRepository.

Definition at line 75 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

     : ilStudyProgrammeAutoCategory {
        if (is_null($last_edited_usr_id)) {
            $last_edited_usr_id = $this->current_usr_id;
        }
        if (is_null($last_edited)) {
            $last_edited = new DateTimeImmutable();
        }
 
        return new ilStudyProgrammeAutoCategory(
            $prg_obj_id,
            $category_ref_id,
            $last_edited_usr_id,
            $last_edited
        );
    }

References $current_usr_id.

Referenced by getFor().

Here is the caller graph for this function:

◆ delete()

ilStudyProgrammeAutoCategoryDBRepository::delete	(	int	$prg_obj_id,
		array	$cat_ref_ids
	)

Delete a single category-surveillance.

Parameters

int[] $cat_ref_ids

Implements ilStudyProgrammeAutoCategoryRepository.

Definition at line 134 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

                                                               : void
    {
        $ids = array_map(
            function ($id) {
                return $this->db->quote($id, 'integer');
            },
            $cat_ref_ids
        );
        $ids = implode(',', $ids);
 
        $query =
             'DELETE FROM ' . self::TABLE . PHP_EOL
            . 'WHERE prg_obj_id = ' . $this->db->quote($prg_obj_id, 'integer') . PHP_EOL
            . 'AND cat_ref_id IN (' . $ids . ')'
        ;
        $this->db->manipulate($query);
    }

References $id, and $query.

◆ deleteFor()

ilStudyProgrammeAutoCategoryDBRepository::deleteFor ( int $prg_obj_id )

Delete all category-surveillance settings for a StudyProgramme.

Implements ilStudyProgrammeAutoCategoryRepository.

Definition at line 155 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

                                              : void
    {
        $query =
             'DELETE FROM ' . self::TABLE . PHP_EOL
            . 'WHERE prg_obj_id = ' . $this->db->quote($prg_obj_id, 'integer')
        ;
        $this->db->manipulate($query);
    }

References $query.

◆ getFor()

ilStudyProgrammeAutoCategoryDBRepository::getFor ( int $prg_obj_id )

Read category-surveillance settings of programme.

Returns: ilStudyProgrammeAutoCategory[]

Implements ilStudyProgrammeAutoCategoryRepository.

Definition at line 48 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

                                           : array
    {
        $query = 'SELECT '
            . self::FIELD_PRG_OBJ_ID . ','
            . self::FIELD_CAT_REF_ID . ','
            . self::FIELD_EDITOR_ID . ','
            . self::FIELD_LAST_EDITED
            . PHP_EOL . 'FROM ' . self::TABLE
            . PHP_EOL . 'WHERE ' . self::FIELD_PRG_OBJ_ID . ' = '
            . $this->db->quote($prg_obj_id, 'integer');
 
        $res = $this->db->query($query);
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $ret[] = $this->create(
                (int) $rec[self::FIELD_PRG_OBJ_ID],
                (int) $rec[self::FIELD_CAT_REF_ID],
                (int) $rec[self::FIELD_EDITOR_ID],
                new DateTimeImmutable($rec[self::FIELD_LAST_EDITED])
            );
        }
        return $ret;
    }

References $query, $res, and create().

Here is the call graph for this function:

◆ getProgrammesFor()

static ilStudyProgrammeAutoCategoryDBRepository::getProgrammesFor ( int $cat_ref_id )

static

Get all programmes' ref_ids monitoring the given category.

Returns: int[]

Implements ilStudyProgrammeAutoCategoryRepository.

Definition at line 168 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

                                                            : array
    {
        global $ilDB;
        $query = 'SELECT ' . self::FIELD_PRG_OBJ_ID
            . PHP_EOL . 'FROM ' . self::TABLE . ' prgs'
            . PHP_EOL . 'INNER JOIN object_reference oref ON '
            . 'prgs.' . self::FIELD_PRG_OBJ_ID . ' =  oref.obj_id'
            . PHP_EOL . 'WHERE ' . self::FIELD_CAT_REF_ID . ' = ' . $ilDB->quote($cat_ref_id, 'integer')
            . PHP_EOL . 'AND oref.deleted IS NULL';
 
        $res = $ilDB->query($query);
        return $ilDB->fetchAll($res);
    }

References $ilDB, $query, and $res.

◆ update()

ilStudyProgrammeAutoCategoryDBRepository::update ( ilStudyProgrammeAutoCategory $ac )

Store a category-surveillance setting.

Implements ilStudyProgrammeAutoCategoryRepository.

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

                                                            : void
    {
        $ilAtomQuery = $this->db->buildAtomQuery();
        $ilAtomQuery->addTableLock(self::TABLE);
 
        $current_usr_id = $this->current_usr_id;
        $ilAtomQuery->addQueryCallable(
            function (ilDBInterface $db) use ($ac, $current_usr_id) {
                $query =
                      'DELETE FROM ' . self::TABLE . PHP_EOL
                     . 'WHERE prg_obj_id = ' . $ac->getPrgObjId() . PHP_EOL
                     . 'AND cat_ref_id = ' . $ac->getCategoryRefId()
                ;
 
                $db->manipulate($query);
 
                $now = new DateTimeImmutable();
                $now = $now->format('Y-m-d H:i:s');
                $db->insert(
                    self::TABLE,
                    [
                        self::FIELD_PRG_OBJ_ID => ['integer', $ac->getPrgObjId()],
                        self::FIELD_CAT_REF_ID => ['integer', $ac->getCategoryRefId()],
                        self::FIELD_EDITOR_ID => ['integer', $current_usr_id],
                        self::FIELD_LAST_EDITED => ['timestamp', $now]
                    ]
                );
            }
        );
        $ilAtomQuery->run();
    }