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 ()

	withCertificateRelevance (bool $cert_relevance)

	getCertificateRelevance ()

	toArray ()

Protected Attributes
PRGProgressId	$id

int	$status_raw

bool	$active_raw

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

bool	$cert_relevance

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 57 of file ilStudyProgrammeUserTableRow.php.

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

References $ass_id.

Member Function Documentation

◆ getAssignmentBy()

ilStudyProgrammeUserTableRow::getAssignmentBy ( )

Definition at line 308 of file ilStudyProgrammeUserTableRow.php.

                                     : string
    {
        return $this->assigned_by;
    }

References $assigned_by.

Referenced by toArray().

Here is the caller graph for this function:

◆ getAssignmentDate()

ilStudyProgrammeUserTableRow::getAssignmentDate ( )

Definition at line 297 of file ilStudyProgrammeUserTableRow.php.

                                       : string
    {
        return $this->assign_date;
    }

References $assign_date.

Referenced by toArray().

Here is the caller graph for this function:

◆ getAssignmentId()

ilStudyProgrammeUserTableRow::getAssignmentId ( )

Definition at line 71 of file ilStudyProgrammeUserTableRow.php.

                                     : int
    {
        return $this->ass_id;
    }

References $ass_id.

◆ getBelongsTo()

ilStudyProgrammeUserTableRow::getBelongsTo ( )

Definition at line 286 of file ilStudyProgrammeUserTableRow.php.

                                  : string
    {
        return $this->belongs_to;
    }

References $belongs_to.

Referenced by toArray().

Here is the caller graph for this function:

◆ getCertificateRelevance()

ilStudyProgrammeUserTableRow::getCertificateRelevance ( )

Definition at line 378 of file ilStudyProgrammeUserTableRow.php.

                                             : bool
    {
        return $this->cert_relevance;
    }

References $cert_relevance.

Referenced by toArray().

Here is the caller graph for this function:

◆ getCompletionBy()

ilStudyProgrammeUserTableRow::getCompletionBy ( )

Definition at line 216 of file ilStudyProgrammeUserTableRow.php.

                                     : string
    {
        return $this->completion_by;
    }

References $completion_by.

Referenced by toArray().

Here is the caller graph for this function:

◆ getCompletionByObjIds()

ilStudyProgrammeUserTableRow::getCompletionByObjIds ( )

Returns: ?int[]

Definition at line 234 of file ilStudyProgrammeUserTableRow.php.

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

References $completion_by_obj_ids.

◆ getCompletionDate()

ilStudyProgrammeUserTableRow::getCompletionDate ( )

Definition at line 205 of file ilStudyProgrammeUserTableRow.php.

                                       : string
    {
        return $this->completion_date;
    }

References $completion_date.

Referenced by toArray().

Here is the caller graph for this function:

◆ getCustomPlan()

ilStudyProgrammeUserTableRow::getCustomPlan ( )

Definition at line 275 of file ilStudyProgrammeUserTableRow.php.

                                   : string
    {
        return $this->custom_plan;
    }

References $custom_plan.

Referenced by toArray().

Here is the caller graph for this function:

◆ getDeadline()

ilStudyProgrammeUserTableRow::getDeadline ( )

Definition at line 319 of file ilStudyProgrammeUserTableRow.php.

                                 : string
    {
        return $this->deadline;
    }

References $deadline.

Referenced by toArray().

Here is the caller graph for this function:

◆ getExpiryDate()

ilStudyProgrammeUserTableRow::getExpiryDate ( )

Definition at line 330 of file ilStudyProgrammeUserTableRow.php.

                                   : string
    {
        return $this->expiry_date;
    }

References $expiry_date.

Referenced by toArray().

Here is the caller graph for this function:

◆ getFirstname()

ilStudyProgrammeUserTableRow::getFirstname ( )

Definition at line 124 of file ilStudyProgrammeUserTableRow.php.

                                  : string
    {
        return $this->firstname;
    }

References $firstname.

Referenced by toArray().

Here is the caller graph for this function:

◆ getGender()

ilStudyProgrammeUserTableRow::getGender ( )

Definition at line 173 of file ilStudyProgrammeUserTableRow.php.

                               : string
    {
        return $this->gender;
    }

References $gender.

Referenced by toArray().

Here is the caller graph for this function:

◆ getId()

ilStudyProgrammeUserTableRow::getId ( )

Definition at line 67 of file ilStudyProgrammeUserTableRow.php.

                           : PRGProgressId
    {
        return $this->id;
    }

References $id.

Referenced by toArray().

Here is the caller graph for this function:

◆ getLastname()

ilStudyProgrammeUserTableRow::getLastname ( )

Definition at line 135 of file ilStudyProgrammeUserTableRow.php.

                                 : string
    {
        return $this->lastname;
    }

References $lastname.

Referenced by toArray().

Here is the caller graph for this function:

◆ getLogin()

ilStudyProgrammeUserTableRow::getLogin ( )

Definition at line 151 of file ilStudyProgrammeUserTableRow.php.

                              : string
    {
        return $this->login;
    }

References $login.

Referenced by toArray().

Here is the caller graph for this function:

◆ getName()

ilStudyProgrammeUserTableRow::getName ( )

Definition at line 140 of file ilStudyProgrammeUserTableRow.php.

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

References $firstname.

Referenced by toArray().

Here is the caller graph for this function:

◆ getNodeId()

ilStudyProgrammeUserTableRow::getNodeId ( )

Definition at line 79 of file ilStudyProgrammeUserTableRow.php.

                               : int
    {
        return $this->node_obj_id;
    }

◆ getNodeLifecycleStatus()

ilStudyProgrammeUserTableRow::getNodeLifecycleStatus ( )

Definition at line 367 of file ilStudyProgrammeUserTableRow.php.

                                            : int
    {
        return $this->lifecycle_status;
    }

References $lifecycle_status.

◆ getOrgUs()

ilStudyProgrammeUserTableRow::getOrgUs ( )

Definition at line 162 of file ilStudyProgrammeUserTableRow.php.

                              : string
    {
        return $this->orgus;
    }

References $orgus.

Referenced by toArray().

Here is the caller graph for this function:

◆ getPointsCurrent()

ilStudyProgrammeUserTableRow::getPointsCurrent ( )

Definition at line 265 of file ilStudyProgrammeUserTableRow.php.

                                      : string
    {
        return $this->points_current;
    }

References $points_current.

Referenced by toArray().

Here is the caller graph for this function:

◆ getPointsReachable()

ilStudyProgrammeUserTableRow::getPointsReachable ( )

Definition at line 245 of file ilStudyProgrammeUserTableRow.php.

                                        : string
    {
        return $this->points_reachable;
    }

References $points_reachable.

Referenced by toArray().

Here is the caller graph for this function:

◆ getPointsRequired()

ilStudyProgrammeUserTableRow::getPointsRequired ( )

Definition at line 255 of file ilStudyProgrammeUserTableRow.php.

                                       : string
    {
        return $this->points_required;
    }

References $points_required.

Referenced by toArray().

Here is the caller graph for this function:

◆ getRestartDate()

ilStudyProgrammeUserTableRow::getRestartDate ( )

Definition at line 352 of file ilStudyProgrammeUserTableRow.php.

                                    : string
    {
        return $this->restart_date;
    }

References $restart_date.

◆ getStatus()

ilStudyProgrammeUserTableRow::getStatus ( )

Definition at line 184 of file ilStudyProgrammeUserTableRow.php.

                               : string
    {
        return $this->status;
    }

References $status.

Referenced by toArray().

Here is the caller graph for this function:

◆ getStatusRaw()

ilStudyProgrammeUserTableRow::getStatusRaw ( )

Definition at line 194 of file ilStudyProgrammeUserTableRow.php.

                                  : int
    {
        return $this->status_raw;
    }

References $status_raw.

◆ getUserActive()

ilStudyProgrammeUserTableRow::getUserActive ( )

Definition at line 113 of file ilStudyProgrammeUserTableRow.php.

                                   : string
    {
        return $this->active;
    }

References $active.

Referenced by toArray().

Here is the caller graph for this function:

◆ getUserData()

ilStudyProgrammeUserTableRow::getUserData ( string $field_id )

Definition at line 92 of file ilStudyProgrammeUserTableRow.php.

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

Referenced by toArray().

Here is the caller graph for this function:

◆ getUserInformation()

ilStudyProgrammeUserTableRow::getUserInformation ( )

Definition at line 88 of file ilStudyProgrammeUserTableRow.php.

                                        : ilPRGUserInformation
    {
        return $this->user_information;
    }

◆ getUsrId()

ilStudyProgrammeUserTableRow::getUsrId ( )

Definition at line 75 of file ilStudyProgrammeUserTableRow.php.

                              : int
    {
        return $this->usr_id;
    }

◆ getValidity()

ilStudyProgrammeUserTableRow::getValidity ( )

Definition at line 341 of file ilStudyProgrammeUserTableRow.php.

                                 : string
    {
        return $this->validity;
    }

References $validity.

Referenced by toArray().

Here is the caller graph for this function:

◆ isRootProgress()

ilStudyProgrammeUserTableRow::isRootProgress ( )

Definition at line 83 of file ilStudyProgrammeUserTableRow.php.

                                    : bool
    {
        return $this->is_root_progress;
    }

◆ isUserActiveRaw()

ilStudyProgrammeUserTableRow::isUserActiveRaw ( )

Definition at line 103 of file ilStudyProgrammeUserTableRow.php.

                                     : bool
    {
        return $this->active_raw;
    }

References $active_raw.

Referenced by toArray().

Here is the caller graph for this function:

◆ toArray()

ilStudyProgrammeUserTableRow::toArray ( )

Definition at line 384 of file ilStudyProgrammeUserTableRow.php.

                             : 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(),
            'cert_relevance' => $this->getCertificateRelevance(),
        ];
 
        foreach ($this->user_information->getAvailableUserFields() as $user_field) {
            if (! array_key_exists($user_field, $ret)) {
                $ret[$user_field] = $this->getUserData($user_field);
            }
        }
 
        return $ret;
    }

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

Here is the call graph for this function:

◆ withAssignmentBy()

ilStudyProgrammeUserTableRow::withAssignmentBy ( string $assigned_by )

Definition at line 302 of file ilStudyProgrammeUserTableRow.php.

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

References $assigned_by.

◆ withAssignmentDate()

ilStudyProgrammeUserTableRow::withAssignmentDate ( string $assign_date )

Definition at line 291 of file ilStudyProgrammeUserTableRow.php.

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

References $assign_date.

◆ withBelongsTo()

ilStudyProgrammeUserTableRow::withBelongsTo ( string $belongs_to )

Definition at line 280 of file ilStudyProgrammeUserTableRow.php.

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

References $belongs_to.

◆ withCertificateRelevance()

ilStudyProgrammeUserTableRow::withCertificateRelevance ( bool $cert_relevance )

Definition at line 372 of file ilStudyProgrammeUserTableRow.php.

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

References $cert_relevance.

◆ withCompletionBy()

ilStudyProgrammeUserTableRow::withCompletionBy ( string $completion_by )

Definition at line 210 of file ilStudyProgrammeUserTableRow.php.

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

References $completion_by.

◆ withCompletionByObjIds()

ilStudyProgrammeUserTableRow::withCompletionByObjIds ( ?array $obj_ids )

Parameters

?int[] $ob_ids

Definition at line 224 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 199 of file ilStudyProgrammeUserTableRow.php.

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

References $completion_date.

◆ withCustomPlan()

ilStudyProgrammeUserTableRow::withCustomPlan ( string $custom_plan )

Definition at line 269 of file ilStudyProgrammeUserTableRow.php.

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

References $custom_plan.

◆ withDeadline()

ilStudyProgrammeUserTableRow::withDeadline ( string $deadline )

Definition at line 313 of file ilStudyProgrammeUserTableRow.php.

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

References $deadline.

◆ withExpiryDate()

ilStudyProgrammeUserTableRow::withExpiryDate ( string $expiry_date )

Definition at line 324 of file ilStudyProgrammeUserTableRow.php.

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

References $expiry_date.

◆ withFirstname()

ilStudyProgrammeUserTableRow::withFirstname ( string $firstname )

Definition at line 118 of file ilStudyProgrammeUserTableRow.php.

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

References $firstname.

◆ withGender()

ilStudyProgrammeUserTableRow::withGender ( string $gender )

Definition at line 167 of file ilStudyProgrammeUserTableRow.php.

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

References $gender.

◆ withLastname()

ilStudyProgrammeUserTableRow::withLastname ( string $lastname )

Definition at line 129 of file ilStudyProgrammeUserTableRow.php.

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

References $lastname.

◆ withLogin()

ilStudyProgrammeUserTableRow::withLogin ( string $login )

Definition at line 145 of file ilStudyProgrammeUserTableRow.php.

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

References $login.

◆ withNodeLifecycleStatus()

ilStudyProgrammeUserTableRow::withNodeLifecycleStatus ( int $lifecycle_status )

Definition at line 357 of file ilStudyProgrammeUserTableRow.php.

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

References $lifecycle_status, and ilStudyProgrammeAssessmentSettings\$STATUS.

◆ withOrgUs()

ilStudyProgrammeUserTableRow::withOrgUs ( string $orgus )

Definition at line 156 of file ilStudyProgrammeUserTableRow.php.

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

References $orgus.

◆ withPointsCurrent()

ilStudyProgrammeUserTableRow::withPointsCurrent ( string $points_current )

Definition at line 259 of file ilStudyProgrammeUserTableRow.php.

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

References $points_current.

◆ withPointsReachable()

ilStudyProgrammeUserTableRow::withPointsReachable ( string $points_reachable )

Definition at line 239 of file ilStudyProgrammeUserTableRow.php.

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

References $points_reachable.

◆ withPointsRequired()

ilStudyProgrammeUserTableRow::withPointsRequired ( string $points_required )

Definition at line 249 of file ilStudyProgrammeUserTableRow.php.

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

References $points_required.

◆ withRestartDate()

ilStudyProgrammeUserTableRow::withRestartDate ( string $restart_date )

Definition at line 346 of file ilStudyProgrammeUserTableRow.php.

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

References $restart_date.

◆ withStatus()

ilStudyProgrammeUserTableRow::withStatus ( string $status )

Definition at line 178 of file ilStudyProgrammeUserTableRow.php.

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

References $status.

◆ withStatusRaw()

ilStudyProgrammeUserTableRow::withStatusRaw ( int $status_raw )

Definition at line 188 of file ilStudyProgrammeUserTableRow.php.

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

References $status_raw.

◆ withUserActive()

ilStudyProgrammeUserTableRow::withUserActive ( string $active )

Definition at line 107 of file ilStudyProgrammeUserTableRow.php.

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

References $active.

◆ withUserActiveRaw()

ilStudyProgrammeUserTableRow::withUserActiveRaw ( bool $active_raw )

Definition at line 97 of file ilStudyProgrammeUserTableRow.php.

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

References $active_raw.

◆ withValidity()

ilStudyProgrammeUserTableRow::withValidity ( string $validity )

Definition at line 335 of file ilStudyProgrammeUserTableRow.php.

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