Description of ilDidacticTemplateImport. More...

Collaboration diagram for ilDidacticTemplateImport:

Public Member Functions
	__construct (int $a_type)

	setInputFile (string $a_file)

	getInputFile ()

	getInputType ()

	import (int $a_dtpl_id=0)
	Do import. More...

	validateImportFile ()

Data Fields
const	IMPORT_FILE = 1

Protected Member Functions
	parseSettings (SimpleXMLElement $root)
	Parse settings. More...

	canUseIcons (ilDidacticTemplateSetting $setting)

	parseLocalRoleAction (ilDidacticTemplateSetting $didactic_template_setting, SimpleXMLElement $local_role_action)

	parseBlockRoleAction (ilDidacticTemplateSetting $didactic_template_setting, SimpleXMLElement $block_role_action)

	parseLocalPolicyAction (ilDidacticTemplateSetting $didactic_template_setting, SimpleXMLElement $local_policy_action)

	parseActions (ilDidacticTemplateSetting $set, SimpleXMLElement $actions=null)
	Parse template action from xml. More...

	parseXmlErrors ()
	Parse xml errors from libxml_get_errors. More...

Protected Attributes
const	XML_ELEMENT_NAME_LOCAL_ROLE_ACTION = 'localRoleAction'

const	XML_ELEMENT_NAME_BLOCK_ROLE_ACIONE = 'blockRoleAction'

const	XML_ELEMENT_NAME_LOCAL_POLICY_ACTION = 'localPolicyAction'

const	SCHEMA_TYPE = 'otpl'

int	$type = 0

string	$xmlfile = ''

ilLogger	$logger

ilObjectDefinition	$objDefinition

ilSetting	$settings

Detailed Description

Description of ilDidacticTemplateImport.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateImport::__construct ( int $a_type )

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

References $DIC, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

     {
         global $DIC;
         $this->logger = $DIC->logger()->otpl();
         $this->type = $a_type;
         $this->objDefinition = $DIC['objDefinition'];
         $this->settings = $DIC->settings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ canUseIcons()

ilDidacticTemplateImport::canUseIcons ( ilDidacticTemplateSetting $setting )

protected

Definition at line 169 of file class.ilDidacticTemplateImport.php.

References ilDidacticTemplateSetting\getAssignments().

Referenced by parseSettings().

                                                                       : bool
     {
         foreach ($setting->getAssignments() as $assignment) {
             if (!$this->objDefinition->isContainer($assignment)) {
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInputFile()

ilDidacticTemplateImport::getInputFile ( )

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

References $xmlfile.

Referenced by import(), and validateImportFile().

                                   : string
     {
         return $this->xmlfile;
     }

Here is the caller graph for this function:

◆ getInputType()

ilDidacticTemplateImport::getInputType ( )

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

References $type.

Referenced by import(), and validateImportFile().

                                   : int
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ import()

ilDidacticTemplateImport::import ( int $a_dtpl_id = 0 )

Do import.

Definition at line 72 of file class.ilDidacticTemplateImport.php.

References $settings, getInputFile(), getInputType(), parseActions(), parseSettings(), and parseXmlErrors().

                                               : ilDidacticTemplateSetting
     {
         $root = null;
         $use_internal_errors = libxml_use_internal_errors(true);
         switch ($this->getInputType()) {
             case self::IMPORT_FILE:
                 $root = simplexml_load_string(file_get_contents($this->getInputFile()));
                 break;
         }
         libxml_use_internal_errors($use_internal_errors);
         if (!$root instanceof SimpleXMLElement) {
             throw new ilDidacticTemplateImportException(
                 $this->parseXmlErrors()
             );
         }
         $settings = $this->parseSettings($root);
         $this->parseActions($settings, $root->didacticTemplate->actions);
         return $settings;
     }

Here is the call graph for this function:

◆ parseActions()

ilDidacticTemplateImport::parseActions	(	ilDidacticTemplateSetting	$set,
		SimpleXMLElement	$actions = `null`
	)

protected

Parse template action from xml.

Definition at line 310 of file class.ilDidacticTemplateImport.php.

References parseBlockRoleAction(), parseLocalPolicyAction(), and parseLocalRoleAction().

Referenced by import().

                                                                                                      : void
     {
         if ($actions === null) {
             return;
         }
         foreach ($actions->children() as $action) {
             if ($action->getName() === self::XML_ELEMENT_NAME_LOCAL_ROLE_ACTION) {
                 $this->parseLocalRoleAction($set, $action);
                 continue;
             }
             if ($action->getName() === self::XML_ELEMENT_NAME_BLOCK_ROLE_ACIONE) {
                 $this->parseBlockRoleAction($set, $action);
                 continue;
             }
             if ($action->getName() === self::XML_ELEMENT_NAME_LOCAL_POLICY_ACTION) {
                 $this->parseLocalPolicyAction($set, $action);
                 continue;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseBlockRoleAction()

ilDidacticTemplateImport::parseBlockRoleAction	(	ilDidacticTemplateSetting	$didactic_template_setting,
		SimpleXMLElement	$block_role_action
	)

protected

Definition at line 198 of file class.ilDidacticTemplateImport.php.

References ilDidacticTemplateAction\FILTER_PARENT_ROLES, ilDidacticTemplateAction\FILTER_SOURCE_OBJ_ID, ilDidacticTemplateAction\FILTER_SOURCE_TITLE, ilDidacticTemplateSetting\getId(), and ilDidacticTemplateFilterPattern\PATTERN_SUBTYPE_REGEX.

Referenced by parseActions().

      : void {
         $act = new ilDidacticTemplateBlockRoleAction();
         $act->setTemplateId($didactic_template_setting->getId());
         // Role filter
         foreach ($block_role_action->roleFilter as $rfi) {
             switch ((string) $rfi->attributes()->source) {
                 case 'title':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_TITLE);
                     break;
 
                 case 'objId':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_OBJ_ID);
                     break;
                 case 'parentRoles':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_PARENT_ROLES);
                     break;
             }
             foreach ($rfi->includePattern as $pat) {
                 // @TODO other subtypes
                 $pattern = new ilDidacticTemplateIncludeFilterPattern();
                 $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                 $pattern->setPattern((string) $pat->attributes()->preg);
                 $act->addFilterPattern($pattern);
             }
             foreach ($rfi->excludePattern as $pat) {
                 // @TODO other subtypes
                 $pattern = new ilDidacticTemplateExcludeFilterPattern();
                 $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                 $pattern->setPattern((string) $pat->attributes()->preg);
                 $act->addFilterPattern($pattern);
             }
         }
         $act->save();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseLocalPolicyAction()

ilDidacticTemplateImport::parseLocalPolicyAction	(	ilDidacticTemplateSetting	$didactic_template_setting,
		SimpleXMLElement	$local_policy_action
	)

protected

Definition at line 236 of file class.ilDidacticTemplateImport.php.

References Vendor\Package\$e, ilLogLevel\DEBUG, ilDidacticTemplateSetting\delete(), ilDidacticTemplateAction\FILTER_LOCAL_ROLES, ilDidacticTemplateAction\FILTER_PARENT_ROLES, ilDidacticTemplateAction\FILTER_SOURCE_OBJ_ID, ilDidacticTemplateAction\FILTER_SOURCE_TITLE, ilDidacticTemplateSetting\getId(), ILIAS\Repository\logger(), ilDidacticTemplateFilterPattern\PATTERN_SUBTYPE_REGEX, ROLE_FOLDER_ID, ilDidacticTemplateLocalPolicyAction\TPL_ACTION_INTERSECT, ilDidacticTemplateLocalPolicyAction\TPL_ACTION_OVERWRITE, and ilDidacticTemplateLocalPolicyAction\TPL_ACTION_UNION.

Referenced by parseActions().

      : void {
         $act = new ilDidacticTemplateLocalPolicyAction();
         $act->setTemplateId($didactic_template_setting->getId());
         // Role filter
         foreach ($local_policy_action->roleFilter as $rfi) {
             $this->logger->dump($rfi->attributes(), \ilLogLevel::DEBUG);
             $this->logger->debug(
                 'Current filter source: ' . $rfi->attributes()->source
             );
             switch ((string) $rfi->attributes()->source) {
                 case 'title':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_TITLE);
                     break;
                 case 'objId':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_OBJ_ID);
                     break;
                 case 'parentRoles':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_PARENT_ROLES);
                     break;
                 case 'localRoles':
                     $act->setFilterType(\ilDidacticTemplateAction::FILTER_LOCAL_ROLES);
                     break;
             }
             foreach ($rfi->includePattern as $pat) {
                 // @TODO other subtypes
                 $pattern = new ilDidacticTemplateIncludeFilterPattern();
                 $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                 $pattern->setPattern((string) $pat->attributes()->preg);
                 $act->addFilterPattern($pattern);
             }
             foreach ($rfi->excludePattern as $pat) {
                 // @TODO other subtypes
                 $pattern = new ilDidacticTemplateExcludeFilterPattern();
                 $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                 $pattern->setPattern((string) $pat->attributes()->preg);
                 $act->addFilterPattern($pattern);
             }
         }
         // role template assignment
         foreach ($local_policy_action->localPolicyTemplate as $lpo) {
             switch ((string) $lpo->attributes()->type) {
                 case 'overwrite':
                     $act->setRoleTemplateType(ilDidacticTemplateLocalPolicyAction::TPL_ACTION_OVERWRITE);
                     break;
                 case 'union':
                     $act->setRoleTemplateType(ilDidacticTemplateLocalPolicyAction::TPL_ACTION_UNION);
                     break;
                 case 'intersect':
                     $act->setRoleTemplateType(ilDidacticTemplateLocalPolicyAction::TPL_ACTION_INTERSECT);
                     break;
             }
             // extract role
             foreach ($lpo->role as $roleDef) {
                 try {
                     $rimporter = new ilRoleXmlImporter(ROLE_FOLDER_ID);
                     $role_id = $rimporter->importSimpleXml($roleDef);
                     $act->setRoleTemplateId($role_id);
                 } catch (ilRoleImporterException $e) {
                     // delete half-imported template
                     $didactic_template_setting->delete();
                     throw new ilDidacticTemplateImportException($e->getMessage());
                 }
             }
         }
         // Save action including all filter patterns
         $act->save();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseLocalRoleAction()

ilDidacticTemplateImport::parseLocalRoleAction	(	ilDidacticTemplateSetting	$didactic_template_setting,
		SimpleXMLElement	$local_role_action
	)

protected

Definition at line 180 of file class.ilDidacticTemplateImport.php.

References ilDidacticTemplateSetting\getId(), and ROLE_FOLDER_ID.

Referenced by parseActions().

      : void {
         $act = new ilDidacticTemplateLocalRoleAction();
         $act->setTemplateId($didactic_template_setting->getId());
 
         foreach ($local_role_action->roleTemplate as $tpl) {
             // extract role
             foreach ($tpl->role as $roleDef) {
                 $rimporter = new ilRoleXmlImporter(ROLE_FOLDER_ID);
                 $role_id = $rimporter->importSimpleXml($roleDef);
                 $act->setRoleTemplateId($role_id);
             }
             $act->save();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseSettings()

ilDidacticTemplateImport::parseSettings ( SimpleXMLElement $root )

protected

Parse settings.

Definition at line 113 of file class.ilDidacticTemplateImport.php.

References canUseIcons(), ilMultilingualism\getInstance(), ILIAS\Repository\int(), and ilDidacticTemplateSetting\TYPE_CREATION.

Referenced by import().

                                                             : ilDidacticTemplateSetting
     {
         $icon = '';
         $setting = new ilDidacticTemplateSetting();
         foreach ($root->didacticTemplate as $tpl) {
             switch ((string) $tpl->attributes()->type) {
                 case 'creation':
                 default:
                     $setting->setType(ilDidacticTemplateSetting::TYPE_CREATION);
                     break;
             }
             $setting->setTitle(trim((string) $tpl->title));
             $setting->setDescription(trim((string) $tpl->description));
 
             $icon = (string) $tpl->icon;
 
             $info = '';
             foreach ((array) $tpl->info->p as $paragraph) {
                 if ($info !== '') {
                     $info .= "\n";
                 }
                 $info .= trim((string) $paragraph);
             }
             $setting->setInfo($info);
 
             if (isset($tpl->effectiveFrom) && (string) $tpl->effectiveFrom["nic_id"] == $this->settings->get('inst_id')) {
                 $node = array();
                 foreach ($tpl->effectiveFrom->node as $element) {
                     $node[] = (int) $element;
                 }
 
                 $setting->setEffectiveFrom($node);
             }
 
             if (isset($tpl->exclusive)) {
                 $setting->setExclusive(true);
             }
 
             foreach ($tpl->assignments->assignment as $element) {
                 $setting->addAssignment(trim((string) $element));
             }
         }
         $setting->save();
 
         if ($icon !== '' && $this->canUseIcons($setting)) {
             $setting->getIconHandler()->writeSvg($icon);
         }
         $trans = ilMultilingualism::getInstance($setting->getId(), "dtpl");
         if (isset($root->didacticTemplate->translations)) {
             $trans->fromXML($root->didacticTemplate->translations);
         }
         $trans->save();
 
         return $setting;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseXmlErrors()

ilDidacticTemplateImport::parseXmlErrors ( )

protected

Parse xml errors from libxml_get_errors.

Definition at line 334 of file class.ilDidacticTemplateImport.php.

Referenced by import().

                                        : string
     {
         $errors = '';
         foreach (libxml_get_errors() as $err) {
             $errors .= $err->code . '<br/>';
         }
         return $errors;
     }

Here is the caller graph for this function:

◆ setInputFile()

ilDidacticTemplateImport::setInputFile ( string $a_file )

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

Referenced by ilDidacticTemplateSettingsGUI\checkInput().

                                                 : void
     {
         $this->xmlfile = $a_file;
     }

Here is the caller graph for this function:

◆ validateImportFile()

ilDidacticTemplateImport::validateImportFile ( )

Definition at line 92 of file class.ilDidacticTemplateImport.php.

References ILIAS\Export\ImportStatus\FAILED, getInputFile(), and getInputType().

Referenced by ilDidacticTemplateSettingsGUI\checkInput().

                                         : ilImportStatusCollectionInterface
     {
         $status = new ilImportStatusFactory();
         if ($this->getInputType() !== self::IMPORT_FILE) {
             return $status->collection()->withAddedStatus($status->handler()
                 ->withType(ImportStatus\StatusType::FAILED)
                 ->withContent($status->content()->builder()->string()
                     ->withString("Invalid import status, import status 'IMPORT_FILE' expected.")));
         }
         $schema = new ilXMLSchemaFactory();
         $import = new ilImportHandlerFactory();
         $xml_spl_info = new SplFileInfo($this->getInputFile());
         $xsd_spl_info = $schema->getLatest(self::SCHEMA_TYPE);
         $xml_file_handler = $import->file()->xml()->withFileInfo($xml_spl_info);
         $xsd_file_handler = $import->file()->xsd()->withFileInfo($xsd_spl_info);
         return $import->file()->validation()->handler()->validateXMLFile($xml_file_handler, $xsd_file_handler);
     }