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`
	)

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

References $abstract, $abstract_image, $extro, $extro_image, $members_gallery, and $obj_id.

       {
         $this->obj_id = $obj_id;
         $this->abstract = $abstract;
         $this->extro = $extro;
         $this->abstract_image = $abstract_image;
         $this->extro_image = $extro_image;
         $this->members_gallery = $members_gallery;
     }

Member Function Documentation

◆ getAbstract()

ilLearningSequenceSettings::getAbstract ( )

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

References $abstract.

Referenced by ilLearningSequenceSettingsDB\insert(), ilLearningSequenceSettingsDB\store(), LSSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithExtro(), LSSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithMembersGallery().

                                   : string
     {
         return $this->abstract;
     }

Here is the caller graph for this function:

◆ getAbstractImage()

ilLearningSequenceSettings::getAbstractImage ( )

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

References $abstract_image.

Referenced by ilLearningSequenceFilesystem\delete_image(), ilLearningSequenceSettingsDB\store(), LSSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithExtro(), LSSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithMembersGallery().

     {
         return $this->abstract_image;
     }

Here is the caller graph for this function:

◆ getDeletions()

ilLearningSequenceSettings::getDeletions ( )

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

References $deletions.

Referenced by ilLearningSequenceSettingsDB\store().

                                    : array
     {
         return $this->deletions;
     }

Here is the caller graph for this function:

◆ getExtro()

ilLearningSequenceSettings::getExtro ( )

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

References $extro.

Referenced by ilLearningSequenceSettingsDB\insert(), ilLearningSequenceSettingsDB\store(), LSSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithExtro(), LSSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithMembersGallery().

                                : string
     {
         return $this->extro;
     }

Here is the caller graph for this function:

◆ getExtroImage()

ilLearningSequenceSettings::getExtroImage ( )

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

References $extro_image.

Referenced by ilLearningSequenceFilesystem\delete_image(), ilLearningSequenceSettingsDB\store(), LSSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithExtro(), LSSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithMembersGallery().

     {
         return $this->extro_image;
     }

Here is the caller graph for this function:

◆ getMembersGallery()

ilLearningSequenceSettings::getMembersGallery ( )

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

References $members_gallery.

Referenced by ilLearningSequenceSettingsDB\insert(), ilLearningSequenceSettingsDB\store(), LSSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithExtro(), LSSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithMembersGallery().

                                         : bool
     {
         return $this->members_gallery;
     }

Here is the caller graph for this function:

◆ getObjId()

ilLearningSequenceSettings::getObjId ( )

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

References $obj_id.

Referenced by ilLearningSequenceSettingsDB\insert(), ilLearningSequenceFilesystem\moveUploaded(), ilLearningSequenceSettingsDB\store(), LSSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithExtro(), LSSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithMembersGallery().

                                : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getUploads()

ilLearningSequenceSettings::getUploads ( )

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

References $uploads.

Referenced by ilLearningSequenceSettingsDB\store().

                                  : array
     {
         return $this->uploads;
     }

Here is the caller graph for this function:

◆ withAbstract()

ilLearningSequenceSettings::withAbstract ( string $abstract )

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

References $abstract.

Referenced by LSSettingsTest\testWithAbstract().

                                                    : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->abstract = $abstract;
         return $clone;
     }

Here is the caller graph for this function:

◆ withAbstractImage()

ilLearningSequenceSettings::withAbstractImage ( string $path = null )

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

References $path.

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

                                                            : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->abstract_image = $path;
         return $clone;
     }

Here is the caller graph for this function:

◆ withDeletion()

ilLearningSequenceSettings::withDeletion ( string $which )

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

                                                 : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->deletions[] = $which;
         return $clone;
     }

◆ withExtro()

ilLearningSequenceSettings::withExtro ( string $extro )

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

References $extro.

Referenced by LSSettingsTest\testWithExtro().

                                              : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->extro = $extro;
         return $clone;
     }

Here is the caller graph for this function:

◆ withExtroImage()

ilLearningSequenceSettings::withExtroImage ( string $path = null )

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

References $path.

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

                                                         : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->extro_image = $path;
         return $clone;
     }

Here is the caller graph for this function:

◆ withMembersGallery()

ilLearningSequenceSettings::withMembersGallery ( bool $members_gallery )

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

References $members_gallery.

Referenced by LSSettingsTest\testWithMembersGallery().

                                                               : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->members_gallery = $members_gallery;
         return $clone;
     }

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.

                                                                   : ilLearningSequenceSettings
     {
         $clone = clone $this;
         $clone->uploads[$which] = $upload_info;
         return $clone;
     }