ilStudyProgrammeAutoCategoryDBRepository Class Reference

Class ilStudyProgrammeAutoCategoryDBRepository. More...

Inheritance diagram for ilStudyProgrammeAutoCategoryDBRepository:

Collaboration diagram for ilStudyProgrammeAutoCategoryDBRepository:

Public Member Functions
	__construct (ilDBInterface $db, int $current_usr_id)
	readFor (int $prg_obj_id)
	Read category-surveillance settings of programme. Parameters int $prg_obj_id 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. Returns ilStudyProgrammeAutoCategory More...
	update (ilStudyProgrammeAutoCategory $ac)
	Store a category-surveillance setting. Parameters ilStudyProgrammeAutoCategory $ac More...
	delete (int $prg_obj_id, array $cat_ref_ids)
	Delete a single category-surveillance. Parameters int $prg_obj_id int[] $cat_ref_ids More...
	deleteFor (int $prg_obj_id)
	Delete all category-surveillance settings for a StudyProgramme. Parameters int $prg_obj_id More...

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

Data Fields
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'

Protected Attributes
	$db
	$current_usr_id

Detailed Description

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 10 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

Constructor & Destructor Documentation

__construct()

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

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

References $current_usr_id, and $db.

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

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.

Returns

ilStudyProgrammeAutoCategory

Implements ilStudyProgrammeAutoCategoryRepository.

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

References $current_usr_id.

Referenced by readFor().

      : 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
        );
    }

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	$prg_obj_id
	int[]	$cat_ref_ids

Implements ilStudyProgrammeAutoCategoryRepository.

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

References $query.

    {
        $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);
    }

deleteFor()

ilStudyProgrammeAutoCategoryDBRepository::deleteFor

(

int

$prg_obj_id

)

Delete all category-surveillance settings for a StudyProgramme.

Parameters

int

$prg_obj_id

Implements ilStudyProgrammeAutoCategoryRepository.

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

References $query.

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

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 152 of file class.ilStudyProgrammeAutoCategoryDBRepository.php.

References $ilDB, $query, $res, and $ret.

                                                             : 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);
        $ret = $ilDB->fetchAll($res);
        return $ret;
    }

readFor()

ilStudyProgrammeAutoCategoryDBRepository::readFor

(

int

$prg_obj_id

)

Read category-surveillance settings of programme.

Parameters

int

$prg_obj_id

Returns

ilStudyProgrammeAutoCategory[]

Implements ilStudyProgrammeAutoCategoryRepository.

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

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

                                             : 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;
    }

Here is the call graph for this function:

update()

ilStudyProgrammeAutoCategoryDBRepository::update

(

ilStudyProgrammeAutoCategory

$ac

)

Store a category-surveillance setting.

Parameters

ilStudyProgrammeAutoCategory

$ac

Implements ilStudyProgrammeAutoCategoryRepository.

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

References $current_usr_id, $db, $query, ilStudyProgrammeAutoCategory\getCategoryRefId(), ilStudyProgrammeAutoCategory\getPrgObjId(), ilDBInterface\insert(), and ilDBInterface\manipulate().

    {
        $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();
    }

Here is the call graph for this function:

Field Documentation

$current_usr_id

ilStudyProgrammeAutoCategoryDBRepository::$current_usr_id

protected

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

Referenced by __construct(), create(), and update().

$db

ilStudyProgrammeAutoCategoryDBRepository::$db

protected

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

Referenced by __construct(), and update().

FIELD_CAT_REF_ID

const ilStudyProgrammeAutoCategoryDBRepository::FIELD_CAT_REF_ID = 'cat_ref_id'

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

FIELD_EDITOR_ID

const ilStudyProgrammeAutoCategoryDBRepository::FIELD_EDITOR_ID = 'last_usr_id'

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

FIELD_LAST_EDITED

const ilStudyProgrammeAutoCategoryDBRepository::FIELD_LAST_EDITED = 'last_edited'

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

FIELD_PRG_OBJ_ID

const ilStudyProgrammeAutoCategoryDBRepository::FIELD_PRG_OBJ_ID = 'prg_obj_id'

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

TABLE

const ilStudyProgrammeAutoCategoryDBRepository::TABLE = 'prg_auto_content'

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

---

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

• Modules/StudyProgramme/classes/model/AutoCategories/class.ilStudyProgrammeAutoCategoryDBRepository.php