Class ilStudyProgrammeAutoMembershipsDBRepository. More...

Inheritance diagram for ilStudyProgrammeAutoMembershipsDBRepository:

Collaboration diagram for ilStudyProgrammeAutoMembershipsDBRepository:

Public Member Functions
	__construct (ilDBInterface $db, int $current_usr_id)

	getFor (int $prg_obj_id)
	Read auto-membership sources of programme. Returns ilStudyProgrammeAutoMembershipSource[] More...

	create (int $prg_obj_id, string $source_type, int $source_id, bool $enabled, ?int $last_edited_usr_id=null, ?DateTimeImmutable $last_edited=null, bool $search_recursive=false)

	update (ilStudyProgrammeAutoMembershipSource $ams)
	Update an auto-membership source. More...

	delete (int $prg_obj_id, string $source_type, int $source_id)
	Delete a single source-setting. More...

	deleteFor (int $prg_obj_id)
	Delete all auto-membership sources of a programme. More...

Public Member Functions inherited from ilStudyProgrammeAutoMembershipsRepository
	create (int $prg_obj_id, string $source_type, int $source_id, bool $enabled, ?int $last_edited_usr_id=null, ?DateTimeImmutable $last_edited=null)
	Build an auto-membership source. More...

Static Public Member Functions
static	getProgrammesFor (string $source_type, int $source_id)
	Get all programmes' obj_ids monitoring the given source. Returns int[] More...

Protected Attributes
ilDBInterface	$db

int	$current_usr_id

Private Attributes
const	TABLE = 'prg_auto_membership'

const	FIELD_PRG_OBJ_ID = 'prg_obj_id'

const	FIELD_SOURCE_TYPE = 'source_type'

const	FIELD_SOURCE_ID = 'source_id'

const	FIELD_ENABLED = 'enabled'

const	FIELD_EDITOR_ID = 'last_usr_id'

const	FIELD_LAST_EDITED = 'last_edited'

const	FIELD_SEARCH_RECURSIVE = 'search_recursive'

Detailed Description

Class ilStudyProgrammeAutoMembershipsDBRepository.

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.ilStudyProgrammeAutoMembershipsDBRepository.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $current_usr_id, and $db.

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

Member Function Documentation

◆ create()

ilStudyProgrammeAutoMembershipsDBRepository::create	(	int	$prg_obj_id,
		string	$source_type,
		int	$source_id,
		bool	$enabled,
		?int	$last_edited_usr_id = `null`,
		?DateTimeImmutable	$last_edited = `null`,
		bool	$search_recursive = `false`
	)

Definition at line 78 of file class.ilStudyProgrammeAutoMembershipsDBRepository.php.

References $current_usr_id.

Referenced by getFor().

      : ilStudyProgrammeAutoMembershipSource {
         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 ilStudyProgrammeAutoMembershipSource(
             $prg_obj_id,
             $source_type,
             $source_id,
             $enabled,
             $last_edited_usr_id,
             $last_edited,
             $search_recursive
         );
     }

Here is the caller graph for this function:

◆ delete()

ilStudyProgrammeAutoMembershipsDBRepository::delete	(	int	$prg_obj_id,
		string	$source_type,
		int	$source_id
	)

Delete a single source-setting.

Implements ilStudyProgrammeAutoMembershipsRepository.

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

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

◆ deleteFor()

ilStudyProgrammeAutoMembershipsDBRepository::deleteFor ( int $prg_obj_id )

Delete all auto-membership sources of a programme.

Implements ilStudyProgrammeAutoMembershipsRepository.

Definition at line 154 of file class.ilStudyProgrammeAutoMembershipsDBRepository.php.

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

◆ getFor()

ilStudyProgrammeAutoMembershipsDBRepository::getFor ( int $prg_obj_id )

Read auto-membership sources of programme.

Returns: ilStudyProgrammeAutoMembershipSource[]

Implements ilStudyProgrammeAutoMembershipsRepository.

Definition at line 49 of file class.ilStudyProgrammeAutoMembershipsDBRepository.php.

References $res, and create().

                                            : array
     {
         $query = 'SELECT '
             . self::FIELD_PRG_OBJ_ID . ','
             . self::FIELD_SOURCE_TYPE . ','
             . self::FIELD_SOURCE_ID . ','
             . self::FIELD_ENABLED . ','
             . self::FIELD_EDITOR_ID . ','
             . self::FIELD_LAST_EDITED . ','
             . self::FIELD_SEARCH_RECURSIVE
             . 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],
                 $rec[self::FIELD_SOURCE_TYPE],
                 (int) $rec[self::FIELD_SOURCE_ID],
                 (bool) $rec[self::FIELD_ENABLED],
                 (int) $rec[self::FIELD_EDITOR_ID],
                 new DateTimeImmutable($rec[self::FIELD_LAST_EDITED]),
                 (bool) $rec[self::FIELD_SEARCH_RECURSIVE]
             );
         }
         return $ret;
     }

Here is the call graph for this function:

◆ getProgrammesFor()

static ilStudyProgrammeAutoMembershipsDBRepository::getProgrammesFor	(	string	$source_type,
		int	$source_id
	)

static

Get all programmes' obj_ids monitoring the given source.

Returns: int[]

Implements ilStudyProgrammeAutoMembershipsRepository.

Definition at line 164 of file class.ilStudyProgrammeAutoMembershipsDBRepository.php.

References $DIC, $path, $q, $res, ilDBInterface\fetchAll(), ilDBInterface\fetchAssoc(), ilDBInterface\in(), ilDBInterface\query(), and ilDBInterface\quote().

                                                                                 : array
     {
         global $DIC;
         $db = $DIC["ilDB"];
 
         $q = "SELECT path FROM tree WHERE child = " . $db->quote($source_id, "integer");
         $res = $db->query($q);
         $row = $db->fetchAssoc($res);
         $path = explode(".", $row["path"] ?? "");
 
         $query = 'SELECT ' . self::FIELD_PRG_OBJ_ID . PHP_EOL
             . 'FROM ' . self::TABLE . ' prgs' . PHP_EOL
             . 'INNER JOIN object_reference oref ON ' . PHP_EOL
             . 'prgs.' . self::FIELD_PRG_OBJ_ID . ' =  oref.obj_id' . PHP_EOL
             . 'WHERE ('
             . self::FIELD_SOURCE_ID . ' = ' . $db->quote($source_id, 'integer') . PHP_EOL
             . ' OR (' . $db->in(self::FIELD_SOURCE_ID, $path, false, 'integer') . ' AND search_recursive = 1)' . PHP_EOL
             . ')' . PHP_EOL
             . 'AND ' . self::FIELD_ENABLED . ' = 1' . PHP_EOL
             . 'AND ' . self::FIELD_SOURCE_TYPE . ' = ' . $db->quote($source_type, 'text') . PHP_EOL
             . 'AND oref.deleted IS NULL';
 
         $res = $db->query($query);
         return $db->fetchAll($res);
     }

Here is the call graph for this function:

◆ update()

ilStudyProgrammeAutoMembershipsDBRepository::update ( ilStudyProgrammeAutoMembershipSource $ams )

Update an auto-membership source.

Implements ilStudyProgrammeAutoMembershipsRepository.

Definition at line 107 of file class.ilStudyProgrammeAutoMembershipsDBRepository.php.

References $current_usr_id, ilStudyProgrammeAutoMembershipSource\getPrgObjId(), ilStudyProgrammeAutoMembershipSource\getSourceId(), ilStudyProgrammeAutoMembershipSource\getSourceType(), ilDBInterface\insert(), ilStudyProgrammeAutoMembershipSource\isEnabled(), ilStudyProgrammeAutoMembershipSource\isSearchRecursive(), and ilDBInterface\manipulate().

                                                                      : void
     {
         $ilAtomQuery = $this->db->buildAtomQuery();
         $ilAtomQuery->addTableLock(self::TABLE);
         $current_usr_id = $this->current_usr_id;
         $ilAtomQuery->addQueryCallable(
             function (ilDBInterface $db) use ($ams, $current_usr_id) {
                 $query = 'DELETE FROM ' . self::TABLE
                     . PHP_EOL . 'WHERE prg_obj_id = ' . $ams->getPrgObjId()
                     . PHP_EOL . 'AND ' . self::FIELD_SOURCE_TYPE . ' = ' . $this->db->quote($ams->getSourceType(), 'string')
                     . PHP_EOL . 'AND ' . self::FIELD_SOURCE_ID . ' = ' . $ams->getSourceId();
                 $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', $ams->getPrgObjId()],
                         self::FIELD_SOURCE_TYPE => ['text', $ams->getSourceType()],
                         self::FIELD_SOURCE_ID => ['integer', $ams->getSourceId()],
                         self::FIELD_ENABLED => ['integer', $ams->isEnabled()],
                         self::FIELD_EDITOR_ID => ['integer', $current_usr_id],
                         self::FIELD_LAST_EDITED => ['timestamp', $now],
                         self::FIELD_SEARCH_RECURSIVE => ['integer', $ams->isSearchRecursive()]
                     ]
                 );
             }
         );
         $ilAtomQuery->run();
     }