Style Data set class. More...

Inheritance diagram for ilStyleDataSet:

Collaboration diagram for ilStyleDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace (string $a_entity, string $a_schema_version)
	Get xml namespace. More...

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record. More...

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data. More...

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Import record. More...

Public Member Functions inherited from ilDataSet
	__construct ()

	init (string $a_entity, string $a_schema_version)
	Init. More...

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	setExportDirectories (string $a_relative, string $a_absolute)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...

	addRecordsXml (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...

	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getTypes (string $a_entity, string $a_version)
	Get field types for entity. More...

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Determine the dependent sets of data. More...

Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...

	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...

	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
ilObjStyleSheet	$current_obj = null

Content InternalRepoService	$repo

	$log

	$rbacsystem

	$user

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$relative_export_dir = ""

string	$absolute_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

int	$dircnt = 0

Detailed Description

Style Data set class.

This class implements the following entities:

sty: table object_data
sty_setting: table style_setting
sty_char: table style classes
sty_char_title: table style class titles
sty_parameter: table style_parameter
sty_color: table style colors
sty_template: table style_template
sty_template_class: table style_template_class
sty_media_query: table sty_media_query
sty_usage: table style_usage
object_style: this is a special entity which allows to export using the ID of the consuming object (e.g. wiki) the "sty" entity will be detemined and exported afterwards (if a non global style has been assigned)

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilStyleDataSet::__construct ( )

Definition at line 61 of file class.ilStyleDataSet.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilLoggerFactory\getLogger(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         parent::__construct();
         $this->log = ilLoggerFactory::getLogger('styl');
         $this->log->debug("constructed");
         $this->rbacsystem = $DIC->rbac()->system();
         $this->user = $DIC->user();
         $this->repo = $DIC->contentStyle()->internal()->repo();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilStyleDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Determine the dependent sets of data.

Definition at line 403 of file class.ilStyleDataSet.php.

References ilObject\_lookupType(), and ilObjStyleSheet\lookupObjectStyle().

      : array {
         $this->ds_log->debug("entity: " . $a_entity . ", rec: " . print_r($a_rec, true));
         switch ($a_entity) {
             case "object_style":
                 $this->ds_log->debug("object id: " . ($a_rec["ObjectId"] ?? null));
                 $style_id = ilObjStyleSheet::lookupObjectStyle($a_rec["ObjectId"] ?? 0);
                 $this->ds_log->debug("style id: " . $style_id);
                 //if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id))
                 if ($style_id > 0 && ilObject::_lookupType($style_id) == "sty") {                       // #0019337 always export style, if valid
                     return array(
                         "sty" => array("ids" => $style_id));
                 }
                 return array();
                 break;
 
             case "sty":
                 return array(
                     "sty_setting" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_media_query" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_char" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_char_title" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_color" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_parameter" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_template" => array("ids" => $a_rec["Id"] ?? null),
                     "sty_usage" => array("ids" => $a_rec["Id"] ?? null)
                 );
 
             case "sty_template":
                 return array(
                     "sty_template_class" => array("ids" => $a_rec["Id"] ?? null)
                 );
         }
 
         return [];
     }

Here is the call graph for this function:

◆ getSupportedVersions()

ilStyleDataSet::getSupportedVersions ( )

Get supported versions.

Returns: array version

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

                                           : array
     {
         return array("5.1.0", "8.0");
     }

◆ getTypes()

ilStyleDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

Get field types for entity.

Parameters

string	$a_entity	entity
string	$a_version	version number

Returns: array types array

Definition at line 100 of file class.ilStyleDataSet.php.

                                                                     : array
     {
         if ($a_entity == "sty") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "ImagesDir" => "directory"
                     );
             }
         }
 
         if ($a_entity == "object_style") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "ObjectId" => "integer"
                     );
             }
         }
 
         if ($a_entity == "sty_setting") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "StyleId" => "integer",
                         "Name" => "test",
                         "Value" => "text"
                     );
             }
         }
 
         if ($a_entity == "sty_char") {
             switch ($a_version) {
                 case "5.1.0":
                     return array(
                         "StyleId" => "integer",
                         "Type" => "text",
                         "Characteristic" => "text",
                         "Hide" => "integer"
                     );
                 case "8.0":
                     return array(
                         "StyleId" => "integer",
                         "Type" => "text",
                         "Characteristic" => "text",
                         "Hide" => "integer",
                         "OrderNr" => "integer",
                         "Outdate" => "integer"
                     );
             }
         }
 
         if ($a_entity == "sty_char_title") {
             switch ($a_version) {
                 case "8.0":
                     return array(
                         "StyleId" => "integer",
                         "Type" => "text",
                         "Characteristic" => "text",
                         "Lang" => "text",
                         "Title" => "text"
                     );
             }
         }
 
         if ($a_entity == "sty_parameter") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "StyleId" => "integer",
                         "Tag" => "text",
                         "Class" => "text",
                         "Parameter" => "text",
                         "Value" => "text",
                         "Type" => "text",
                         "MqId" => "integer",
                         "Custom" => "integer"
                     );
             }
         }
 
         if ($a_entity == "sty_color") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "StyleId" => "integer",
                         "ColorName" => "text",
                         "ColorCode" => "text"
                     );
             }
         }
 
         if ($a_entity == "sty_media_query") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "Id" => "integer",
                         "StyleId" => "integer",
                         "OrderNr" => "integer",
                         "MQuery" => "text"
                     );
             }
         }
 
         if ($a_entity == "sty_template") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "Id" => "integer",
                         "StyleId" => "integer",
                         "Name" => "text",
                         "Preview" => "text",
                         "TempType" => "text"
                     );
             }
         }
 
         if ($a_entity == "sty_template_class") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "TemplateId" => "integer",
                         "ClassType" => "text",
                         "Class" => "text"
                     );
             }
         }
 
         if ($a_entity == "sty_usage") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     return array(
                         "ObjId" => "integer",
                         "StyleId" => "integer"
                     );
             }
         }
     }

◆ getXmlNamespace()

ilStyleDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

Get xml namespace.

Parameters

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

                                                                                : string
     {
         return "http://www.ilias.de/xml/Services/Style/" . $a_entity;
     }

◆ getXmlRecord()

ilStyleDataSet::getXmlRecord	(	string	$a_entity,
		string	$a_version,
		array	$a_set
	)

Get xml record.

Parameters

Definition at line 256 of file class.ilStyleDataSet.php.

References ilObjStyleSheet\_getImagesDirectory().

                                                                                    : array
     {
         if ($a_entity == "sty") {
             $dir = ilObjStyleSheet::_getImagesDirectory($a_set["Id"]);
             $a_set["ImagesDir"] = $dir;
         }
 
         return $a_set;
     }

Here is the call graph for this function:

◆ importRecord()

ilStyleDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Import record.

Parameters

Definition at line 450 of file class.ilStyleDataSet.php.

References $DIC, $service, ilObjStyleSheet\_getImagesDirectory(), ilImportMapping\addMapping(), ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ILIAS\Repository\int(), ilFileUtils\rCopy(), ilDataSet\stripTags(), ILIAS\Repository\user(), ilObjStyleSheet\writeOwner(), and ilObjStyleSheet\writeStyleUsage().

                                                                                                                                       : void
     {
         global $DIC;
         $service = $DIC->contentStyle()->internal();
         $access_manager = $service->domain()->access(
             0,
             $this->user->getId()
         );
         $access_manager->enableWrite(true);
 
         $style_id = (isset($this->current_obj))
             ? $this->current_obj->getId()
             : 0;
         $characteristic_manager = $service->domain()->characteristic(
             $style_id,
             $access_manager
         );
 
         $color_manager = $service->domain()->color(
             $style_id,
             $access_manager
         );
 
         $a_rec = $this->stripTags($a_rec);
         switch ($a_entity) {
             case "sty":
                 $this->log->debug("Entity: " . $a_entity);
                 if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                     $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                 } else {
                     $newObj = new ilObjStyleSheet();
                     $newObj->create(0, true);
                 }
 
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->update(true);
 
                 $this->current_obj = $newObj;
                 $a_mapping->addMapping("Services/Style", "sty", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
                 $this->log->debug("Added mapping Services/Style sty  " . $a_rec["Id"] . " > " . $newObj->getId());
 
                 $dir = str_replace("..", "", $a_rec["ImagesDir"]);
                 if ($dir != "" && $this->getImportDirectory() != "") {
                     $source_dir = $this->getImportDirectory() . "/" . $dir;
                     $target_dir = $dir = ilObjStyleSheet::_getImagesDirectory($newObj->getId());
                     ilFileUtils::rCopy($source_dir, $target_dir);
                 }
                 break;
 
             case "sty_setting":
                 $this->current_obj->writeStyleSetting($a_rec["Name"], $a_rec["Value"]);
                 break;
 
             case "sty_char":
                 $this->current_obj->addCharacteristic($a_rec["Type"], $a_rec["Characteristic"], $a_rec["Hide"], (int) ($a_rec["OrderNr"] ?? 0), (bool) ($a_rec["Outdated"] ?? false));
                 break;
 
             case "sty_char_title":
                 $char_repo = $this->repo->characteristic();
                 $char_repo->addTitle(
                     $this->current_obj->getId(),
                     $a_rec["Type"],
                     $a_rec["Characteristic"],
                     $a_rec["Lang"],
                     $a_rec["Title"],
                 );
                 break;
 
             case "sty_parameter":
                 $mq_id = (int) $a_mapping->getMapping("Services/Style", "media_query", $a_rec["MqId"]);
                 $characteristic_manager->replaceParameter($a_rec["Tag"], $a_rec["Class"], $a_rec["Parameter"], $a_rec["Value"], $a_rec["Type"], $mq_id, $a_rec["Custom"]);
                 break;
 
             case "sty_color":
                 $color_manager->addColor($a_rec["ColorName"], $a_rec["ColorCode"]);
                 break;
 
             case "sty_media_query":
                 $mq_id = $this->current_obj->addMediaQuery($a_rec["MQuery"], $a_rec["OrderNr"]);
                 $a_mapping->addMapping("Services/Style", "media_query", $a_rec["Id"], $mq_id);
                 break;
 
             case "sty_template":
                 $tid = $this->current_obj->addTemplate($a_rec["TempType"], $a_rec["Name"], array());
                 $a_mapping->addMapping("Services/Style", "template", $a_rec["Id"], $tid);
                 break;
 
             case "sty_template_class":
                 $tid = (int) $a_mapping->getMapping("Services/Style", "template", $a_rec["TemplateId"]);
                 $this->current_obj->addTemplateClass($tid, $a_rec["ClassType"], $a_rec["Class"]);
                 break;
 
             case "sty_usage":
                 $obj_id = (int) $a_mapping->getMapping("Services/Object", "obj", $a_rec["ObjId"]);
                 $style_id = (int) $a_mapping->getMapping("Services/Style", "sty", $a_rec["StyleId"]);
                 if ($obj_id > 0 && $style_id > 0) {
                     ilObjStyleSheet::writeStyleUsage($obj_id, $style_id);
                     ilObjStyleSheet::writeOwner($obj_id, $style_id);
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

ilStyleDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

Read data.

Parameters

Definition at line 271 of file class.ilStyleDataSet.php.

References ilDataSet\$db, $id, $ilDB, and ilDataSet\getDirectDataFromQuery().

                                                                                : void
     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         if ($a_entity == "object_style") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     foreach ($a_ids as $id) {
                         $this->data[] = array("ObjectId" => $id);
                     }
                     break;
             }
         }
 
         if ($a_entity == "sty") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT o.title, o.description, o.obj_id id" .
                         " FROM object_data o " .
                         " WHERE " . $ilDB->in("o.obj_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_setting") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT style_id, name, value" .
                         " FROM style_setting " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_char") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT style_id, type, characteristic, hide, order_nr, outdated" .
                         " FROM style_char " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_char_title") {
             switch ($a_version) {
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT style_id, type, characteristic, lang, title" .
                         " FROM style_char_title " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_parameter") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT style_id, tag, class, parameter, value, type, mq_id, custom" .
                         " FROM style_parameter " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_color") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT style_id, color_name, color_code" .
                         " FROM style_color " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_media_query") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT id, style_id, order_nr, mquery m_query" .
                         " FROM sty_media_query " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_template") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT id, style_id, name, preview, temp_type" .
                         " FROM style_template " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_template_class") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT template_id, class_type, class" .
                         " FROM style_template_class " .
                         " WHERE " . $ilDB->in("template_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "sty_usage") {
             switch ($a_version) {
                 case "5.1.0":
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT obj_id, style_id" .
                         " FROM style_usage " .
                         " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                     break;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_obj

ilObjStyleSheet ilStyleDataSet::$current_obj = null

protected

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

◆ $log

ilStyleDataSet::$log

protected

Definition at line 49 of file class.ilStyleDataSet.php.

◆ $rbacsystem

ilStyleDataSet::$rbacsystem

protected

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

◆ $repo

Content InternalRepoService ilStyleDataSet::$repo

protected

Definition at line 45 of file class.ilStyleDataSet.php.

◆ $user

ilStyleDataSet::$user

protected

Definition at line 59 of file class.ilStyleDataSet.php.

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

Services/Style/classes/class.ilStyleDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()

Field Documentation

◆ $current_obj

◆ $log

◆ $rbacsystem

◆ $repo

◆ $user