ilExcRepoObjAssignmentInfo Class Reference

Repository object assignment information. More...

Inheritance diagram for ilExcRepoObjAssignmentInfo:

Collaboration diagram for ilExcRepoObjAssignmentInfo:

Public Member Functions
	getId ()
	Get assignment id. Returns int assignment id More...
	getTitle ()
	Get assignment title. Returns int assignment id More...
	getLinks ()
	Get readable link urls to the assignment (key is the ref id) Returns string[] assignment link url More...
	isUserSubmission ()
	Check if this object has been submitted by the user provided or its team.If not, the repository object is related to an assignment, but has been submitted by another user/team. Returns bool More...
	getExerciseId ()
	Get exercise id. Returns int More...
	getExerciseTitle ()
	Get exercise title. Returns string More...
	getReadableRefIds ()
	Get readable ref IDs. Returns int[] More...

Static Public Member Functions
static	getInfo ($a_ref_id, $a_user_id)
	Get all info objects for a ref id of an repo object. More...

Protected Member Functions
	__construct ( $a_assignment_id, $a_assignment_title, $a_ref_ids, $is_user_submission, $a_exc_id, $a_exc_title)
	Constructor. More...

Protected Attributes
	$id
	$ref_ids
	$title
	$ass_types
	$is_user_submission
	$exc_title
	$exc_id

Detailed Description

Repository object assignment information.

Author

Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 12 of file class.ilExcRepoObjAssignmentInfo.php.

Constructor & Destructor Documentation

__construct()

ilExcRepoObjAssignmentInfo::__construct (   $a_assignment_id,   $a_assignment_title,   $a_ref_ids,   $is_user_submission,   $a_exc_id,   $a_exc_title  )

protected

Constructor.

Parameters

int	$a_assignment_id
	int[]	$a_ref_ids ref ids

Definition at line 55 of file class.ilExcRepoObjAssignmentInfo.php.

References $is_user_submission, and ilExAssignmentTypes\getInstance().

      {
        $this->id = $a_assignment_id;
        $this->title = $a_assignment_title;
        $this->ref_ids = $a_ref_ids;
        $this->ass_types = ilExAssignmentTypes::getInstance();
        $this->is_user_submission = $is_user_submission;
        $this->exc_id = $a_exc_id;
        $this->exc_title = $a_exc_title;
    }

Here is the call graph for this function:

Member Function Documentation

getExerciseId()

ilExcRepoObjAssignmentInfo::getExerciseId

(

)

Get exercise id.

Returns

int

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 113 of file class.ilExcRepoObjAssignmentInfo.php.

References $exc_id.

    {
        return $this->exc_id;
    }

getExerciseTitle()

ilExcRepoObjAssignmentInfo::getExerciseTitle

(

)

Get exercise title.

Returns

string

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 121 of file class.ilExcRepoObjAssignmentInfo.php.

References $exc_title.

    {
        return $this->exc_title;
    }

getId()

ilExcRepoObjAssignmentInfo::getId

(

)

Get assignment id.

Returns

int assignment id

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 76 of file class.ilExcRepoObjAssignmentInfo.php.

References $id.

    {
        return $this->id;
    }

getInfo()

static ilExcRepoObjAssignmentInfo::getInfo (   $a_ref_id,   $a_user_id  )

static

Get all info objects for a ref id of an repo object.

Parameters

int	$a_ref_id	ref id
int	$a_user_id	user id

Returns

ilExcRepoObjAssignmentInfo[]

Definition at line 142 of file class.ilExcRepoObjAssignmentInfo.php.

References $ass_types, $DIC, $is_user_submission, $ref_ids, $s, ilObject\_getAllReferences(), ilObject\_lookupTitle(), ilExAssignmentTypes\getInstance(), ilExAssignmentTeam\getInstanceByUserId(), ilExSubmission\getSubmissionsForFilename(), and ilExSubmission\TYPE_REPO_OBJECT.

Referenced by ilExcRepoObjAssignment\getAssignmentInfoOfObj().

    {
        global $DIC;

        $access = $DIC->access();

        include_once("./Modules/Exercise/AssignmentTypes/classes/class.ilExAssignmentTypes.php");
        $ass_types = ilExAssignmentTypes::getInstance();

        $repos_ass_type_ids = $ass_types->getIdsForSubmissionType(ilExSubmission::TYPE_REPO_OBJECT);
        include_once("./Modules/Exercise/classes/class.ilExSubmission.php");
        $submissions = ilExSubmission::getSubmissionsForFilename($a_ref_id, $repos_ass_type_ids);

        $ass_info = array();
        foreach ($submissions as $s) {
            $ass_type = $ass_types->getById($s["type"]);

            // @todo note: this currently only works, if submissions are assigned to the team (like team wikis)
            // get team of user
            include_once "Modules/Exercise/classes/class.ilExAssignmentTeam.php";
            $team = ilExAssignmentTeam::getInstanceByUserId($s["ass_id"], $a_user_id);
            $is_user_submission = ($team->getId() > 0 && $team->getId() == $s["team_id"])
                ? true
                : false;


            // determine all readable ref ids of the exercise
            $ref_ids = ilObject::_getAllReferences($s["exc_id"]);
            $readable_ref_ids = array();
            foreach ($ref_ids as $ref_id) {
                if ($a_user_id > 0 && !$access->checkAccessOfUser($a_user_id, "read", "", $ref_id)) {
                    continue;
                }
                $readable_ref_ids[] = $ref_id;
            }
            $ass_info[] = new self(
                $s["ass_id"],
                $s["title"],
                $readable_ref_ids,
                $is_user_submission,
                $s["exc_id"],
                ilObject::_lookupTitle($s["exc_id"])
            );
        }
        return $ass_info;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLinks()

ilExcRepoObjAssignmentInfo::getLinks

(

)

Get readable link urls to the assignment (key is the ref id)

Returns

string[] assignment link url

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 93 of file class.ilExcRepoObjAssignmentInfo.php.

References $links, and ilLink\_getLink().

    {
        $links = [];
        foreach ($this->ref_ids as $ref_id) {
            $links[$ref_id] = ilLink::_getLink($ref_id, "exc", array(), "_" . $this->id);
        }
        return $links;
    }

Here is the call graph for this function:

getReadableRefIds()

ilExcRepoObjAssignmentInfo::getReadableRefIds

(

)

Get readable ref IDs.

Returns

int[]

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 129 of file class.ilExcRepoObjAssignmentInfo.php.

References $ref_ids.

    {
        return $this->ref_ids;
    }

getTitle()

ilExcRepoObjAssignmentInfo::getTitle

(

)

Get assignment title.

Returns

int assignment id

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 84 of file class.ilExcRepoObjAssignmentInfo.php.

References $title.

    {
        return $this->title;
    }

isUserSubmission()

ilExcRepoObjAssignmentInfo::isUserSubmission

(

)

Check if this object has been submitted by the user provided or its team.If not, the repository object is related to an assignment, but has been submitted by another user/team.

Returns

bool

Implements ilExcRepoObjAssignmentInfoInterface.

Definition at line 105 of file class.ilExcRepoObjAssignmentInfo.php.

References $is_user_submission.

    {
        return $this->is_user_submission;
    }

Field Documentation

$ass_types

ilExcRepoObjAssignmentInfo::$ass_types

protected

Definition at line 32 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by getInfo().

$exc_id

ilExcRepoObjAssignmentInfo::$exc_id

protected

Definition at line 47 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by getExerciseId().

$exc_title

ilExcRepoObjAssignmentInfo::$exc_title

protected

Definition at line 42 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by getExerciseTitle().

$id

ilExcRepoObjAssignmentInfo::$id

protected

Definition at line 17 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by getId().

$is_user_submission

ilExcRepoObjAssignmentInfo::$is_user_submission

protected

Definition at line 37 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by __construct(), getInfo(), and isUserSubmission().

$ref_ids

ilExcRepoObjAssignmentInfo::$ref_ids

protected

Definition at line 22 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by getInfo(), and getReadableRefIds().

$title

ilExcRepoObjAssignmentInfo::$title

protected

Definition at line 27 of file class.ilExcRepoObjAssignmentInfo.php.

Referenced by getTitle().

---

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

• Modules/Exercise/RepoObjectAssignment/classes/class.ilExcRepoObjAssignmentInfo.php