Collaboration diagram for ILIAS\Exercise\Assignment\AssignmentManager:

Public Member Functions
	__construct (InternalRepoService $repo_service, InternalDomainService $domain_service, int $obj_id, int $user_id)

	getValidListMode (string $mode)

	getListModes ()

	getListModeLabel (string $mode)

	getList (string $mode)

	getAll ()

	get (int $ass_id)

Data Fields
const	TYPE_ALL = "all"

const	TYPE_ONGOING = "ongoing"

const	TYPE_FUTURE = "future"

const	TYPE_PAST = "past"

Protected Member Functions
	getExcId ()

Protected Attributes
int	$user_id

ilLanguage	$lng

InternalDomainService	$domain

AssignmentsDBRepository	$repo

int	$obj_id

Detailed Description

Definition at line 26 of file AssignmentManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Exercise\Assignment\AssignmentManager::__construct	(	InternalRepoService	$repo_service,
		InternalDomainService	$domain_service,
		int	$obj_id,
		int	$user_id
	)

Definition at line 38 of file AssignmentManager.php.

References ILIAS\Exercise\Assignment\AssignmentManager\$obj_id, ILIAS\Exercise\Assignment\AssignmentManager\$user_id, ILIAS\Exercise\InternalRepoService\assignment(), and ILIAS\Repository\lng().

       {
         $this->obj_id = $obj_id;
         $this->domain = $domain_service;
         $this->repo = $repo_service->assignment()->assignments();
         $this->lng = $domain_service->lng();
         $this->user_id = $user_id;
     }

Here is the call graph for this function:

Member Function Documentation

◆ get()

ILIAS\Exercise\Assignment\AssignmentManager::get ( int $ass_id )

Definition at line 109 of file AssignmentManager.php.

References $ass_id, and ILIAS\Exercise\Assignment\AssignmentManager\getExcId().

                                     : Assignment
     {
         $ass = $this->repo->get($this->getExcId(), $ass_id);
         if (is_null($ass)) {
             throw new \ilExerciseException("Assignment not found (" . $this->getExcId() . "," . $ass_id . ").");
         }
         return $ass;
     }

Here is the call graph for this function:

◆ getAll()

ILIAS\Exercise\Assignment\AssignmentManager::getAll ( )

Returns: iterable<Assignment>

Definition at line 102 of file AssignmentManager.php.

                             : \Iterator
     {
         foreach ($this->repo->getList($this->getExcId()) as $ass) {
             yield $ass;
         }
     }

◆ getExcId()

ILIAS\Exercise\Assignment\AssignmentManager::getExcId ( )

protected

Definition at line 51 of file AssignmentManager.php.

References ILIAS\Exercise\Assignment\AssignmentManager\$obj_id.

Referenced by ILIAS\Exercise\Assignment\AssignmentManager\get().

                                  : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getList()

ILIAS\Exercise\Assignment\AssignmentManager::getList ( string $mode )

Returns: iterable<Assignment>

Definition at line 83 of file AssignmentManager.php.

References ILIAS\Exercise\Assignment\AssignmentManager\$user_id.

                                          : \Iterator
     {
         foreach ($this->repo->getList($this->getExcId()) as $ass) {
             $state = $this->domain->assignment()->state($ass->getId(), $this->user_id);
             if ($mode === self::TYPE_PAST && $state->hasEnded()) {
                 yield $ass;
             }
             if ($mode === self::TYPE_FUTURE && $state->isFuture()) {
                 yield $ass;
             }
             if ($mode === self::TYPE_ONGOING && !$state->hasEnded() && !$state->isFuture()) {
                 yield $ass;
             }
         }
     }

◆ getListModeLabel()

ILIAS\Exercise\Assignment\AssignmentManager::getListModeLabel ( string $mode )

Definition at line 74 of file AssignmentManager.php.

References ILIAS\Exercise\Assignment\AssignmentManager\getListModes().

                                                   : string
     {
         $modes = $this->getListModes();
         return $modes[$mode] ?? "";
     }

Here is the call graph for this function:

◆ getListModes()

ILIAS\Exercise\Assignment\AssignmentManager::getListModes ( )

Definition at line 64 of file AssignmentManager.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Exercise\Assignment\AssignmentManager\getListModeLabel().

                                   : array
     {
         return [
             self::TYPE_ONGOING => $this->lng->txt("exc_ongoing"),
             self::TYPE_FUTURE => $this->lng->txt("exc_future"),
             self::TYPE_PAST => $this->lng->txt("exc_past"),
             self::TYPE_ALL => $this->lng->txt("exc_all")
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidListMode()

ILIAS\Exercise\Assignment\AssignmentManager::getValidListMode ( string $mode )

Definition at line 56 of file AssignmentManager.php.

                                                   : string
     {
         if (!in_array($mode, [self::TYPE_ONGOING,self::TYPE_FUTURE,self::TYPE_PAST,self::TYPE_ALL])) {
             return self::TYPE_ONGOING;
         }
         return $mode;
     }

Field Documentation

◆ $domain

InternalDomainService ILIAS\Exercise\Assignment\AssignmentManager::$domain

protected

Definition at line 34 of file AssignmentManager.php.

◆ $lng

ilLanguage ILIAS\Exercise\Assignment\AssignmentManager::$lng

protected

Definition at line 33 of file AssignmentManager.php.

◆ $obj_id

int ILIAS\Exercise\Assignment\AssignmentManager::$obj_id

protected

Definition at line 36 of file AssignmentManager.php.

Referenced by ILIAS\Exercise\Assignment\AssignmentManager\__construct(), and ILIAS\Exercise\Assignment\AssignmentManager\getExcId().

◆ $repo

AssignmentsDBRepository ILIAS\Exercise\Assignment\AssignmentManager::$repo

protected

Definition at line 35 of file AssignmentManager.php.

◆ $user_id

int ILIAS\Exercise\Assignment\AssignmentManager::$user_id

protected

Definition at line 32 of file AssignmentManager.php.

Referenced by ILIAS\Exercise\Assignment\AssignmentManager\__construct(), and ILIAS\Exercise\Assignment\AssignmentManager\getList().

◆ TYPE_ALL

const ILIAS\Exercise\Assignment\AssignmentManager::TYPE_ALL = "all"

Definition at line 28 of file AssignmentManager.php.

◆ TYPE_FUTURE

const ILIAS\Exercise\Assignment\AssignmentManager::TYPE_FUTURE = "future"

Definition at line 30 of file AssignmentManager.php.

◆ TYPE_ONGOING

const ILIAS\Exercise\Assignment\AssignmentManager::TYPE_ONGOING = "ongoing"

Definition at line 29 of file AssignmentManager.php.

◆ TYPE_PAST

const ILIAS\Exercise\Assignment\AssignmentManager::TYPE_PAST = "past"

Definition at line 31 of file AssignmentManager.php.

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

components/ILIAS/Exercise/Assignment/AssignmentManager.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ getAll()

◆ getExcId()

◆ getList()

◆ getListModeLabel()

◆ getListModes()

◆ getValidListMode()

Field Documentation

◆ $domain

◆ $lng

◆ $obj_id

◆ $repo

◆ $user_id

◆ TYPE_ALL

◆ TYPE_FUTURE

◆ TYPE_ONGOING

◆ TYPE_PAST