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

Collaboration diagram for ilExportOptions:

Public Member Functions
	getSubitemsForCreation (int $a_source_id)
	Get all subitems with mode `ilExportOptions::EXPORT_BUILD` More...

	getSubitemsForExport ()
	Get all subitems with mode != self::EXPORT_OMIT. More...

	getExportId ()

	addOption (int $a_keyword, int $a_ref_id, int $a_obj_id, $a_value)

	addOptions (int $parent_ref_id, ilObjectDefinition $object_definition, ilAccessHandler $il_access, array $child_nodes, array $cp_options)

	getOption (int $a_keyword)

	getOptionByObjId (int $a_obj_id, int $a_keyword)
	Get option by. More...

	getOptionByRefId (int $a_ref_id, int $a_keyword)
	Get option by. More...

	delete ()

	read ()

Static Public Member Functions
static	getInstance ()

static	newInstance (int $a_export_id)

static	allocateExportId ()

Data Fields
const	EXPORT_EXISTING = 1

const	EXPORT_BUILD = 2

const	EXPORT_OMIT = 3

const	KEY_INIT = 1

const	KEY_ITEM_MODE = 2

const	KEY_ROOT = 3

Protected Attributes
ilDBInterface	$db

Private Member Functions
	__construct (int $a_export_id)

Private Attributes
int	$export_id = 0

array	$ref_options = array()

array	$obj_options = array()

array	$options = array()

Static Private Attributes
static ilExportOptions	$instance = null

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 options

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 24 of file class.ilExportOptions.php.

Constructor & Destructor Documentation

◆ __construct()

ilExportOptions::__construct ( int $a_export_id )

private

Definition at line 43 of file class.ilExportOptions.php.

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->export_id = $a_export_id;
         if ($this->export_id) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addOption()

ilExportOptions::addOption	(	int	$a_keyword,
		int	$a_ref_id,
		int	$a_obj_id,
			$a_value
	)

Parameters

int	$a_keyword
int	$a_ref_id
int	$a_obj_id
string \| int	$a_value

Definition at line 133 of file class.ilExportOptions.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, getExportId(), ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by addOptions().

                                                                                      : void
     {
         $query = "SELECT MAX(pos) position FROM export_options";
         $res = $this->db->query($query);
 
         $pos = 0;
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $pos = (int) $row->position;
         }
         $pos++;
 
         $query = 'INSERT INTO export_options (export_id,keyword,ref_id,obj_id,value,pos) ' .
             'VALUES( ' .
             $this->db->quote($this->getExportId(), ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($a_keyword, ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($a_ref_id, ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($a_obj_id, ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($a_value, ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($pos, ilDBConstants::T_INTEGER) . ' ' .
             ')';
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addOptions()

ilExportOptions::addOptions	(	int	$parent_ref_id,
		ilObjectDefinition	$object_definition,
		ilAccessHandler	$il_access,
		array	$child_nodes,
		array	$cp_options
	)

Definition at line 156 of file class.ilExportOptions.php.

References $DIC, addOption(), ilObjectDefinition\allowExport(), ilRBACAccessHandler\checkAccess(), EXPORT_BUILD, EXPORT_OMIT, and KEY_ITEM_MODE.

      : bool {
         global $DIC;
         $items_selected = false;
         foreach ($child_nodes as $node) {
             if ($node['type'] === 'rolf') {
                 continue;
             }
             if ((int) $node['ref_id'] === $parent_ref_id) {
                 $this->addOption(
                     ilExportOptions::KEY_ITEM_MODE,
                     (int) $node['ref_id'],
                     (int) $node['obj_id'],
                     ilExportOptions::EXPORT_BUILD
                 );
                 continue;
             }
             // no export available or no access
             if (!$object_definition->allowExport($node['type']) || !$il_access->checkAccess(
                 'write',
                 '',
                 (int) $node['ref_id']
             )) {
                 $this->addOption(
                     ilExportOptions::KEY_ITEM_MODE,
                     (int) $node['ref_id'],
                     (int) $node['obj_id'],
                     ilExportOptions::EXPORT_OMIT
                 );
                 continue;
             }
 
             $mode = $cp_options[$node['ref_id']]['type'] ?? ilExportOptions::EXPORT_OMIT;
             $this->addOption(
                 ilExportOptions::KEY_ITEM_MODE,
                 (int) $node['ref_id'],
                 (int) $node['obj_id'],
                 $mode
             );
             if ($mode != ilExportOptions::EXPORT_OMIT) {
                 $items_selected = true;
             }
         }
         return $items_selected;
     }

Here is the call graph for this function:

◆ allocateExportId()

static ilExportOptions::allocateExportId ( )

static

Definition at line 67 of file class.ilExportOptions.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilExportGUI\createXMLContainerExport(), and ilObjRoleGUI\executeCommand().

                                              : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         // get last export id
         $query = 'SELECT MAX(export_id) exp FROM export_options ' .
             'GROUP BY export_id ';
         $res = $ilDB->query($query);
         $exp_id = 1;
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $exp_id = $row->exp + 1;
         }
         $query = 'INSERT INTO export_options (export_id,keyword,ref_id,obj_id,value) ' .
             'VALUES( ' .
             $ilDB->quote($exp_id, 'integer') . ', ' .
             $ilDB->quote(self::KEY_INIT, 'integer') . ', ' .
             $ilDB->quote(0, 'integer') . ', ' .
             $ilDB->quote(0, 'integer') . ', ' .
             $ilDB->quote(0, 'integer') . ' ' .
             ')';
         $ilDB->manipulate($query);
         return (int) $exp_id;
     }

Here is the caller graph for this function:

◆ delete()

ilExportOptions::delete ( )

Definition at line 238 of file class.ilExportOptions.php.

References getExportId(), and ilDBConstants\T_INTEGER.

                             : void
     {
         $query = "DELETE FROM export_options " .
             "WHERE export_id = " . $this->db->quote($this->getExportId(), ilDBConstants::T_INTEGER);
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ getExportId()

ilExportOptions::getExportId ( )

Definition at line 122 of file class.ilExportOptions.php.

References $export_id.

Referenced by addOption(), delete(), and read().

                                  : int
     {
         return $this->export_id;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilExportOptions::getInstance ( )

static

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

Referenced by ilContainerXmlWriter\__construct(), ilContainerReferenceExporter\getXmlExportHeadDependencies(), ilAccessControlExporter\getXmlRepresentation(), and ilExportOptionsTest\testConstruct().

                                         : ?ilExportOptions
     {
         if (self::$instance) {
             return self::$instance;
         }
         return null;
     }

Here is the caller graph for this function:

◆ getOption()

ilExportOptions::getOption ( int $a_keyword )

Parameters

$a_keyword

Returns: mixed|null

Definition at line 211 of file class.ilExportOptions.php.

     {
         return $this->options[$a_keyword] ?? null;
     }

◆ getOptionByObjId()

ilExportOptions::getOptionByObjId	(	int	$a_obj_id,
		int	$a_keyword
	)

Get option by.

Parameters

int	$a_obj_id
int	$a_keyword

Returns: mixed|null

Definition at line 222 of file class.ilExportOptions.php.

     {
         return $this->obj_options[$a_keyword][$a_obj_id] ?? null;
     }

◆ getOptionByRefId()

ilExportOptions::getOptionByRefId	(	int	$a_ref_id,
		int	$a_keyword
	)

Get option by.

Parameters

int	$a_obj_id
int	$a_keyword

Returns: mixed|null

Definition at line 233 of file class.ilExportOptions.php.

     {
         return $this->ref_options[$a_keyword][$a_ref_id] ?? null;
     }

◆ getSubitemsForCreation()

ilExportOptions::getSubitemsForCreation ( int $a_source_id )

Get all subitems with mode ilExportOptions::EXPORT_BUILD

Definition at line 96 of file class.ilExportOptions.php.

References $ref_id.

                                                             : array
     {
         $refs = array();
         foreach ((array) $this->ref_options[self::KEY_ITEM_MODE] as $ref_id => $mode) {
             if ($mode == self::EXPORT_BUILD) {
                 $refs[] = $ref_id;
             }
         }
         return $refs;
     }

◆ getSubitemsForExport()

ilExportOptions::getSubitemsForExport ( )

Get all subitems with mode != self::EXPORT_OMIT.

Returns: int[] ref ids

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

References $ref_id, and ILIAS\Repository\int().

     {
         $refs = array();
         foreach ((array) $this->ref_options[self::KEY_ITEM_MODE] as $ref_id => $mode) {
             if ($mode != self::EXPORT_OMIT) {
                 $refs[] = (int) $ref_id;
             }
         }
         return $refs;
     }

Here is the call graph for this function:

◆ newInstance()

static ilExportOptions::newInstance ( int $a_export_id )

static

Definition at line 62 of file class.ilExportOptions.php.

Referenced by ilExportGUI\createXMLContainerExport(), ilObjRoleGUI\executeCommand(), and ilExportOptionsTest\testConstruct().

                                                         : ilExportOptions
     {
         return self::$instance = new ilExportOptions($a_export_id);
     }

Here is the caller graph for this function:

◆ read()

ilExportOptions::read ( )

Definition at line 245 of file class.ilExportOptions.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, getExportId(), ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by __construct().

                           : void
     {
         $this->options = array();
         $this->obj_options = array();
         $this->ref_options = array();
 
         $query = "SELECT * FROM export_options " .
             "WHERE export_id = " . $this->db->quote($this->getExportId(), ilDBConstants::T_INTEGER) . ' ' .
             "ORDER BY pos";
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($row->ref_id) {
                 $this->ref_options[(int) $row->keyword][(int) $row->ref_id] = $row->value;
             }
             if ($row->obj_id) {
                 $this->obj_options[(int) $row->keyword][(int) $row->obj_id] = $row->value;
             }
             if (!$row->ref_id and !$row->obj_id) {
                 $this->options[(int) $row->keyword] = $row->value;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ilExportOptions::$db

protected

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

◆ $export_id

int ilExportOptions::$export_id = 0

private

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

Referenced by getExportId().

◆ $instance

ilExportOptions ilExportOptions::$instance = null

staticprivate

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

◆ $obj_options

array ilExportOptions::$obj_options = array()

private

Definition at line 38 of file class.ilExportOptions.php.

◆ $options

array ilExportOptions::$options = array()

private

Definition at line 39 of file class.ilExportOptions.php.

◆ $ref_options

array ilExportOptions::$ref_options = array()

private

Definition at line 37 of file class.ilExportOptions.php.

◆ EXPORT_BUILD

const ilExportOptions::EXPORT_BUILD = 2

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

Referenced by addOptions(), ilExportGUI\createXMLContainerExport(), and ilExportSelectionTableGUI\fillRow().

◆ EXPORT_EXISTING

const ilExportOptions::EXPORT_EXISTING = 1

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

Referenced by ilExportGUI\createXMLContainerExport(), and ilExportSelectionTableGUI\fillRow().

◆ EXPORT_OMIT

const ilExportOptions::EXPORT_OMIT = 3

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

Referenced by addOptions(), ilExportGUI\createXMLContainerExport(), ilExportSelectionTableGUI\fillRow(), and ilContainerXmlWriter\writeSubitems().

◆ KEY_INIT

const ilExportOptions::KEY_INIT = 1

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

◆ KEY_ITEM_MODE

const ilExportOptions::KEY_ITEM_MODE = 2

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

Referenced by addOptions(), and ilContainerXmlWriter\writeSubitems().

◆ KEY_ROOT

const ilExportOptions::KEY_ROOT = 3

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

Referenced by ilExportGUI\createXMLContainerExport(), ilObjRoleGUI\executeCommand(), ilContainerReferenceExporter\getXmlExportHeadDependencies(), and ilAccessControlExporter\getXmlRepresentation().

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

components/ILIAS/Export/classes/class.ilExportOptions.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOption()

◆ addOptions()

◆ allocateExportId()

◆ delete()

◆ getExportId()

◆ getInstance()

◆ getOption()

◆ getOptionByObjId()

◆ getOptionByRefId()

◆ getSubitemsForCreation()

◆ getSubitemsForExport()

◆ newInstance()

◆ read()

Field Documentation

◆ $db

◆ $export_id

◆ $instance

◆ $obj_options

◆ $options

◆ $ref_options

◆ EXPORT_BUILD

◆ EXPORT_EXISTING

◆ EXPORT_OMIT

◆ KEY_INIT

◆ KEY_ITEM_MODE

◆ KEY_ROOT