ILIAS  release_8 Revision v8.23
ilMDRequirement Class Reference
+ Inheritance diagram for ilMDRequirement:
+ Collaboration diagram for ilMDRequirement:

Public Member Functions

 setOrCompositeId (int $a_or_composite_id)
 
 getOrCompositeId ()
 
 setOperatingSystemName (string $a_val)
 
 getOperatingSystemName ()
 
 setOperatingSystemMinimumVersion (string $a_val)
 
 getOperatingSystemMinimumVersion ()
 
 setOperatingSystemMaximumVersion (string $a_val)
 
 getOperatingSystemMaximumVersion ()
 
 setBrowserName (string $a_val)
 
 getBrowserName ()
 
 setBrowserMinimumVersion (string $a_val)
 
 getBrowserMinimumVersion ()
 
 setBrowserMaximumVersion (string $a_val)
 
 getBrowserMaximumVersion ()
 
 save ()
 
 update ()
 
 delete ()
 
 __getFields ()
 
 read ()
 
 toXML (ilXmlWriter $writer)
 
- Public Member Functions inherited from ilMDBase
 __construct (int $a_rbac_id=0, int $a_obj_id=0, string $a_type='')
 constructor More...
 
 read ()
 
 setRBACId (int $a_id)
 
 getRBACId ()
 
 setObjId (int $a_id)
 
 getObjId ()
 
 setObjType (string $a_type)
 
 getObjType ()
 
 setMetaId (int $a_meta_id, bool $a_read_data=true)
 
 getMetaId ()
 
 setParentType (string $a_parent_type)
 
 getParentType ()
 
 setParentId (int $a_id)
 
 getParentId ()
 
 setExportMode (bool $a_export_mode=true)
 
 getExportMode ()
 
 validate ()
 
 update ()
 
 save ()
 
 delete ()
 
 toXML (ilXmlWriter $writer)
 

Static Public Member Functions

static _getIds (int $a_rbac_id, int $a_obj_id, int $a_parent_id, string $a_parent_type, int $a_or_composite_id=0)
 

Private Attributes

int $or_composite_id = 0
 
string $operating_system_name = ''
 
string $operating_system_minimum_version = ''
 
string $operating_system_maximum_version = ''
 
string $browser_name = ''
 
string $browser_minimum_version = ''
 
string $browser_maximum_version = ''
 

Additional Inherited Members

- Protected Attributes inherited from ilMDBase
ilLogger $log
 
ilDBInterface $db
 

Detailed Description

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

Member Function Documentation

◆ __getFields()

ilMDRequirement::__getFields ( )
Returns
array<string, array<string, mixed>>

Definition at line 166 of file class.ilMDRequirement.php.

References getBrowserMaximumVersion(), getBrowserMinimumVersion(), getBrowserName(), ilMDBase\getObjId(), ilMDBase\getObjType(), getOperatingSystemMaximumVersion(), getOperatingSystemMinimumVersion(), getOperatingSystemName(), getOrCompositeId(), ilMDBase\getParentId(), ilMDBase\getParentType(), and ilMDBase\getRBACId().

Referenced by save(), and update().

166  : array
167  {
168  return array(
169  'rbac_id' => array('integer', $this->getRBACId()),
170  'obj_id' => array('integer', $this->getObjId()),
171  'obj_type' => array('text', $this->getObjType()),
172  'parent_type' => array('text', $this->getParentType()),
173  'parent_id' => array('integer', $this->getParentId()),
174  'operating_system_name' => array('text', $this->getOperatingSystemName()),
175  'os_min_version' => array('text', $this->getOperatingSystemMinimumVersion()),
176  'os_max_version' => array('text', $this->getOperatingSystemMaximumVersion()),
177  'browser_name' => array('text', $this->getBrowserName()),
178  'browser_minimum_version' => array('text', $this->getBrowserMinimumVersion()),
179  'browser_maximum_version' => array('text', $this->getBrowserMaximumVersion()),
180  'or_composite_id' => array('integer', $this->getOrCompositeId())
181  );
182  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _getIds()

static ilMDRequirement::_getIds ( int  $a_rbac_id,
int  $a_obj_id,
int  $a_parent_id,
string  $a_parent_type,
int  $a_or_composite_id = 0 
)
static
Returns
int[]

Definition at line 242 of file class.ilMDRequirement.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilMDOrComposite\getRequirementIds(), and ilMDTechnical\getRequirementIds().

248  : array {
249  global $DIC;
250 
251  $ilDB = $DIC->database();
252 
253  $query = "SELECT meta_requirement_id FROM il_meta_requirement " .
254  "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
255  "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
256  "AND parent_id = " . $ilDB->quote($a_parent_id, 'integer') . " " .
257  "AND parent_type = " . $ilDB->quote($a_parent_type, 'text') . " " .
258  "AND or_composite_id = " . $ilDB->quote($a_or_composite_id, 'integer');
259 
260  $res = $ilDB->query($query);
261  $ids = [];
262  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
263  $ids[] = (int) $row->meta_requirement_id;
264  }
265  return $ids;
266  }
$res
Definition: ltiservices.php:69
global $DIC
Definition: feed.php:28
$query
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ delete()

ilMDRequirement::delete ( )

Definition at line 152 of file class.ilMDRequirement.php.

References $query, $res, and ilMDBase\getMetaId().

152  : bool
153  {
154  if ($this->getMetaId()) {
155  $query = "DELETE FROM il_meta_requirement " .
156  "WHERE meta_requirement_id = " . $this->db->quote($this->getMetaId(), 'integer');
157  $res = $this->db->manipulate($query);
158  return true;
159  }
160  return false;
161  }
$res
Definition: ltiservices.php:69
$query
+ Here is the call graph for this function:

◆ getBrowserMaximumVersion()

ilMDRequirement::getBrowserMaximumVersion ( )

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

References $browser_maximum_version.

Referenced by __getFields(), and toXML().

126  : string
127  {
129  }
+ Here is the caller graph for this function:

◆ getBrowserMinimumVersion()

ilMDRequirement::getBrowserMinimumVersion ( )

Definition at line 116 of file class.ilMDRequirement.php.

References $browser_minimum_version.

Referenced by __getFields(), and toXML().

116  : string
117  {
119  }
+ Here is the caller graph for this function:

◆ getBrowserName()

ilMDRequirement::getBrowserName ( )

Definition at line 106 of file class.ilMDRequirement.php.

References $browser_name.

Referenced by __getFields(), and toXML().

106  : string
107  {
108  return $this->browser_name;
109  }
+ Here is the caller graph for this function:

◆ getOperatingSystemMaximumVersion()

ilMDRequirement::getOperatingSystemMaximumVersion ( )

Definition at line 84 of file class.ilMDRequirement.php.

References $operating_system_maximum_version.

Referenced by __getFields(), and toXML().

84  : string
85  {
87  }
string $operating_system_maximum_version
+ Here is the caller graph for this function:

◆ getOperatingSystemMinimumVersion()

ilMDRequirement::getOperatingSystemMinimumVersion ( )

Definition at line 74 of file class.ilMDRequirement.php.

References $operating_system_minimum_version.

Referenced by __getFields(), and toXML().

74  : string
75  {
77  }
string $operating_system_minimum_version
+ Here is the caller graph for this function:

◆ getOperatingSystemName()

ilMDRequirement::getOperatingSystemName ( )

Definition at line 64 of file class.ilMDRequirement.php.

References $operating_system_name.

Referenced by __getFields(), and toXML().

64  : string
65  {
67  }
+ Here is the caller graph for this function:

◆ getOrCompositeId()

ilMDRequirement::getOrCompositeId ( )

Definition at line 42 of file class.ilMDRequirement.php.

References $or_composite_id.

Referenced by __getFields().

42  : int
43  {
45  }
+ Here is the caller graph for this function:

◆ read()

ilMDRequirement::read ( )

Definition at line 184 of file class.ilMDRequirement.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setBrowserMaximumVersion(), setBrowserMinimumVersion(), setBrowserName(), ilMDBase\setObjId(), ilMDBase\setObjType(), setOperatingSystemMaximumVersion(), setOperatingSystemMinimumVersion(), setOperatingSystemName(), setOrCompositeId(), ilMDBase\setParentId(), ilMDBase\setParentType(), and ilMDBase\setRBACId().

184  : bool
185  {
186  if ($this->getMetaId()) {
187  $query = "SELECT * FROM il_meta_requirement " .
188  "WHERE meta_requirement_id = " . $this->db->quote($this->getMetaId(), 'integer');
189 
190  $res = $this->db->query($query);
191  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
192  $this->setRBACId((int) $row->rbac_id);
193  $this->setObjId((int) $row->obj_id);
194  $this->setObjType($row->obj_type);
195  $this->setParentId((int) $row->parent_id);
196  $this->setParentType($row->parent_type);
197  $this->setOperatingSystemName($row->operating_system_name ?? '');
198  $this->setOperatingSystemMinimumVersion($row->os_min_version ?? '');
199  $this->setOperatingSystemMaximumVersion($row->os_max_version ?? '');
200  $this->setBrowserName($row->browser_name ?? '');
201  $this->setBrowserMinimumVersion($row->browser_minimum_version ?? '');
202  $this->setBrowserMaximumVersion($row->browser_maximum_version ?? '');
203  $this->setOrCompositeId((int) $row->or_composite_id);
204  }
205  }
206  return true;
207  }
$res
Definition: ltiservices.php:69
setOperatingSystemMaximumVersion(string $a_val)
setOrCompositeId(int $a_or_composite_id)
setRBACId(int $a_id)
setBrowserMinimumVersion(string $a_val)
setObjId(int $a_id)
setOperatingSystemMinimumVersion(string $a_val)
setBrowserName(string $a_val)
setBrowserMaximumVersion(string $a_val)
$query
setParentId(int $a_id)
setOperatingSystemName(string $a_val)
setParentType(string $a_parent_type)
setObjType(string $a_type)
+ Here is the call graph for this function:

◆ save()

ilMDRequirement::save ( )

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

References __getFields(), ilMDBase\getMetaId(), and ilMDBase\setMetaId().

131  : int
132  {
133  $fields = $this->__getFields();
134  $fields['meta_requirement_id'] = array('integer', $next_id = $this->db->nextId('il_meta_requirement'));
135 
136  if ($this->db->insert('il_meta_requirement', $fields)) {
137  $this->setMetaId($next_id);
138  return $this->getMetaId();
139  }
140  return 0;
141  }
setMetaId(int $a_meta_id, bool $a_read_data=true)
+ Here is the call graph for this function:

◆ setBrowserMaximumVersion()

ilMDRequirement::setBrowserMaximumVersion ( string  $a_val)

Definition at line 121 of file class.ilMDRequirement.php.

Referenced by read().

121  : void
122  {
123  $this->browser_maximum_version = $a_val;
124  }
+ Here is the caller graph for this function:

◆ setBrowserMinimumVersion()

ilMDRequirement::setBrowserMinimumVersion ( string  $a_val)

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

Referenced by read().

111  : void
112  {
113  $this->browser_minimum_version = $a_val;
114  }
+ Here is the caller graph for this function:

◆ setBrowserName()

ilMDRequirement::setBrowserName ( string  $a_val)

Definition at line 89 of file class.ilMDRequirement.php.

Referenced by read().

89  : bool
90  {
91  switch ($a_val) {
92  case 'Any':
93  case 'NetscapeCommunicator':
94  case 'MS-InternetExplorer':
95  case 'Opera':
96  case 'Amaya':
97  case 'Mozilla':
98  $this->browser_name = $a_val;
99  return true;
100 
101  default:
102  return false;
103  }
104  }
+ Here is the caller graph for this function:

◆ setOperatingSystemMaximumVersion()

ilMDRequirement::setOperatingSystemMaximumVersion ( string  $a_val)

Definition at line 79 of file class.ilMDRequirement.php.

Referenced by read().

79  : void
80  {
81  $this->operating_system_maximum_version = $a_val;
82  }
+ Here is the caller graph for this function:

◆ setOperatingSystemMinimumVersion()

ilMDRequirement::setOperatingSystemMinimumVersion ( string  $a_val)

Definition at line 69 of file class.ilMDRequirement.php.

Referenced by read().

69  : void
70  {
71  $this->operating_system_minimum_version = $a_val;
72  }
+ Here is the caller graph for this function:

◆ setOperatingSystemName()

ilMDRequirement::setOperatingSystemName ( string  $a_val)

Definition at line 47 of file class.ilMDRequirement.php.

Referenced by read().

47  : bool
48  {
49  switch ($a_val) {
50  case 'PC-DOS':
51  case 'MS-Windows':
52  case 'MacOS':
53  case 'Unix':
54  case 'Multi-OS':
55  case 'None':
56  $this->operating_system_name = $a_val;
57  return true;
58 
59  default:
60  return false;
61  }
62  }
+ Here is the caller graph for this function:

◆ setOrCompositeId()

ilMDRequirement::setOrCompositeId ( int  $a_or_composite_id)

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

Referenced by read().

37  : void
38  {
39  $this->or_composite_id = $a_or_composite_id;
40  }
+ Here is the caller graph for this function:

◆ toXML()

ilMDRequirement::toXML ( ilXmlWriter  $writer)

Definition at line 214 of file class.ilMDRequirement.php.

References getBrowserMaximumVersion(), getBrowserMinimumVersion(), getBrowserName(), getOperatingSystemMaximumVersion(), getOperatingSystemMinimumVersion(), getOperatingSystemName(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

214  : void
215  {
216  $writer->xmlStartTag('Requirement');
217  $writer->xmlStartTag('Type');
218 
219  if ($this->getOperatingSystemName() !== '') {
220  $writer->xmlElement('OperatingSystem', array(
221  'Name' => $this->getOperatingSystemName() ?: 'None',
222  'MinimumVersion' => $this->getOperatingSystemMinimumVersion(),
223  'MaximumVersion' => $this->getOperatingSystemMaximumVersion()
224  ));
225  }
226  if ($this->getBrowserName() !== '') {
227  $writer->xmlElement('Browser', array(
228  'Name' => $this->getBrowserName() ?: 'Any',
229  'MinimumVersion' => $this->getBrowserMinimumVersion(),
230  'MaximumVersion' => $this->getBrowserMaximumVersion()
231  ));
232  }
233  $writer->xmlEndTag('Type');
234  $writer->xmlEndTag('Requirement');
235  }
xmlEndTag(string $tag)
Writes an endtag.
xmlStartTag(string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
Writes a starttag.
xmlElement(string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
Writes a basic element (no children, just textual content)
+ Here is the call graph for this function:

◆ update()

ilMDRequirement::update ( )

Definition at line 143 of file class.ilMDRequirement.php.

References __getFields(), and ilMDBase\getMetaId().

143  : bool
144  {
145  return $this->getMetaId() && $this->db->update(
146  'il_meta_requirement',
147  $this->__getFields(),
148  array("meta_requirement_id" => array('integer', $this->getMetaId()))
149  );
150  }
+ Here is the call graph for this function:

Field Documentation

◆ $browser_maximum_version

string ilMDRequirement::$browser_maximum_version = ''
private

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

Referenced by getBrowserMaximumVersion().

◆ $browser_minimum_version

string ilMDRequirement::$browser_minimum_version = ''
private

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

Referenced by getBrowserMinimumVersion().

◆ $browser_name

string ilMDRequirement::$browser_name = ''
private

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

Referenced by getBrowserName().

◆ $operating_system_maximum_version

string ilMDRequirement::$operating_system_maximum_version = ''
private

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

Referenced by getOperatingSystemMaximumVersion().

◆ $operating_system_minimum_version

string ilMDRequirement::$operating_system_minimum_version = ''
private

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

Referenced by getOperatingSystemMinimumVersion().

◆ $operating_system_name

string ilMDRequirement::$operating_system_name = ''
private

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

Referenced by getOperatingSystemName().

◆ $or_composite_id

int ilMDRequirement::$or_composite_id = 0
private

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

Referenced by getOrCompositeId().


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