ilExportLimitation Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilExportLimitation:

Public Member Functions
	__construct ()
	getLimitationMode ()
	getLimitationNumber ()
	checkLimitation (int $ref_id, array $options)

Data Fields
const	SET_EXPORT_DISABLED = 1
const	SET_EXPORT_LIMITED = 0

Protected Attributes
const	SET_LIMIT_NUMBER = "rep_export_limit_number"
const	SET_LIMITATION = "rep_export_limitation"
ilTree	$tree
ilSetting	$settings
ilLanguage	$lng

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Export limitation checker

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilExportLimitation::__construct

(

)

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

References $DIC, ILIAS\Repository\lng(), and ILIAS\Repository\settings().

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->settings = $DIC->settings();
        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

checkLimitation()

ilExportLimitation::checkLimitation	(	int	$ref_id,
		array	$options
	)

Definition at line 55 of file class.ilExportLimitation.php.

References getLimitationMode(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

                                                                : void
    {
        $max = (int) $this->settings->get(self::SET_LIMIT_NUMBER);

        if ($this->getLimitationMode() == self::SET_EXPORT_DISABLED) {
            throw new ilExportLimitationExceptionException(
                $this->lng->txt("exp_error_disabled")
            );
        }

        $cnt = 0;
        foreach ($this->tree->getSubTree($root = $this->tree->getNodeData($ref_id)) as $node) {
            if (isset($options[$node["child"]]) && (in_array((int) $options[$node["child"]]["type"], [1, 2]))) {
                $cnt++;
            }
        }
        if ($max > 0 && $cnt > $max) {
            throw new ilExportLimitationExceptionException(str_replace(
                "%1",
                (string) $max,
                $this->lng->txt("exp_error_too_many_objects")
            ));
        }
    }

Here is the call graph for this function:

getLimitationMode()

ilExportLimitation::getLimitationMode

(

)

Definition at line 45 of file class.ilExportLimitation.php.

References ILIAS\Repository\settings().

Referenced by checkLimitation().

                                       : int
    {
        return (int) $this->settings->get(self::SET_LIMITATION);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLimitationNumber()

ilExportLimitation::getLimitationNumber

(

)

Definition at line 50 of file class.ilExportLimitation.php.

References ILIAS\Repository\settings().

                                         : int
    {
        return (int) $this->settings->get(self::SET_LIMIT_NUMBER);
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilExportLimitation::$lng

protected

Definition at line 34 of file class.ilExportLimitation.php.

$settings

ilSetting ilExportLimitation::$settings

protected

Definition at line 33 of file class.ilExportLimitation.php.

$tree

ilTree ilExportLimitation::$tree

protected

Definition at line 32 of file class.ilExportLimitation.php.

SET_EXPORT_DISABLED

const ilExportLimitation::SET_EXPORT_DISABLED = 1

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

Referenced by ilExportGUI\executeCommand(), and ilObjRepositorySettingsGUI\initSettingsForm().

SET_EXPORT_LIMITED

const ilExportLimitation::SET_EXPORT_LIMITED = 0

Definition at line 30 of file class.ilExportLimitation.php.

Referenced by ilObjRepositorySettingsGUI\initSettingsForm(), and ilObjRepositorySettingsGUI\saveSettings().

SET_LIMIT_NUMBER

const ilExportLimitation::SET_LIMIT_NUMBER = "rep_export_limit_number"

protected

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

SET_LIMITATION

const ilExportLimitation::SET_LIMITATION = "rep_export_limitation"

protected

Definition at line 28 of file class.ilExportLimitation.php.

---

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

• Services/Export/classes/class.ilExportLimitation.php