ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
All Data Structures Namespaces Files Functions Variables Modules Pages
ilStudyProgrammeAutoMembershipsRepository Interface Reference

Persistence of "monitored" sources for automatic membership. More...

+ Inheritance diagram for ilStudyProgrammeAutoMembershipsRepository:
+ Collaboration diagram for ilStudyProgrammeAutoMembershipsRepository:

Public Member Functions

 readFor (int $prg_obj_id)
 Read auto-membership sources of programme. More...
 
 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...
 
 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...
 

Static Public Member Functions

static getProgrammesFor (string $source_type, int $source_id)
 Get all programmes' obj_ids monitoring the given source. More...
 

Detailed Description

Persistence of "monitored" sources for automatic membership.

Definition at line 8 of file interface.ilStudyProgrammeAutoMembershipsRepository.php.

Member Function Documentation

◆ create()

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.

Returns
ilStudyProgrammeAutoMembershipSource

Implemented in ilStudyProgrammeAutoMembershipsDBRepository.

◆ delete()

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

Delete a single source-setting.

Implemented in ilStudyProgrammeAutoMembershipsDBRepository.

◆ deleteFor()

ilStudyProgrammeAutoMembershipsRepository::deleteFor ( int  $prg_obj_id)

Delete all auto-membership sources of a programme.

Implemented in ilStudyProgrammeAutoMembershipsDBRepository.

◆ getProgrammesFor()

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

Get all programmes' obj_ids monitoring the given source.

Returns
int[]

Implemented in ilStudyProgrammeAutoMembershipsDBRepository.

◆ readFor()

ilStudyProgrammeAutoMembershipsRepository::readFor ( int  $prg_obj_id)

Read auto-membership sources of programme.

Returns
ilStudyProgrammeAutoMembershipSource[]

Implemented in ilStudyProgrammeAutoMembershipsDBRepository.

◆ update()

ilStudyProgrammeAutoMembershipsRepository::update ( ilStudyProgrammeAutoMembershipSource  $ams)

Update an auto-membership source.

Returns
ilStudyProgrammeAutoCategory[]

Implemented in ilStudyProgrammeAutoMembershipsDBRepository.


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