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

Collaboration diagram for ilStudyProgrammeUserTableRow:

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

	getId ()

	getAssignmentId ()

	getUsrId ()

	getNodeId ()

	isRootProgress ()

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

	withUDF (ilUserDefinedData $udf)

	getUdf (string $field)

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

	toArray ()

Protected Attributes
PRGProgressId	$id

int	$ass_id

int	$usr_id

int	$pgs_id

bool	$is_root_progress

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

Detailed Description

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

Definition at line 26 of file ilStudyProgrammeUserTableRow.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 63 of file ilStudyProgrammeUserTableRow.php.

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

References $ass_id, $is_root_progress, and $usr_id.

Member Function Documentation

◆ getAssignmentBy()

ilStudyProgrammeUserTableRow::getAssignmentBy ( )

Definition at line 315 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 304 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 76 of file ilStudyProgrammeUserTableRow.php.

                                     : int
    {
        return $this->ass_id;
    }

References $ass_id.

◆ getBelongsTo()

ilStudyProgrammeUserTableRow::getBelongsTo ( )

Definition at line 293 of file ilStudyProgrammeUserTableRow.php.

                                  : string
    {
        return $this->belongs_to;
    }

References $belongs_to.

Referenced by toArray().

Here is the caller graph for this function:

◆ getCompletionBy()

ilStudyProgrammeUserTableRow::getCompletionBy ( )

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

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

References $completion_by_obj_ids.

◆ getCompletionDate()

ilStudyProgrammeUserTableRow::getCompletionDate ( )

Definition at line 212 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 282 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 326 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 337 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 120 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 169 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 72 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 131 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 147 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 136 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 84 of file ilStudyProgrammeUserTableRow.php.

                               : int
    {
        return $this->node_id;
    }

◆ getOrgUs()

ilStudyProgrammeUserTableRow::getOrgUs ( )

Definition at line 158 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 272 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 252 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 262 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 359 of file ilStudyProgrammeUserTableRow.php.

                                    : string
    {
        return $this->restart_date;
    }

References $restart_date.

◆ getStatus()

ilStudyProgrammeUserTableRow::getStatus ( )

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

                                  : int
    {
        return $this->status_raw;
    }

References $status_raw.

◆ getUdf()

ilStudyProgrammeUserTableRow::getUdf ( string $field )

Definition at line 180 of file ilStudyProgrammeUserTableRow.php.

    {
        return $this->udf->get($field);
    }

◆ getUserActive()

ilStudyProgrammeUserTableRow::getUserActive ( )

Definition at line 109 of file ilStudyProgrammeUserTableRow.php.

                                   : string
    {
        return $this->active;
    }

References $active.

Referenced by toArray().

Here is the caller graph for this function:

◆ getUsrId()

ilStudyProgrammeUserTableRow::getUsrId ( )

Definition at line 80 of file ilStudyProgrammeUserTableRow.php.

                              : int
    {
        return $this->usr_id;
    }

References $usr_id.

◆ getValidity()

ilStudyProgrammeUserTableRow::getValidity ( )

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

                                    : bool
    {
        return $this->is_root_progress;
    }

References $is_root_progress.

◆ isUserActiveRaw()

ilStudyProgrammeUserTableRow::isUserActiveRaw ( )

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

                             : array
    {
        return [
            '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()
        ];
    }

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

Here is the call graph for this function:

◆ withAssignmentBy()

ilStudyProgrammeUserTableRow::withAssignmentBy ( string $assigned_by )

Definition at line 309 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 298 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 287 of file ilStudyProgrammeUserTableRow.php.

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

References $belongs_to.

◆ withCompletionBy()

ilStudyProgrammeUserTableRow::withCompletionBy ( string $completion_by )

Definition at line 217 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 231 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 206 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 276 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 320 of file ilStudyProgrammeUserTableRow.php.

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

References $deadline.

◆ withExpiryDate()

ilStudyProgrammeUserTableRow::withExpiryDate ( string $expiry_date )

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

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

References $firstname.

◆ withGender()

ilStudyProgrammeUserTableRow::withGender ( string $gender )

Definition at line 163 of file ilStudyProgrammeUserTableRow.php.

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

References $gender.

◆ withLastname()

ilStudyProgrammeUserTableRow::withLastname ( string $lastname )

Definition at line 125 of file ilStudyProgrammeUserTableRow.php.

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

References $lastname.

◆ withLogin()

ilStudyProgrammeUserTableRow::withLogin ( string $login )

Definition at line 141 of file ilStudyProgrammeUserTableRow.php.

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

References $login.

◆ withOrgUs()

ilStudyProgrammeUserTableRow::withOrgUs ( string $orgus )

Definition at line 152 of file ilStudyProgrammeUserTableRow.php.

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

References $orgus.

◆ withPointsCurrent()

ilStudyProgrammeUserTableRow::withPointsCurrent ( string $points_current )

Definition at line 266 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 246 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 256 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 353 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 185 of file ilStudyProgrammeUserTableRow.php.

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

References $status.

◆ withStatusRaw()

ilStudyProgrammeUserTableRow::withStatusRaw ( int $status_raw )

Definition at line 195 of file ilStudyProgrammeUserTableRow.php.

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

References $status_raw.

◆ withUDF()

ilStudyProgrammeUserTableRow::withUDF ( ilUserDefinedData $udf )

Definition at line 174 of file ilStudyProgrammeUserTableRow.php.

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

References $udf.

◆ withUserActive()

ilStudyProgrammeUserTableRow::withUserActive ( string $active )

Definition at line 103 of file ilStudyProgrammeUserTableRow.php.

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

References $active.

◆ withUserActiveRaw()

ilStudyProgrammeUserTableRow::withUserActiveRaw ( bool $active_raw )

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

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