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, int $lso_mod=self::MODE_LINEAR)

	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)

	getLSOMod ()

	getMode ()

	withLSOMod (int $lso_mod)

	withMode (int $lso_mod)

Data Fields
const	MODE_LINEAR = 0

const	MODE_ADAPTIVE = 1

Protected Attributes
int	$obj_id

string	$abstract

string	$extro

string	$abstract_image

string	$extro_image

int	$lso_mod

array	$uploads = []

array	$deletions = []

bool	$members_gallery

Detailed Description

Settings for an LSO (like abstract, extro)

Definition at line 24 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`,
		int	$lso_mod = `self::MODE_LINEAR`
	)

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

      {
        $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;
        $this->lso_mod = $lso_mod;
    }

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

Member Function Documentation

◆ getAbstract()

ilLearningSequenceSettings::getAbstract ( )

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

                                 : string
    {
        return $this->abstract;
    }

References $abstract.

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstract(), ilLearningSequenceSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithAbstractImage(), ilLearningSequenceSettingsTest\testWithExtro(), LSSettingsTest\testWithExtro(), ilLearningSequenceSettingsTest\testWithExtroImage(), LSSettingsTest\testWithExtroImage(), ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ getAbstractImage()

ilLearningSequenceSettings::getAbstractImage ( )

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

                                      : string
    {
        return $this->abstract_image ?? '';
    }

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstract(), ilLearningSequenceSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithAbstractImage(), ilLearningSequenceSettingsTest\testWithExtro(), LSSettingsTest\testWithExtro(), ilLearningSequenceSettingsTest\testWithExtroImage(), LSSettingsTest\testWithExtroImage(), ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ getDeletions()

ilLearningSequenceSettings::getDeletions ( )

Returns: string[]

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

                                  : array
    {
        return $this->deletions;
    }

References $deletions.

◆ getExtro()

ilLearningSequenceSettings::getExtro ( )

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

                              : string
    {
        return $this->extro;
    }

References $extro.

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstract(), ilLearningSequenceSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithAbstractImage(), ilLearningSequenceSettingsTest\testWithExtro(), LSSettingsTest\testWithExtro(), ilLearningSequenceSettingsTest\testWithExtroImage(), LSSettingsTest\testWithExtroImage(), ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ getExtroImage()

ilLearningSequenceSettings::getExtroImage ( )

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

                                   : string
    {
        return $this->extro_image ?? '';
    }

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstract(), ilLearningSequenceSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithAbstractImage(), ilLearningSequenceSettingsTest\testWithExtro(), LSSettingsTest\testWithExtro(), ilLearningSequenceSettingsTest\testWithExtroImage(), LSSettingsTest\testWithExtroImage(), ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ getLSOMod()

ilLearningSequenceSettings::getLSOMod ( )

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

                               : int
    {
        return $this->lso_mod;
    }

References $lso_mod.

◆ getMembersGallery()

ilLearningSequenceSettings::getMembersGallery ( )

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

                                       : bool
    {
        return $this->members_gallery;
    }

References $members_gallery.

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstract(), ilLearningSequenceSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithAbstractImage(), ilLearningSequenceSettingsTest\testWithExtro(), LSSettingsTest\testWithExtro(), ilLearningSequenceSettingsTest\testWithExtroImage(), LSSettingsTest\testWithExtroImage(), ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ getMode()

ilLearningSequenceSettings::getMode ( )

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

                             : int
    {
        return $this->lso_mod;
    }

References $lso_mod.

Referenced by LSSettingsTest\testWithMode().

Here is the caller graph for this function:

◆ getObjId()

ilLearningSequenceSettings::getObjId ( )

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

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), LSSettingsTest\testWithAbstract(), ilLearningSequenceSettingsTest\testWithAbstractImage(), LSSettingsTest\testWithAbstractImage(), ilLearningSequenceSettingsTest\testWithExtro(), LSSettingsTest\testWithExtro(), ilLearningSequenceSettingsTest\testWithExtroImage(), LSSettingsTest\testWithExtroImage(), ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ getUploads()

ilLearningSequenceSettings::getUploads ( )

Returns: array<string, array>

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

                                : array
    {
        return $this->uploads;
    }

References $uploads.

◆ withAbstract()

ilLearningSequenceSettings::withAbstract ( string $abstract )

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

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

References $abstract.

Referenced by ilLearningSequenceSettingsTest\testWithAbstract(), and LSSettingsTest\testWithAbstract().

Here is the caller graph for this function:

◆ withAbstractImage()

ilLearningSequenceSettings::withAbstractImage ( ?string $path = null )

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

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

Referenced by ilLearningSequenceSettingsTest\testWithAbstractImage(), and LSSettingsTest\testWithAbstractImage().

Here is the caller graph for this function:

◆ withDeletion()

ilLearningSequenceSettings::withDeletion ( string $which )

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

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

◆ withExtro()

ilLearningSequenceSettings::withExtro ( string $extro )

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

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

References $extro.

Referenced by ilLearningSequenceSettingsTest\testWithExtro(), and LSSettingsTest\testWithExtro().

Here is the caller graph for this function:

◆ withExtroImage()

ilLearningSequenceSettings::withExtroImage ( ?string $path = null )

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

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

Referenced by ilLearningSequenceSettingsTest\testWithExtroImage(), and LSSettingsTest\testWithExtroImage().

Here is the caller graph for this function:

◆ withLSOMod()

ilLearningSequenceSettings::withLSOMod ( int $lso_mod )

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

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

References $lso_mod.

Referenced by withMode().

Here is the caller graph for this function:

◆ withMembersGallery()

ilLearningSequenceSettings::withMembersGallery ( bool $members_gallery )

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

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

References $members_gallery.

Referenced by ilLearningSequenceSettingsTest\testWithMembersGallery(), and LSSettingsTest\testWithMembersGallery().

Here is the caller graph for this function:

◆ withMode()

ilLearningSequenceSettings::withMode ( int $lso_mod )

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

                                          : ilLearningSequenceSettings
    {
        return $this->withLSOMod($lso_mod);
    }

References withLSOMod().

Referenced by LSSettingsTest\testWithMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withUpload()

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

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

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