ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilLearningSequenceActivation Class Reference

Activation-Settings for an LSO. More...

+ Collaboration diagram for ilLearningSequenceActivation:

Public Member Functions

 __construct (int $ref_id, bool $online=false, bool $effective_online=false, \DateTime $activation_start=null, \DateTime $activation_end=null)
 
 getRefId ()
 
 getIsOnline ()
 
 withIsOnline (bool $online)
 
 getEffectiveOnlineStatus ()
 
 getActivationStart ()
 
 withActivationStart (\DateTime $activation_start=null)
 
 getActivationEnd ()
 
 withActivationEnd (\DateTime $activation_end=null)
 

Protected Attributes

 $ref_id
 
 $online
 
 $effective_online
 
 $activation_start
 
 $activation_end
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceActivation::__construct ( int  $ref_id,
bool  $online = false,
bool  $effective_online = false,
\DateTime  $activation_start = null,
\DateTime  $activation_end = null 
)

Member Function Documentation

◆ getActivationEnd()

ilLearningSequenceActivation::getActivationEnd ( )
Returns
\DateTime | null

Definition at line 92 of file class.ilLearningSequenceActivation.php.

93 {
95 }

References $activation_end.

Referenced by ilLearningSequenceActivationDB\insert(), and ilLearningSequenceActivationDB\store().

+ Here is the caller graph for this function:

◆ getActivationStart()

ilLearningSequenceActivation::getActivationStart ( )
Returns
\DateTime | null

Definition at line 77 of file class.ilLearningSequenceActivation.php.

78 {
80 }

References $activation_start.

Referenced by ilLearningSequenceActivationDB\insert(), and ilLearningSequenceActivationDB\store().

+ Here is the caller graph for this function:

◆ getEffectiveOnlineStatus()

ilLearningSequenceActivation::getEffectiveOnlineStatus ( )

Definition at line 69 of file class.ilLearningSequenceActivation.php.

69 : bool
70 {
72 }

References $effective_online.

Referenced by ilLearningSequenceActivationDB\insert().

+ Here is the caller graph for this function:

◆ getIsOnline()

ilLearningSequenceActivation::getIsOnline ( )

Definition at line 57 of file class.ilLearningSequenceActivation.php.

57 : bool
58 {
59 return $this->online;
60 }

References $online.

Referenced by ilLearningSequenceActivationDB\insert(), and ilLearningSequenceActivationDB\store().

+ Here is the caller graph for this function:

◆ getRefId()

ilLearningSequenceActivation::getRefId ( )

Definition at line 52 of file class.ilLearningSequenceActivation.php.

52 : int
53 {
54 return $this->ref_id;
55 }

References $ref_id.

Referenced by ilLearningSequenceActivationDB\insert(), and ilLearningSequenceActivationDB\store().

+ Here is the caller graph for this function:

◆ withActivationEnd()

ilLearningSequenceActivation::withActivationEnd ( \DateTime  $activation_end = null)

Definition at line 97 of file class.ilLearningSequenceActivation.php.

98 {
99 $clone = clone $this;
100 $clone->activation_end = $activation_end;
101 return $clone;
102 }

References $activation_end.

◆ withActivationStart()

ilLearningSequenceActivation::withActivationStart ( \DateTime  $activation_start = null)

Definition at line 82 of file class.ilLearningSequenceActivation.php.

83 {
84 $clone = clone $this;
85 $clone->activation_start = $activation_start;
86 return $clone;
87 }

References $activation_start.

◆ withIsOnline()

ilLearningSequenceActivation::withIsOnline ( bool  $online)

Definition at line 62 of file class.ilLearningSequenceActivation.php.

63 {
64 $clone = clone $this;
65 $clone->online = $online;
66 return $clone;
67 }

References $online.

Field Documentation

◆ $activation_end

ilLearningSequenceActivation::$activation_end
protected

◆ $activation_start

ilLearningSequenceActivation::$activation_start
protected

◆ $effective_online

ilLearningSequenceActivation::$effective_online
protected

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

Referenced by __construct(), and getEffectiveOnlineStatus().

◆ $online

ilLearningSequenceActivation::$online
protected

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

Referenced by __construct(), getIsOnline(), and withIsOnline().

◆ $ref_id

ilLearningSequenceActivation::$ref_id
protected

Definition at line 15 of file class.ilLearningSequenceActivation.php.

Referenced by __construct(), and getRefId().


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