ilStudyProgramme Class Reference

Class ilStudyProgramme. More...

Inheritance diagram for ilStudyProgramme:

Collaboration diagram for ilStudyProgramme:

Public Member Functions
	getObjId ()
	Get the id of the study program. More...
	getSubtypeId ()
	Return the meta-data subtype id. More...
	setSubtypeId ($subtype_id)
	Sets the meta-data type id. More...
	getLastChange ()
	Get the timestamp of the last change on this program or a sub program. More...
	updateLastChange ()
	Update the last change timestamp to the current time. More...
	setLastChange (ilDateTime $a_timestamp)
	Set the last change timestamp to the given time. More...
	setPoints ($a_points)
	Set the amount of points. More...
	getPoints ()
	Get the amount of points. More...
	setLPMode ($a_mode)
	Set the lp mode. More...
	getLPMode ()
	Get the lp mode. More...
	setStatus ($a_status)
	Set the status of the node. More...
	getStatus ()
	Get the status. More...
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	setConnectorContainerName ($connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct ($primary_key=0, arConnector $connector=null)
	storeObjectToCache ()
	__getConvertedDateFieldsAsArray ($format=null)
	__asCsv ($separator=';', $header=false)
	__asArray ()
	__asStdClass ()
	__asSerializedObject ()
	buildFromArray (array $array)
	fixDateField ($field_name, $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForDb ()
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy ($new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
static	createForObject (ilObject $a_object)
	Create new study program settings for an object. More...
Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()
static	installDB ()
static	renameDBField ($old_name, $new_name)
static	tableExists ()
static	fieldExists ($field_name)
static	removeDBField ($field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=array())
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	orderBy ($orderBy, $orderDirection='ASC')
static	dateFormat ($date_format='d.m.Y - H:i:s')
static	limit ($start, $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $connector)
static	raw ($set_raw=true)
static	getArray ($key=null, $values=null)
static	_toCamelCase ($str, $capitalise_first_char=false)

Data Fields
const	MODE_UNDEFINED = 0
const	MODE_POINTS = 1
const	MODE_LP_COMPLETED = 2
const	STATUS_DRAFT = 10
const	STATUS_ACTIVE = 20
const	STATUS_OUTDATED = 30
const	DEFAULT_POINTS = 100
const	DEFAULT_SUBTYPE = 0
Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Static Public Attributes
static	$MODES
static	$STATUS

Protected Member Functions
	setObjId ($a_id)
Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...
	installDatabase ()

Protected Attributes
	$obj_id
	$last_change
	$subtype_id
	$points
	$lp_mode
	$status
Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true
	$connector_container_name = ''

Additional Inherited Members
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
static	fromCamelCase ($str)

Detailed Description

Class ilStudyProgramme.

Author

: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version

: 0.1.0

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

Member Function Documentation

createForObject()

static ilStudyProgramme::createForObject ( ilObject  $a_object )

static

Create new study program settings for an object.

Throws when object is no program object.

Exceptions

ilException

Returns

ilStudyProgramme

Definition at line 150 of file class.ilStudyProgramme.php.

    {
        if ($a_object->getType() != "prg") {
            throw new ilException("ilStudyProgramme::createSettingsForObject: "
                                 . "Object is no prg object.");
        }
        if (!$a_object->getId()) {
            throw new ilException("ilStudyProgramme::createSettingsForObject: "
                                 . "Object has no id.");
        }
 
        $prg = new ilStudyProgramme();
        $prg->subtype_id = self::DEFAULT_SUBTYPE;
        $prg->setObjId($a_object->getId())
            ->setStatus(self::STATUS_DRAFT)
            ->setLPMode(self::MODE_UNDEFINED)
            ->setPoints(self::DEFAULT_POINTS)
            ->create();
        return $prg;
    }

References DEFAULT_SUBTYPE, ilObject\getId(), and ilObject\getType().

Referenced by ilObjStudyProgramme\createSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

getLastChange()

ilStudyProgramme::getLastChange

(

)

Get the timestamp of the last change on this program or a sub program.

Returns

ilDateTime

Definition at line 214 of file class.ilStudyProgramme.php.

    {
        return new ilDateTime($this->last_change, IL_CAL_DATETIME);
    }

References IL_CAL_DATETIME.

Referenced by setLastChange().

Here is the caller graph for this function:

getLPMode()

ilStudyProgramme::getLPMode

(

)

Get the lp mode.

Returns

integer - one of self::$MODES

Definition at line 307 of file class.ilStudyProgramme.php.

    {
        return (int) $this->lp_mode;
    }

References $lp_mode.

getObjId()

ilStudyProgramme::getObjId

(

)

Get the id of the study program.

Returns

integer

Definition at line 183 of file class.ilStudyProgramme.php.

    {
        return (int) $this->obj_id;
    }

References $obj_id.

Referenced by ilStudyProgrammeAssignment\createFor(), and ilStudyProgrammeProgress\createFor().

Here is the caller graph for this function:

getPoints()

ilStudyProgramme::getPoints

(

)

Get the amount of points.

Returns

integer - larger than zero

Definition at line 277 of file class.ilStudyProgramme.php.

    {
        return (int) $this->points;
    }

References $points.

Referenced by ilStudyProgrammeProgress\createFor().

Here is the caller graph for this function:

getStatus()

ilStudyProgramme::getStatus

(

)

Get the status.

Returns

integer - one of self::$STATUS

Definition at line 338 of file class.ilStudyProgramme.php.

    {
        return (int) $this->status;
    }

References $status.

getSubtypeId()

ilStudyProgramme::getSubtypeId

(

)

Return the meta-data subtype id.

Returns

int

Definition at line 193 of file class.ilStudyProgramme.php.

    {
        return $this->subtype_id;
    }

References $subtype_id.

returnDbTableName()

static ilStudyProgramme::returnDbTableName ( )

static

Returns

string

Reimplemented from ActiveRecord.

Definition at line 59 of file class.ilStudyProgramme.php.

    {
        return "prg_settings";
    }

Referenced by ilObjStudyProgrammeTest\testDeleteRemovesEntriesInPrgSettings().

Here is the caller graph for this function:

setLastChange()

ilStudyProgramme::setLastChange

(

ilDateTime

$a_timestamp

)

Set the last change timestamp to the given time.

Throws when given time is smaller then current timestamp since that is logically impossible.

Returns

$this

Definition at line 238 of file class.ilStudyProgramme.php.

    {
        if (ilDateTime::_before($a_timestamp, $this->getLastChange())) {
            throw new ilException("ilStudyProgramme::setLastChange: Given "
                                 . "timestamp is before current timestamp. That "
                                 . "is logically impossible.");
        }
        
        $this->last_change = $a_timestamp->get(IL_CAL_DATETIME);
        return $this;
    }

References ilDateTime\_before(), ilDateTime\get(), getLastChange(), and IL_CAL_DATETIME.

Referenced by updateLastChange().

Here is the call graph for this function:

Here is the caller graph for this function:

setLPMode()

ilStudyProgramme::setLPMode

(

$a_mode

)

Set the lp mode.

Throws when program is not in draft status.

Parameters

integer

$a_mode

- one of self::$MODES

Returns

$this

Definition at line 290 of file class.ilStudyProgramme.php.

    {
        $a_mode = (int) $a_mode;
        if (!in_array($a_mode, self::$MODES)) {
            throw new ilException("ilStudyProgramme::setLPMode: No lp mode: "
                                 . "'$a_mode'");
        }
        $this->lp_mode = $a_mode;
        $this->updateLastChange();
        return $this;
    }

References updateLastChange().

Here is the call graph for this function:

setObjId()

ilStudyProgramme::setObjId (   $a_id )

protected

Definition at line 172 of file class.ilStudyProgramme.php.

    {
        $this->obj_id = $a_id;
        return $this;
    }

setPoints()

ilStudyProgramme::setPoints

(

$a_points

)

Set the amount of points.

Parameters

integer

$a_points

- larger than zero

Exceptions

ilException

Returns

$this

Definition at line 259 of file class.ilStudyProgramme.php.

    {
        $a_points = (int) $a_points;
        if ($a_points < 0) {
            throw new ilException("ilStudyProgramme::setPoints: Points cannot "
                                 . "be smaller than zero.");
        }
 
        $this->points = $a_points;
        $this->updateLastChange();
        return $this;
    }

References updateLastChange().

Here is the call graph for this function:

setStatus()

ilStudyProgramme::setStatus

(

$a_status

)

Set the status of the node.

TODO: Should this throw, when one wants to go back in lifecycle? Maybe getting back to draft needs to be forbidden only?

Parameters

integer

$a_status

- one of self::$STATUS

Returns

$this

Definition at line 321 of file class.ilStudyProgramme.php.

    {
        $a_status = (int) $a_status;
        if (!in_array($a_status, self::$STATUS)) {
            throw new ilException("ilStudyProgramme::setStatus: No lp mode: "
                                 . "'$a_status'");
        }
        $this->status = $a_status;
        $this->updateLastChange();
        return $this;
    }

References updateLastChange().

Here is the call graph for this function:

setSubtypeId()

ilStudyProgramme::setSubtypeId

(

$subtype_id

)

Sets the meta-data type id.

Parameters

int

$subtype_id

Definition at line 204 of file class.ilStudyProgramme.php.

    {
        $this->subtype_id = $subtype_id;
    }

References $subtype_id.

updateLastChange()

ilStudyProgramme::updateLastChange

(

)

Update the last change timestamp to the current time.

Returns

$this

Definition at line 224 of file class.ilStudyProgramme.php.

    {
        $this->setLastChange(new ilDateTime(ilUtil::now(), IL_CAL_DATETIME));
        return $this;
    }

References IL_CAL_DATETIME, ilUtil\now(), and setLastChange().

Referenced by setLPMode(), setPoints(), and setStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$last_change

ilStudyProgramme::$last_change

protected

Definition at line 87 of file class.ilStudyProgramme.php.

$lp_mode

ilStudyProgramme::$lp_mode

protected

Definition at line 127 of file class.ilStudyProgramme.php.

Referenced by getLPMode().

$MODES

ilStudyProgramme::$MODES

static

Initial value:

= array( ilStudyProgramme::MODE_UNDEFINED
                         , ilStudyProgramme::MODE_POINTS
                         , ilStudyProgramme::MODE_LP_COMPLETED
                         )

Definition at line 29 of file class.ilStudyProgramme.php.

$obj_id

ilStudyProgramme::$obj_id

protected

Definition at line 75 of file class.ilStudyProgramme.php.

Referenced by getObjId().

$points

ilStudyProgramme::$points

protected

Definition at line 115 of file class.ilStudyProgramme.php.

Referenced by getPoints().

$STATUS

ilStudyProgramme::$STATUS

static

Initial value:

= array( ilStudyProgramme::STATUS_DRAFT
                          , ilStudyProgramme::STATUS_ACTIVE
                          , ilStudyProgramme::STATUS_OUTDATED
                          )

Definition at line 46 of file class.ilStudyProgramme.php.

$status

ilStudyProgramme::$status

protected

Definition at line 139 of file class.ilStudyProgramme.php.

Referenced by getStatus().

$subtype_id

ilStudyProgramme::$subtype_id

protected

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

Referenced by getSubtypeId(), and setSubtypeId().

DEFAULT_POINTS

const ilStudyProgramme::DEFAULT_POINTS = 100

Definition at line 53 of file class.ilStudyProgramme.php.

Referenced by ilObjStudyProgrammeTest\testApplyToSubTreeNodes(), ilStudyProgrammeUserProgressTest\testCanBeCompleted2(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeUserProgressTest\testExplicitPointUpdate1(), ilStudyProgrammeUserProgressTest\testExplicitPointUpdate2(), ilStudyProgrammeUserProgressTest\testIndividualRequiredPoints(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeUserProgressTest\testMaximimPossibleAmountOfPoints1(), ilStudyProgrammeUserProgressTest\testMaximimPossibleAmountOfPoints2(), ilStudyProgrammeUserProgressTest\testNoImplicitPointUpdate(), and ilStudyProgrammeUserProgressTest\testNoUpdateOnModifiedNodes().

DEFAULT_SUBTYPE

const ilStudyProgramme::DEFAULT_SUBTYPE = 0

Definition at line 54 of file class.ilStudyProgramme.php.

Referenced by createForObject().

MODE_LP_COMPLETED

const ilStudyProgramme::MODE_LP_COMPLETED = 2

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

Referenced by ilObjStudyProgramme\addLeaf(), ilObjStudyProgramme\addNode(), ilObjStudyProgramme\adjustLPMode(), ilStudyProgrammeUserProgress\canBeCompleted(), ilStudyProgrammeUserProgress\getChildrenProgress(), ilObjStudyProgramme\getCreatableSubObjects(), ilStudyProgrammeUserProgress\getMaximumPossibleAmountOfPoints(), ilObjStudyProgramme\nodeInserted(), ilStudyProgrammeUserProgress\setLPCompleted(), ilObjStudyProgramme\setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), ilObjStudyProgrammeTest\testAddLeaf(), and ilStudyProgrammeUserProgress\updateStatus().

MODE_POINTS

const ilStudyProgramme::MODE_POINTS = 1

Definition at line 24 of file class.ilStudyProgramme.php.

Referenced by ilObjStudyProgramme\adjustLPMode(), ilObjStudyProgramme\getCreatableSubObjects(), ilObjStudyProgramme\nodeInserted(), and ilObjStudyProgrammeTest\testAddNode().

MODE_UNDEFINED

const ilStudyProgramme::MODE_UNDEFINED = 0

Definition at line 20 of file class.ilStudyProgramme.php.

Referenced by ilObjStudyProgramme\adjustLPMode(), and ilObjStudyProgramme\getCreatableSubObjects().

STATUS_ACTIVE

const ilStudyProgramme::STATUS_ACTIVE = 20

Definition at line 41 of file class.ilStudyProgramme.php.

Referenced by ilObjStudyProgramme\assignUser(), ilObjStudyProgrammeSettingsGUI\getStatusOptions(), ilObjStudyProgramme\isActive(), ilStudyProgrammeLPTest\setAllNodesActive(), ilStudyProgrammeUserProgressTest\setAllNodesActive(), ilStudyProgrammeEventsTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUpNodes(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilObjStudyProgrammeTest\testCanRemoveNodeWithNotRelevantProgress(), ilObjStudyProgrammeTest\testCantRemoveNodeWithRelevantProgress(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeUserAssignmentTest\testDeassignRemovesEntriesInPrgUsrAssignment(), ilStudyProgrammeUserAssignmentTest\testDeleteOfProgrammeRemovesEntriesInPrgUsrAssignment(), ilStudyProgrammeUserAssignmentTest\testGetAmountOfAssignments(), ilStudyProgrammeUserAssignmentTest\testGetAssignments(), ilStudyProgrammeUserAssignmentTest\testGetAssignmentsOf(), ilStudyProgrammeUserAssignmentTest\testHasAssignmentOf(), ilStudyProgrammeLPTest\testInitialLPDraft(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), ilStudyProgrammeLPTest\testInitialProgressOutdated(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeUserAssignmentTest\testRemoveAssignment1(), ilStudyProgrammeUserAssignmentTest\testRemoveAssignment2(), ilStudyProgrammeUserAssignmentTest\testRemoveOnRootNodeOnly1(), ilStudyProgrammeUserAssignmentTest\testRemoveOnRootNodeOnly2(), ilObjStudyProgrammeTest\testSettings(), ilStudyProgrammeUserAssignmentTest\testUserId(), and ilStudyProgrammeUserProgress\updateFromProgramNode().

STATUS_DRAFT

const ilStudyProgramme::STATUS_DRAFT = 10

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

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fillRow(), ilObjStudyProgrammeSettingsGUI\getStatusOptions(), ilObjStudyProgrammeTest\testDefaults(), ilStudyProgrammeLPTest\testInitialLPDraft(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), and ilStudyProgrammeUserAssignmentTest\testNoAssignmentWhenDraft().

STATUS_OUTDATED

const ilStudyProgramme::STATUS_OUTDATED = 30

Definition at line 44 of file class.ilStudyProgramme.php.

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fillRow(), ilObjStudyProgrammeSettingsGUI\getStatusOptions(), ilStudyProgrammeIndividualPlanProgressListGUI\getTitleForItem(), ilStudyProgrammeUserProgress\markAccredited(), ilObjStudyProgrammeTest\testCanRemoveNodeWithNotRelevantProgress(), ilStudyProgrammeLPTest\testInitialProgressOutdated(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeUserAssignmentTest\testNoAssignmentWhenOutdated(), and ilStudyProgrammeUserProgressTest\testOutdatedNodesCantBeSetToRelevant().

---

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

• Modules/StudyProgramme/classes/model/class.ilStudyProgramme.php