ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilExportOptions 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 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.

44 {
45 global $DIC;
46
47 $this->db = $DIC->database();
48 $this->export_id = $a_export_id;
49 if ($this->export_id) {
50 $this->read();
51 }
52 }
global $DIC
Definition: shib_login.php:26

References $DIC, and 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.

133 : void
134 {
135 $query = "SELECT MAX(pos) position FROM export_options";
136 $res = $this->db->query($query);
137
138 $pos = 0;
139 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
140 $pos = (int) $row->position;
141 }
142 $pos++;
143
144 $query = 'INSERT INTO export_options (export_id,keyword,ref_id,obj_id,value,pos) ' .
145 'VALUES( ' .
146 $this->db->quote($this->getExportId(), ilDBConstants::T_INTEGER) . ', ' .
147 $this->db->quote($a_keyword, ilDBConstants::T_INTEGER) . ', ' .
148 $this->db->quote($a_ref_id, ilDBConstants::T_INTEGER) . ', ' .
149 $this->db->quote($a_obj_id, ilDBConstants::T_INTEGER) . ', ' .
150 $this->db->quote($a_value, ilDBConstants::T_INTEGER) . ', ' .
151 $this->db->quote($pos, ilDBConstants::T_INTEGER) . ' ' .
152 ')';
153 $this->db->manipulate($query);
154 }
$res
Definition: ltiservices.php:69

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

Referenced by addOptions().

+ 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.

162 : bool {
163 global $DIC;
164 $items_selected = false;
165 foreach ($child_nodes as $node) {
166 if ($node['type'] === 'rolf') {
167 continue;
168 }
169 if ((int) $node['ref_id'] === $parent_ref_id) {
170 $this->addOption(
172 (int) $node['ref_id'],
173 (int) $node['obj_id'],
175 );
176 continue;
177 }
178 // no export available or no access
179 if (!$object_definition->allowExport($node['type']) || !$il_access->checkAccess(
180 'write',
181 '',
182 (int) $node['ref_id']
183 )) {
184 $this->addOption(
186 (int) $node['ref_id'],
187 (int) $node['obj_id'],
189 );
190 continue;
191 }
192
193 $mode = $cp_options[$node['ref_id']]['type'] ?? ilExportOptions::EXPORT_OMIT;
194 $this->addOption(
196 (int) $node['ref_id'],
197 (int) $node['obj_id'],
198 $mode
199 );
200 if ($mode != ilExportOptions::EXPORT_OMIT) {
201 $items_selected = true;
202 }
203 }
204 return $items_selected;
205 }
addOption(int $a_keyword, int $a_ref_id, int $a_obj_id, $a_value)
checkAccess(string $a_permission, string $a_cmd, int $a_ref_id, string $a_type="", ?int $a_obj_id=null, ?int $a_tree_id=null)
check access for an object (provide $a_type and $a_obj_id if available for better performance)

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

+ Here is the call graph for this function:

◆ allocateExportId()

static ilExportOptions::allocateExportId ( )
static

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

67 : int
68 {
69 global $DIC;
70
71 $ilDB = $DIC->database();
72
73 // get last export id
74 $query = 'SELECT MAX(export_id) exp FROM export_options ' .
75 'GROUP BY export_id ';
76 $res = $ilDB->query($query);
77 $exp_id = 1;
78 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
79 $exp_id = $row->exp + 1;
80 }
81 $query = 'INSERT INTO export_options (export_id,keyword,ref_id,obj_id,value) ' .
82 'VALUES( ' .
83 $ilDB->quote($exp_id, 'integer') . ', ' .
84 $ilDB->quote(self::KEY_INIT, 'integer') . ', ' .
85 $ilDB->quote(0, 'integer') . ', ' .
86 $ilDB->quote(0, 'integer') . ', ' .
87 $ilDB->quote(0, 'integer') . ' ' .
88 ')';
89 $ilDB->manipulate($query);
90 return (int) $exp_id;
91 }

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

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

+ Here is the caller graph for this function:

◆ delete()

ilExportOptions::delete ( )

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

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

References ilDBConstants\T_INTEGER.

◆ getExportId()

ilExportOptions::getExportId ( )

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

122 : int
123 {
124 return $this->export_id;
125 }

References $export_id.

Referenced by addOption().

+ Here is the caller graph for this function:

◆ getInstance()

static ilExportOptions::getInstance ( )
static

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

55 {
56 if (self::$instance) {
57 return self::$instance;
58 }
59 return null;
60 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static ilExportOptions $instance

References $instance.

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

+ 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.

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

◆ 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.

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

◆ 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.

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

◆ getSubitemsForCreation()

ilExportOptions::getSubitemsForCreation ( int  $a_source_id)

Get all subitems with mode ilExportOptions::EXPORT_BUILD

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

96 : array
97 {
98 $refs = array();
99 foreach ((array) $this->ref_options[self::KEY_ITEM_MODE] as $ref_id => $mode) {
100 if ($mode == self::EXPORT_BUILD) {
101 $refs[] = $ref_id;
102 }
103 }
104 return $refs;
105 }
$ref_id
Definition: ltiauth.php:66

References $ref_id.

◆ getSubitemsForExport()

ilExportOptions::getSubitemsForExport ( )

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

Returns
int[] ref ids

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

112 {
113 $refs = array();
114 foreach ((array) $this->ref_options[self::KEY_ITEM_MODE] as $ref_id => $mode) {
115 if ($mode != self::EXPORT_OMIT) {
116 $refs[] = (int) $ref_id;
117 }
118 }
119 return $refs;
120 }

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

+ 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.

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

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

+ Here is the caller graph for this function:

◆ read()

ilExportOptions::read ( )

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

245 : void
246 {
247 $this->options = array();
248 $this->obj_options = array();
249 $this->ref_options = array();
250
251 $query = "SELECT * FROM export_options " .
252 "WHERE export_id = " . $this->db->quote($this->getExportId(), ilDBConstants::T_INTEGER) . ' ' .
253 "ORDER BY pos";
254 $res = $this->db->query($query);
255 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
256 if ($row->ref_id) {
257 $this->ref_options[(int) $row->keyword][(int) $row->ref_id] = $row->value;
258 }
259 if ($row->obj_id) {
260 $this->obj_options[(int) $row->keyword][(int) $row->obj_id] = $row->value;
261 }
262 if (!$row->ref_id and !$row->obj_id) {
263 $this->options[(int) $row->keyword] = $row->value;
264 }
265 }
266 }

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

Referenced by __construct().

+ 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.

Referenced by getInstance().

◆ $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

◆ EXPORT_EXISTING

const ilExportOptions::EXPORT_EXISTING = 1

◆ EXPORT_OMIT

◆ 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


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