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

Settings for an LSO (like abstract, extro) More...

+ Collaboration diagram for ilLearningSequenceSettings:

Public Member Functions

 __construct (int $obj_id, string $abstract='', string $extro='', string $abstract_image=null, string $extro_image=null, bool $members_gallery=false)
 
 getObjId ()
 
 getAbstract ()
 
 withAbstract (string $abstract)
 
 getExtro ()
 
 withExtro (string $extro)
 
 getAbstractImage ()
 
 withAbstractImage (string $path=null)
 
 getExtroImage ()
 
 withExtroImage (string $path=null)
 
 getUploads ()
 
 withUpload (array $upload_info, string $which)
 
 getDeletions ()
 
 withDeletion (string $which)
 
 getMembersGallery ()
 
 withMembersGallery (bool $members_gallery)
 

Protected Attributes

 $obj_id
 
 $abstract
 
 $extro
 
 $abstract_image
 
 $extro_image
 
 $uploads = []
 
 $deletions = []
 
 $members_gallery
 

Detailed Description

Settings for an LSO (like abstract, extro)

Author
Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 10 of file class.ilLearningSequenceSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceSettings::__construct ( int  $obj_id,
string  $abstract = '',
string  $extro = '',
string  $abstract_image = null,
string  $extro_image = null,
bool  $members_gallery = false 
)

Member Function Documentation

◆ getAbstract()

◆ getAbstractImage()

◆ getDeletions()

ilLearningSequenceSettings::getDeletions ( )

Definition at line 135 of file class.ilLearningSequenceSettings.php.

References $deletions.

Referenced by ilLearningSequenceSettingsDB\store().

+ Here is the caller graph for this function:

◆ getExtro()

◆ getExtroImage()

◆ getMembersGallery()

◆ getObjId()

◆ getUploads()

ilLearningSequenceSettings::getUploads ( )

Definition at line 123 of file class.ilLearningSequenceSettings.php.

123 : array
124 {
125 return $this->uploads;
126 }

References $uploads.

Referenced by ilLearningSequenceSettingsDB\store().

+ Here is the caller graph for this function:

◆ withAbstract()

ilLearningSequenceSettings::withAbstract ( string  $abstract)

Definition at line 80 of file class.ilLearningSequenceSettings.php.

81 {
82 $clone = clone $this;
83 $clone->abstract = $abstract;
84 return $clone;
85 }
Settings for an LSO (like abstract, extro)

References $abstract.

Referenced by LSSettingsTest\testWithAbstract().

+ Here is the caller graph for this function:

◆ withAbstractImage()

ilLearningSequenceSettings::withAbstractImage ( string  $path = null)

Definition at line 104 of file class.ilLearningSequenceSettings.php.

105 {
106 $clone = clone $this;
107 $clone->abstract_image = $path;
108 return $clone;
109 }
$path
Definition: aliased.php:25

References $path.

Referenced by ilLearningSequenceFilesystem\delete_image(), and LSSettingsTest\testWithAbstractImage().

+ Here is the caller graph for this function:

◆ withDeletion()

ilLearningSequenceSettings::withDeletion ( string  $which)

Definition at line 140 of file class.ilLearningSequenceSettings.php.

141 {
142 $clone = clone $this;
143 $clone->deletions[] = $which;
144 return $clone;
145 }

◆ withExtro()

ilLearningSequenceSettings::withExtro ( string  $extro)

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

93 {
94 $clone = clone $this;
95 $clone->extro = $extro;
96 return $clone;
97 }

References $extro.

Referenced by LSSettingsTest\testWithExtro().

+ Here is the caller graph for this function:

◆ withExtroImage()

ilLearningSequenceSettings::withExtroImage ( string  $path = null)

Definition at line 116 of file class.ilLearningSequenceSettings.php.

117 {
118 $clone = clone $this;
119 $clone->extro_image = $path;
120 return $clone;
121 }

References $path.

Referenced by ilLearningSequenceFilesystem\delete_image(), and LSSettingsTest\testWithExtroImage().

+ Here is the caller graph for this function:

◆ withMembersGallery()

ilLearningSequenceSettings::withMembersGallery ( bool  $members_gallery)

Definition at line 152 of file class.ilLearningSequenceSettings.php.

153 {
154 $clone = clone $this;
155 $clone->members_gallery = $members_gallery;
156 return $clone;
157 }

References $members_gallery.

Referenced by LSSettingsTest\testWithMembersGallery().

+ Here is the caller graph for this function:

◆ withUpload()

ilLearningSequenceSettings::withUpload ( array  $upload_info,
string  $which 
)

Definition at line 128 of file class.ilLearningSequenceSettings.php.

129 {
130 $clone = clone $this;
131 $clone->uploads[$which] = $upload_info;
132 return $clone;
133 }

Field Documentation

◆ $abstract

ilLearningSequenceSettings::$abstract
protected

Definition at line 21 of file class.ilLearningSequenceSettings.php.

Referenced by __construct(), getAbstract(), and withAbstract().

◆ $abstract_image

ilLearningSequenceSettings::$abstract_image
protected

Definition at line 31 of file class.ilLearningSequenceSettings.php.

Referenced by __construct(), and getAbstractImage().

◆ $deletions

ilLearningSequenceSettings::$deletions = []
protected

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

Referenced by getDeletions().

◆ $extro

ilLearningSequenceSettings::$extro
protected

Definition at line 26 of file class.ilLearningSequenceSettings.php.

Referenced by __construct(), getExtro(), and withExtro().

◆ $extro_image

ilLearningSequenceSettings::$extro_image
protected

Definition at line 36 of file class.ilLearningSequenceSettings.php.

Referenced by __construct(), and getExtroImage().

◆ $members_gallery

ilLearningSequenceSettings::$members_gallery
protected

◆ $obj_id

ilLearningSequenceSettings::$obj_id
protected

Definition at line 16 of file class.ilLearningSequenceSettings.php.

Referenced by __construct(), and getObjId().

◆ $uploads

ilLearningSequenceSettings::$uploads = []
protected

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

Referenced by getUploads().


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