Export options. More...

Collaboration diagram for ilExportOptions:

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

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

	getExportId ()
	Get export id. More...

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

	getOption ($a_keyword)
	Get option. More...

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

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

	delete ()
	Delete by export id. More...

	read ()
	Read entries. More...

Static Public Member Functions
static	getInstance ()
	Get singelton instance. More...

static	newInstance ($a_export_id)
	Create new instance. More...

static	allocateExportId ()
	Allocate a new export id. More...

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

Private Member Functions
	__construct ($a_export_id)
	Singleton constructor. More...

Private Attributes
	$export_id = 0

	$ref_options = array()

	$obj_options = array()

	$options = array()

Static Private Attributes
static	$instance = null

Detailed Description

Export options.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilExportOptions::__construct ( $a_export_id )

private

Singleton constructor.

Returns

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

References read().

     {
         $this->export_id = $a_export_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addOption()

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

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

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and getExportId().

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

Here is the call graph for this function:

◆ allocateExportId()

static ilExportOptions::allocateExportId ( )

static

Allocate a new export id.

Returns

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

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

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

     {
         global $ilDB;
         
         // 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 $exp_id;
     }

Here is the caller graph for this function:

◆ delete()

ilExportOptions::delete ( )

Delete by export id.

Returns

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

References $ilDB, $query, and getExportId().

     {
         global $ilDB;
         
         $query = "DELETE FROM export_options " .
             "WHERE export_id = " . $ilDB->quote($this->getExportId(), 'integer');
         $ilDB->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ getExportId()

ilExportOptions::getExportId ( )

Get export id.

Returns

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

References $export_id.

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

     {
         return $this->export_id;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilExportOptions::getInstance ( )

static

Get singelton instance.

Returns: object ilExportOptions

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

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

     {
         if (self::$instance) {
             return self::$instance;
         }
     }

Here is the caller graph for this function:

◆ getOption()

ilExportOptions::getOption ( $a_keyword )

Get option.

Parameters

object $a_keyword

Returns

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

     {
         return isset($this->options[$a_keyword]) ? $this->options[$a_keyword] : null;
     }

◆ getOptionByObjId()

ilExportOptions::getOptionByObjId	(	$a_obj_id,
		$a_keyword
	)

Get option by.

Parameters

object	$a_obj_id
object	$a_keyword

Returns

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

     {
         return isset($this->obj_options[$a_keyword][$a_obj_id]) ? $this->obj_options[$a_keyword][$a_obj_id] : null;
     }

◆ getOptionByRefId()

ilExportOptions::getOptionByRefId	(	$a_ref_id,
		$a_keyword
	)

Get option by.

Parameters

object	$a_obj_id
object	$a_keyword

Returns

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

     {
         return isset($this->ref_options[$a_keyword][$a_ref_id]) ? $this->ref_options[$a_keyword][$a_ref_id] : null;
     }

◆ getSubitemsForCreation()

ilExportOptions::getSubitemsForCreation ( $a_source_id )

Get all subitems with mode ilExportOptions::EXPORT_BUILD

Parameters

int	ref_id of source

Returns

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

References 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: array ref ids

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

References array.

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

◆ newInstance()

static ilExportOptions::newInstance ( $a_export_id )

static

Create new instance.

Parameters

object $a_export_id

Returns: object ilExportOptions

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

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

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

Here is the caller graph for this function:

◆ read()

ilExportOptions::read ( )

Read entries.

Returns

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

References $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_OBJECT, and getExportId().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $export_id

ilExportOptions::$export_id = 0

private

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

Referenced by getExportId().

◆ $instance

ilExportOptions::$instance = null

staticprivate

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

◆ $obj_options

ilExportOptions::$obj_options = array()

private

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

◆ $options

ilExportOptions::$options = array()

private

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

◆ $ref_options

ilExportOptions::$ref_options = array()

private

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

◆ EXPORT_BUILD

const ilExportOptions::EXPORT_BUILD = 2

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

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

◆ EXPORT_EXISTING

const ilExportOptions::EXPORT_EXISTING = 1

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

Referenced by ilExportSelectionTableGUI\fillRow().

◆ EXPORT_OMIT

const ilExportOptions::EXPORT_OMIT = 3

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

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

◆ KEY_INIT

const ilExportOptions::KEY_INIT = 1

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

◆ KEY_ITEM_MODE

const ilExportOptions::KEY_ITEM_MODE = 2

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

Referenced by ilExportGUI\saveItemSelection(), and ilContainerXmlWriter\writeSubitems().

◆ KEY_ROOT

const ilExportOptions::KEY_ROOT = 3

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

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

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

Services/Export/classes/class.ilExportOptions.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOption()

◆ allocateExportId()

◆ delete()

◆ getExportId()

◆ getInstance()

◆ getOption()

◆ getOptionByObjId()

◆ getOptionByRefId()

◆ getSubitemsForCreation()

◆ getSubitemsForExport()

◆ newInstance()

◆ read()

Field Documentation

◆ $export_id

◆ $instance

◆ $obj_options

◆ $options

◆ $ref_options

◆ EXPORT_BUILD

◆ EXPORT_EXISTING

◆ EXPORT_OMIT

◆ KEY_INIT

◆ KEY_ITEM_MODE

◆ KEY_ROOT