ilExportLimitation Class Reference

Export limitation checker. More...

Collaboration diagram for ilExportLimitation:

Public Member Functions
	__construct ()
	Constructor. More...
	getLimitationMode ()
	Get limitation mode. More...
	getLimitationNumber ()
	Get limitation number. More...
	checkLimitation ($ref_id, $options)

Data Fields
const	SET_LIMIT_NUMBER = "rep_export_limit_number"
const	SET_LIMITATION = "rep_export_limitation"
const	SET_EXPORT_DISABLED = 1
const	SET_EXPORT_LIMITED = 0

Protected Attributes
	$tree
	$settings
	$lng

Detailed Description

Export limitation checker.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilExportLimitation::__construct

(

)

Constructor.

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

References $DIC, and 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	(		$ref_id,
			$options
	)

Parameters

$ref_id
$options

Exceptions

ilExportLimitationExceptionException

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

References $lng, $settings, $tree, and getLimitationMode().

    {
        $tree = $this->tree;
        $settings = $this->settings;
        $lng = $this->lng;

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

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

        $cnt = 0;
        foreach ($tree->getSubTree($root = $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",
                $max,
                $lng->txt("exp_error_too_many_objects")
            ));
        }
    }

Here is the call graph for this function:

getLimitationMode()

ilExportLimitation::getLimitationMode

(

)

Get limitation mode.

Returns

int

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

References settings().

Referenced by checkLimitation().

    {
        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

(

)

Get limitation number.

Returns

int

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

References settings().

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

Here is the call graph for this function:

Field Documentation

$lng

ilExportLimitation::$lng

protected

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

Referenced by checkLimitation().

$settings

ilExportLimitation::$settings

protected

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

Referenced by checkLimitation().

$tree

ilExportLimitation::$tree

protected

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

Referenced by checkLimitation().

SET_EXPORT_DISABLED

const ilExportLimitation::SET_EXPORT_DISABLED = 1

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

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

SET_EXPORT_LIMITED

const ilExportLimitation::SET_EXPORT_LIMITED = 0

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

Referenced by ilObjRepositorySettingsGUI\initSettingsForm().

SET_LIMIT_NUMBER

const ilExportLimitation::SET_LIMIT_NUMBER = "rep_export_limit_number"

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

SET_LIMITATION

const ilExportLimitation::SET_LIMITATION = "rep_export_limitation"

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

---

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

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