ilExAssignmentTypes Class Reference

Assignment types. More...

Collaboration diagram for ilExAssignmentTypes:

Public Member Functions
	getAllIds ()
	Get all ids. More...
	isValidId ($a_id)
	Is valid id. More...
	getAll ()
	Get all. More...
	getAllActivated ()
	Get all activated. More...
	getAllAllowed (ilObjExercise $exc)
	Get all allowed types for an exercise for an exercise. More...
	getById ($a_id)
	Get type object by id. More...
	getIdsForSubmissionType ($a_submission_type)
	Get assignment type IDs for given submission type. More...

Static Public Member Functions
static	getInstance ()
	Get instance. More...

Data Fields
const	STR_IDENTIFIER_PORTFOLIO = "prtf"

Protected Member Functions
	__construct (ilExerciseInternalService $service=null)
	Constructor. More...

Protected Attributes
	$service

Detailed Description

Assignment types.

Gives information on available types and acts as factory to get assignment type objects.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilExAssignmentTypes::__construct ( ilExerciseInternalService  $service = null )

protected

Constructor.

Definition at line 25 of file class.ilExAssignmentTypes.php.

References $DIC, and $service.

    {
        global $DIC;

        $this->service = ($service == null)
            ? $DIC->exercise()->internal()->service()
            : $service;
    }

Member Function Documentation

getAll()

ilExAssignmentTypes::getAll

(

)

Get all.

Parameters

Definition at line 81 of file class.ilExAssignmentTypes.php.

References getAllIds(), and getById().

Referenced by getAllActivated().

    {
        return array_column(
            array_map(
                function ($id) {
                    return [$id, $this->getById($id)];
                },
                $this->getAllIds()
            ),
            1,
            0
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllActivated()

ilExAssignmentTypes::getAllActivated

(

)

Get all activated.

Parameters

Definition at line 101 of file class.ilExAssignmentTypes.php.

References getAll(), and ilExAssignmentTypeInterface\isActive().

Referenced by getAllAllowed().

    {
        return array_filter($this->getAll(), function (ilExAssignmentTypeInterface $at) {
            return $at->isActive();
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllAllowed()

ilExAssignmentTypes::getAllAllowed

(

ilObjExercise

$exc

)

Get all allowed types for an exercise for an exercise.

Parameters

ilObjExercise

$exc

Returns

array

Definition at line 114 of file class.ilExAssignmentTypes.php.

References getAllActivated(), and ilExAssignmentTypeInterface\usesTeams().

    {
        $random_manager = $this->service->getRandomAssignmentManager($exc);
        $active = $this->getAllActivated();

        // no team assignments, if random mandatory assignments is activated
        if ($random_manager->isActivated()) {
            $active = array_filter($active, function (ilExAssignmentTypeInterface $at) {
                return !$at->usesTeams();
            });
        }
        return $active;
    }

Here is the call graph for this function:

getAllIds()

ilExAssignmentTypes::getAllIds

(

)

Get all ids.

Parameters

Definition at line 50 of file class.ilExAssignmentTypes.php.

References ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, ilExAssignment\TYPE_TEXT, ilExAssignment\TYPE_UPLOAD, ilExAssignment\TYPE_UPLOAD_TEAM, and ilExAssignment\TYPE_WIKI_TEAM.

Referenced by getAll(), getIdsForSubmissionType(), and isValidId().

    {
        return [
            ilExAssignment::TYPE_UPLOAD,
            ilExAssignment::TYPE_UPLOAD_TEAM,
            ilExAssignment::TYPE_TEXT,
            ilExAssignment::TYPE_BLOG,
            ilExAssignment::TYPE_PORTFOLIO,
            ilExAssignment::TYPE_WIKI_TEAM
        ];
    }

Here is the caller graph for this function:

getById()

ilExAssignmentTypes::getById

(

$a_id

)

Get type object by id.

Centralized ID management is still an issue to be tackled in the future and caused by initial consts definition.

Parameters

int

$a_id

type id

Returns

ilExAssignmentTypeInterface

Definition at line 137 of file class.ilExAssignmentTypes.php.

References ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, ilExAssignment\TYPE_TEXT, ilExAssignment\TYPE_UPLOAD, ilExAssignment\TYPE_UPLOAD_TEAM, and ilExAssignment\TYPE_WIKI_TEAM.

Referenced by getAll(), and getIdsForSubmissionType().

    {
        switch ($a_id) {
            case ilExAssignment::TYPE_UPLOAD:
                return new ilExAssTypeUpload();
                break;

            case ilExAssignment::TYPE_BLOG:
                return new ilExAssTypeBlog();
                break;

            case ilExAssignment::TYPE_PORTFOLIO:
                return new ilExAssTypePortfolio();
                break;

            case ilExAssignment::TYPE_UPLOAD_TEAM:
                return new ilExAssTypeUploadTeam();
                break;

            case ilExAssignment::TYPE_TEXT:
                return new ilExAssTypeText();
                break;

            case ilExAssignment::TYPE_WIKI_TEAM:
                return new ilExAssTypeWikiTeam();
                break;
        }

        // we should throw some exception here
    }

Here is the caller graph for this function:

getIdsForSubmissionType()

ilExAssignmentTypes::getIdsForSubmissionType

(

$a_submission_type

)

Get assignment type IDs for given submission type.

Parameters

int

$a_submission_type

Returns

array

Definition at line 174 of file class.ilExAssignmentTypes.php.

References getAllIds(), and getById().

    {
        $ids = [];
        foreach ($this->getAllIds() as $id) {
            if ($this->getById($id)->getSubmissionType() == $a_submission_type) {
                $ids[] = $id;
            }
        }
        return $ids;
    }

Here is the call graph for this function:

getInstance()

static ilExAssignmentTypes::getInstance ( )

static

Get instance.

Returns

ilExAssignmentTypes

Definition at line 39 of file class.ilExAssignmentTypes.php.

Referenced by ilAssignmentsTableGUI\__construct(), ilExcRepoObjAssignmentInfo\__construct(), ilExSubmission\__construct(), ilExerciseSubmissionTableGUI\__construct(), ilExAssignmentEditorGUI\__construct(), ilExAssignment\__construct(), ilWikiPageGUI\finalizeAssignment(), ilExSubmission\getAllAssignmentFiles(), ilExSubmission\getAssignmentFilesByUsers(), and ilExcRepoObjAssignmentInfo\getInfo().

    {
        return new self();
    }

Here is the caller graph for this function:

isValidId()

ilExAssignmentTypes::isValidId

(

$a_id

)

Is valid id.

Parameters

int

$a_id

Returns

bool

Definition at line 68 of file class.ilExAssignmentTypes.php.

References getAllIds().

    {
        return in_array($a_id, $this->getAllIds());
    }

Here is the call graph for this function:

Field Documentation

$service

ilExAssignmentTypes::$service

protected

Definition at line 19 of file class.ilExAssignmentTypes.php.

Referenced by __construct().

STR_IDENTIFIER_PORTFOLIO

const ilExAssignmentTypes::STR_IDENTIFIER_PORTFOLIO = "prtf"

Definition at line 14 of file class.ilExAssignmentTypes.php.

Referenced by ilExAssTypePortfolio\getStringIdentifier().

---

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

• Modules/Exercise/AssignmentTypes/classes/class.ilExAssignmentTypes.php