ilStudyProgrammeUserTable provides a flattened list of progresses at a programme-node. More...

Collaboration diagram for ilStudyProgrammeUserTableRow:

Public Member Functions
	__construct (protected int $ass_id, protected int $usr_id, protected int $node_obj_id, protected bool $is_root_progress, protected ilPRGUserInformation $user_information)

	getId ()

	getAssignmentId ()

	getUsrId ()

	getNodeId ()

	isRootProgress ()

	getUserInformation ()

	getUserData (string $field_id)

	withUserActiveRaw (bool $active_raw)

	isUserActiveRaw ()

	withUserActive (string $active)

	getUserActive ()

	withFirstname (string $firstname)

	getFirstname ()

	withLastname (string $lastname)

	getLastname ()

	getName ()

	withLogin (string $login)

	getLogin ()

	withOrgUs (string $orgus)

	getOrgUs ()

	withGender (string $gender)

	getGender ()

	withStatus (string $status)

	getStatus ()

	withStatusRaw (int $status_raw)

	getStatusRaw ()

	withCompletionDate (string $completion_date)

	getCompletionDate ()

	withCompletionBy (string $completion_by)

	getCompletionBy ()

	withCompletionByObjIds (?array $obj_ids)

	getCompletionByObjIds ()

	withPointsReachable (string $points_reachable)

	getPointsReachable ()

	withPointsRequired (string $points_required)

	getPointsRequired ()

	withPointsCurrent (string $points_current)

	getPointsCurrent ()

	withCustomPlan (string $custom_plan)

	getCustomPlan ()

	withBelongsTo (string $belongs_to)

	getBelongsTo ()

	withAssignmentDate (string $assign_date)

	getAssignmentDate ()

	withAssignmentBy (string $assigned_by)

	getAssignmentBy ()

	withDeadline (string $deadline)

	getDeadline ()

	withExpiryDate (string $expiry_date)

	getExpiryDate ()

	withValidity (string $validity)

	getValidity ()

	withRestartDate (string $restart_date)

	getRestartDate ()

	withNodeLifecycleStatus (int $lifecycle_status)

	getNodeLifecycleStatus ()

	toArray ()

Protected Attributes
PRGProgressId	$id

int	$status_raw

bool	$active_raw

ilUserDefinedData	$udf

string	$active

string	$firstname

string	$lastname

string	$login

string	$orgus

string	$gender

string	$status

string	$completion_date

array	$completion_by_obj_ids

string	$completion_by

string	$points_reachable

string	$points_required

string	$points_current

string	$custom_plan

string	$belongs_to

string	$assign_date

string	$assigned_by

string	$deadline

string	$expiry_date

string	$validity

string	$restart_date

int	$lifecycle_status

Detailed Description

ilStudyProgrammeUserTable provides a flattened list of progresses at a programme-node.

Definition at line 24 of file ilStudyProgrammeUserTableRow.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeUserTableRow::__construct	(	protected int	$ass_id,
		protected int	$usr_id,
		protected int	$node_obj_id,
		protected bool	$is_root_progress,
		protected ilPRGUserInformation	$user_information
	)

Definition at line 58 of file ilStudyProgrammeUserTableRow.php.

       {
         $this->id = new PRGProgressId($ass_id, $usr_id, $node_obj_id);
     }

Member Function Documentation

◆ getAssignmentBy()

ilStudyProgrammeUserTableRow::getAssignmentBy ( )

Definition at line 309 of file ilStudyProgrammeUserTableRow.php.

References $assigned_by.

Referenced by toArray().

                                      : string
     {
         return $this->assigned_by;
     }

Here is the caller graph for this function:

◆ getAssignmentDate()

ilStudyProgrammeUserTableRow::getAssignmentDate ( )

Definition at line 298 of file ilStudyProgrammeUserTableRow.php.

References $assign_date.

Referenced by toArray().

                                        : string
     {
         return $this->assign_date;
     }

Here is the caller graph for this function:

◆ getAssignmentId()

ilStudyProgrammeUserTableRow::getAssignmentId ( )

Definition at line 72 of file ilStudyProgrammeUserTableRow.php.

References $ass_id.

                                      : int
     {
         return $this->ass_id;
     }

◆ getBelongsTo()

ilStudyProgrammeUserTableRow::getBelongsTo ( )

Definition at line 287 of file ilStudyProgrammeUserTableRow.php.

References $belongs_to.

Referenced by toArray().

                                   : string
     {
         return $this->belongs_to;
     }

Here is the caller graph for this function:

◆ getCompletionBy()

ilStudyProgrammeUserTableRow::getCompletionBy ( )

Definition at line 217 of file ilStudyProgrammeUserTableRow.php.

References $completion_by.

Referenced by toArray(), and ilStudyProgrammeUserTable\toRow().

                                      : string
     {
         return $this->completion_by;
     }

Here is the caller graph for this function:

◆ getCompletionByObjIds()

ilStudyProgrammeUserTableRow::getCompletionByObjIds ( )

Returns: ?int[]

Definition at line 235 of file ilStudyProgrammeUserTableRow.php.

References $completion_by_obj_ids.

                                            : ?array
     {
         return $this->completion_by_obj_ids;
     }

◆ getCompletionDate()

ilStudyProgrammeUserTableRow::getCompletionDate ( )

Definition at line 206 of file ilStudyProgrammeUserTableRow.php.

References $completion_date.

Referenced by toArray(), and ilStudyProgrammeUserTable\toRow().

                                        : string
     {
         return $this->completion_date;
     }

Here is the caller graph for this function:

◆ getCustomPlan()

ilStudyProgrammeUserTableRow::getCustomPlan ( )

Definition at line 276 of file ilStudyProgrammeUserTableRow.php.

References $custom_plan.

Referenced by toArray().

                                    : string
     {
         return $this->custom_plan;
     }

Here is the caller graph for this function:

◆ getDeadline()

ilStudyProgrammeUserTableRow::getDeadline ( )

Definition at line 320 of file ilStudyProgrammeUserTableRow.php.

References $deadline.

Referenced by toArray(), and ilStudyProgrammeUserTable\toRow().

                                  : string
     {
         return $this->deadline;
     }

Here is the caller graph for this function:

◆ getExpiryDate()

ilStudyProgrammeUserTableRow::getExpiryDate ( )

Definition at line 331 of file ilStudyProgrammeUserTableRow.php.

References $expiry_date.

Referenced by toArray().

                                    : string
     {
         return $this->expiry_date;
     }

Here is the caller graph for this function:

◆ getFirstname()

ilStudyProgrammeUserTableRow::getFirstname ( )

Definition at line 125 of file ilStudyProgrammeUserTableRow.php.

References $firstname.

Referenced by toArray().

                                   : string
     {
         return $this->firstname;
     }

Here is the caller graph for this function:

◆ getGender()

ilStudyProgrammeUserTableRow::getGender ( )

Definition at line 174 of file ilStudyProgrammeUserTableRow.php.

References $gender.

Referenced by toArray().

                                : string
     {
         return $this->gender;
     }

Here is the caller graph for this function:

◆ getId()

ilStudyProgrammeUserTableRow::getId ( )

Definition at line 68 of file ilStudyProgrammeUserTableRow.php.

References $id.

Referenced by toArray().

                            : PRGProgressId
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getLastname()

ilStudyProgrammeUserTableRow::getLastname ( )

Definition at line 136 of file ilStudyProgrammeUserTableRow.php.

References $lastname.

Referenced by toArray().

                                  : string
     {
         return $this->lastname;
     }

Here is the caller graph for this function:

◆ getLogin()

ilStudyProgrammeUserTableRow::getLogin ( )

Definition at line 152 of file ilStudyProgrammeUserTableRow.php.

References $login.

Referenced by toArray().

                               : string
     {
         return $this->login;
     }

Here is the caller graph for this function:

◆ getName()

ilStudyProgrammeUserTableRow::getName ( )

Definition at line 141 of file ilStudyProgrammeUserTableRow.php.

References $firstname.

Referenced by toArray().

                              : string
     {
         return $this->lastname . ', ' . $this->firstname;
     }

Here is the caller graph for this function:

◆ getNodeId()

ilStudyProgrammeUserTableRow::getNodeId ( )

Definition at line 80 of file ilStudyProgrammeUserTableRow.php.

                                : int
     {
         return $this->node_obj_id;
     }

◆ getNodeLifecycleStatus()

ilStudyProgrammeUserTableRow::getNodeLifecycleStatus ( )

Definition at line 368 of file ilStudyProgrammeUserTableRow.php.

References $lifecycle_status.

                                             : int
     {
         return $this->lifecycle_status;
     }

◆ getOrgUs()

ilStudyProgrammeUserTableRow::getOrgUs ( )

Definition at line 163 of file ilStudyProgrammeUserTableRow.php.

References $orgus.

Referenced by toArray().

                               : string
     {
         return $this->orgus;
     }

Here is the caller graph for this function:

◆ getPointsCurrent()

ilStudyProgrammeUserTableRow::getPointsCurrent ( )

Definition at line 266 of file ilStudyProgrammeUserTableRow.php.

References $points_current.

Referenced by toArray().

                                       : string
     {
         return $this->points_current;
     }

Here is the caller graph for this function:

◆ getPointsReachable()

ilStudyProgrammeUserTableRow::getPointsReachable ( )

Definition at line 246 of file ilStudyProgrammeUserTableRow.php.

References $points_reachable.

Referenced by toArray().

                                         : string
     {
         return $this->points_reachable;
     }

Here is the caller graph for this function:

◆ getPointsRequired()

ilStudyProgrammeUserTableRow::getPointsRequired ( )

Definition at line 256 of file ilStudyProgrammeUserTableRow.php.

References $points_required.

Referenced by toArray().

                                        : string
     {
         return $this->points_required;
     }

Here is the caller graph for this function:

◆ getRestartDate()

ilStudyProgrammeUserTableRow::getRestartDate ( )

Definition at line 353 of file ilStudyProgrammeUserTableRow.php.

References $restart_date.

                                     : string
     {
         return $this->restart_date;
     }

◆ getStatus()

ilStudyProgrammeUserTableRow::getStatus ( )

Definition at line 185 of file ilStudyProgrammeUserTableRow.php.

References $status.

Referenced by toArray().

                                : string
     {
         return $this->status;
     }

Here is the caller graph for this function:

◆ getStatusRaw()

ilStudyProgrammeUserTableRow::getStatusRaw ( )

Definition at line 195 of file ilStudyProgrammeUserTableRow.php.

References $status_raw.

                                   : int
     {
         return $this->status_raw;
     }

◆ getUserActive()

ilStudyProgrammeUserTableRow::getUserActive ( )

Definition at line 114 of file ilStudyProgrammeUserTableRow.php.

References $active.

Referenced by toArray().

                                    : string
     {
         return $this->active;
     }

Here is the caller graph for this function:

◆ getUserData()

ilStudyProgrammeUserTableRow::getUserData ( string $field_id )

Definition at line 93 of file ilStudyProgrammeUserTableRow.php.

Referenced by toArray().

     {
         return $this->user_information->getUserData($field_id);
     }

Here is the caller graph for this function:

◆ getUserInformation()

ilStudyProgrammeUserTableRow::getUserInformation ( )

Definition at line 89 of file ilStudyProgrammeUserTableRow.php.

                                         : ilPRGUserInformation
     {
         return $this->user_information;
     }

◆ getUsrId()

ilStudyProgrammeUserTableRow::getUsrId ( )

Definition at line 76 of file ilStudyProgrammeUserTableRow.php.

                               : int
     {
         return $this->usr_id;
     }

◆ getValidity()

ilStudyProgrammeUserTableRow::getValidity ( )

Definition at line 342 of file ilStudyProgrammeUserTableRow.php.

References $validity.

Referenced by toArray().

                                  : string
     {
         return $this->validity;
     }

Here is the caller graph for this function:

◆ isRootProgress()

ilStudyProgrammeUserTableRow::isRootProgress ( )

Definition at line 84 of file ilStudyProgrammeUserTableRow.php.

                                     : bool
     {
         return $this->is_root_progress;
     }

◆ isUserActiveRaw()

ilStudyProgrammeUserTableRow::isUserActiveRaw ( )

Definition at line 104 of file ilStudyProgrammeUserTableRow.php.

References $active_raw.

Referenced by toArray().

                                      : bool
     {
         return $this->active_raw;
     }

Here is the caller graph for this function:

◆ toArray()

ilStudyProgrammeUserTableRow::toArray ( )

Definition at line 373 of file ilStudyProgrammeUserTableRow.php.

References getAssignmentBy(), getAssignmentDate(), getBelongsTo(), getCompletionBy(), getCompletionDate(), getCustomPlan(), getDeadline(), getExpiryDate(), getFirstname(), getGender(), getId(), getLastname(), getLogin(), getName(), getOrgUs(), getPointsCurrent(), getPointsReachable(), getPointsRequired(), getStatus(), getUserActive(), getUserData(), getValidity(), and isUserActiveRaw().

Referenced by ilStudyProgrammeUserTable\postOrder().

                              : array
     {
         $ret = [
             'prgrs_id' => (string) $this->getId(),
             'name' => $this->getName(),
             'active_raw' => $this->isUserActiveRaw(),
             'active' => $this->getUserActive(),
             'firstname' => $this->getFirstname(),
             'lastname' => $this->getLastname(),
             'login' => $this->getLogin(),
             'orgus' => $this->getOrgUs(),
             'gender' => $this->getGender(),
             'status' => $this->getStatus(),
             'completion_date' => $this->getCompletionDate(),
             'completion_by' => $this->getCompletionBy(),
             'points_reachable' => $this->getPointsReachable(),
             'points_required' => $this->getPointsRequired(),
             'points_current' => $this->getPointsCurrent(),
             'custom_plan' => $this->getCustomPlan(),
             'belongs_to' => $this->getBelongsTo(),
             'assign_date' => $this->getAssignmentDate(),
             'assigned_by' => $this->getAssignmentBy(),
             'deadline' => $this->getDeadline(),
             'expiry_date' => $this->getExpiryDate(),
             'validity' => $this->getValidity()
         ];
 
         foreach ($this->user_information->getAvailableUserFields() as $user_field) {
             if (! array_key_exists($user_field, $ret)) {
                 $ret[$user_field] = $this->getUserData($user_field);
             }
         }
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withAssignmentBy()

ilStudyProgrammeUserTableRow::withAssignmentBy ( string $assigned_by )

Definition at line 303 of file ilStudyProgrammeUserTableRow.php.

References $assigned_by.

                                                          : self
     {
         $clone = clone $this;
         $clone->assigned_by = $assigned_by;
         return $clone;
     }

◆ withAssignmentDate()

ilStudyProgrammeUserTableRow::withAssignmentDate ( string $assign_date )

Definition at line 292 of file ilStudyProgrammeUserTableRow.php.

References $assign_date.

                                                            : self
     {
         $clone = clone $this;
         $clone->assign_date = $assign_date;
         return $clone;
     }

◆ withBelongsTo()

ilStudyProgrammeUserTableRow::withBelongsTo ( string $belongs_to )

Definition at line 281 of file ilStudyProgrammeUserTableRow.php.

References $belongs_to.

                                                      : self
     {
         $clone = clone $this;
         $clone->belongs_to = $belongs_to;
         return $clone;
     }

◆ withCompletionBy()

ilStudyProgrammeUserTableRow::withCompletionBy ( string $completion_by )

Definition at line 211 of file ilStudyProgrammeUserTableRow.php.

References $completion_by.

                                                            : self
     {
         $clone = clone $this;
         $clone->completion_by = $completion_by;
         return $clone;
     }

◆ withCompletionByObjIds()

ilStudyProgrammeUserTableRow::withCompletionByObjIds ( ?array $obj_ids )

Parameters

?int[] $ob_ids

Definition at line 225 of file ilStudyProgrammeUserTableRow.php.

                                                            : self
     {
         $clone = clone $this;
         $clone->completion_by_obj_ids = $obj_ids;
         return $clone;
     }

◆ withCompletionDate()

ilStudyProgrammeUserTableRow::withCompletionDate ( string $completion_date )

Definition at line 200 of file ilStudyProgrammeUserTableRow.php.

References $completion_date.

                                                                : self
     {
         $clone = clone $this;
         $clone->completion_date = $completion_date;
         return $clone;
     }

◆ withCustomPlan()

ilStudyProgrammeUserTableRow::withCustomPlan ( string $custom_plan )

Definition at line 270 of file ilStudyProgrammeUserTableRow.php.

References $custom_plan.

                                                        : self
     {
         $clone = clone $this;
         $clone->custom_plan = $custom_plan;
         return $clone;
     }

◆ withDeadline()

ilStudyProgrammeUserTableRow::withDeadline ( string $deadline )

Definition at line 314 of file ilStudyProgrammeUserTableRow.php.

References $deadline.

                                                   : self
     {
         $clone = clone $this;
         $clone->deadline = $deadline;
         return $clone;
     }

◆ withExpiryDate()

ilStudyProgrammeUserTableRow::withExpiryDate ( string $expiry_date )

Definition at line 325 of file ilStudyProgrammeUserTableRow.php.

References $expiry_date.

                                                        : self
     {
         $clone = clone $this;
         $clone->expiry_date = $expiry_date;
         return $clone;
     }

◆ withFirstname()

ilStudyProgrammeUserTableRow::withFirstname ( string $firstname )

Definition at line 119 of file ilStudyProgrammeUserTableRow.php.

References $firstname.

                                                     : self
     {
         $clone = clone $this;
         $clone->firstname = $firstname;
         return $clone;
     }

◆ withGender()

ilStudyProgrammeUserTableRow::withGender ( string $gender )

Definition at line 168 of file ilStudyProgrammeUserTableRow.php.

References $gender.

                                               : self
     {
         $clone = clone $this;
         $clone->gender = $gender;
         return $clone;
     }

◆ withLastname()

ilStudyProgrammeUserTableRow::withLastname ( string $lastname )

Definition at line 130 of file ilStudyProgrammeUserTableRow.php.

References $lastname.

                                                   : self
     {
         $clone = clone $this;
         $clone->lastname = $lastname;
         return $clone;
     }

◆ withLogin()

ilStudyProgrammeUserTableRow::withLogin ( string $login )

Definition at line 146 of file ilStudyProgrammeUserTableRow.php.

References $login.

                                             : self
     {
         $clone = clone $this;
         $clone->login = $login;
         return $clone;
     }

◆ withNodeLifecycleStatus()

ilStudyProgrammeUserTableRow::withNodeLifecycleStatus ( int $lifecycle_status )

Definition at line 358 of file ilStudyProgrammeUserTableRow.php.

References $lifecycle_status, and ilStudyProgrammeAssessmentSettings\$STATUS.

                                                                   : self
     {
         if (! in_array($lifecycle_status, \ilStudyProgrammeAssessmentSettings::$STATUS)) {
             throw new \LogicException('Invalid status: ' . $lifecycle_status);
         }
         $clone = clone $this;
         $clone->lifecycle_status = $lifecycle_status;
         return $clone;
     }

◆ withOrgUs()

ilStudyProgrammeUserTableRow::withOrgUs ( string $orgus )

Definition at line 157 of file ilStudyProgrammeUserTableRow.php.

References $orgus.

                                             : self
     {
         $clone = clone $this;
         $clone->orgus = $orgus;
         return $clone;
     }

◆ withPointsCurrent()

ilStudyProgrammeUserTableRow::withPointsCurrent ( string $points_current )

Definition at line 260 of file ilStudyProgrammeUserTableRow.php.

References $points_current.

                                                              : self
     {
         $clone = clone $this;
         $clone->points_current = $points_current;
         return $clone;
     }

◆ withPointsReachable()

ilStudyProgrammeUserTableRow::withPointsReachable ( string $points_reachable )

Definition at line 240 of file ilStudyProgrammeUserTableRow.php.

References $points_reachable.

                                                                  : self
     {
         $clone = clone $this;
         $clone->points_reachable = $points_reachable;
         return $clone;
     }

◆ withPointsRequired()

ilStudyProgrammeUserTableRow::withPointsRequired ( string $points_required )

Definition at line 250 of file ilStudyProgrammeUserTableRow.php.

References $points_required.

                                                                : self
     {
         $clone = clone $this;
         $clone->points_required = $points_required;
         return $clone;
     }

◆ withRestartDate()

ilStudyProgrammeUserTableRow::withRestartDate ( string $restart_date )

Definition at line 347 of file ilStudyProgrammeUserTableRow.php.

References $restart_date.

                                                          : self
     {
         $clone = clone $this;
         $clone->restart_date = $restart_date;
         return $clone;
     }

◆ withStatus()

ilStudyProgrammeUserTableRow::withStatus ( string $status )

Definition at line 179 of file ilStudyProgrammeUserTableRow.php.

References $status.

                                               : self
     {
         $clone = clone $this;
         $clone->status = $status;
         return $clone;
     }

◆ withStatusRaw()

ilStudyProgrammeUserTableRow::withStatusRaw ( int $status_raw )

Definition at line 189 of file ilStudyProgrammeUserTableRow.php.

References $status_raw.

                                                   : self
     {
         $clone = clone $this;
         $clone->status_raw = $status_raw;
         return $clone;
     }

◆ withUserActive()

ilStudyProgrammeUserTableRow::withUserActive ( string $active )

Definition at line 108 of file ilStudyProgrammeUserTableRow.php.

References $active.

                                                   : self
     {
         $clone = clone $this;
         $clone->active = $active;
         return $clone;
     }

◆ withUserActiveRaw()

ilStudyProgrammeUserTableRow::withUserActiveRaw ( bool $active_raw )

Definition at line 98 of file ilStudyProgrammeUserTableRow.php.

References $active_raw.

                                                        : self
     {
         $clone = clone $this;
         $clone->active_raw = $active_raw;
         return $clone;
     }

◆ withValidity()

ilStudyProgrammeUserTableRow::withValidity ( string $validity )

Definition at line 336 of file ilStudyProgrammeUserTableRow.php.

References $validity.

                                                   : self
     {
         $clone = clone $this;
         $clone->validity = $validity;
         return $clone;
     }