ilDidacticTemplateImport Class Reference

Description of ilDidacticTemplateImport. More...

Collaboration diagram for ilDidacticTemplateImport:

Public Member Functions
	__construct ($a_type)
	Constructor. More...
	setInputFile ($a_file)
	Set input file. More...
	getInputFile ()
	Get inputfile. More...
	getInputType ()
	Get input type. More...
	import ($a_dtpl_id=0)
	Do import. More...

Data Fields
const	IMPORT_FILE = 1

Protected Member Functions
	parseSettings (SimpleXMLElement $root)
	Parse settings. More...
	parseActions (ilDidacticTemplateSetting $set, SimpleXMLElement $actions=NULL)
	Parse template action from xml. More...
	parseXmlErrors ()
	Parse xml errors from libxml_get_errors. More...

Private Attributes
	$type = 0
	$xmlfile = ''

Detailed Description

Description of ilDidacticTemplateImport.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateImport::__construct

(

$a_type

)

Constructor.

Parameters

<type>

$a_type

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

        {
                $this->type = $a_type;
        }

References $a_type.

Member Function Documentation

getInputFile()

ilDidacticTemplateImport::getInputFile

(

)

Get inputfile.

Returns

<type>

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

        {
                return $this->xmlfile;
        }

References $xmlfile.

Referenced by import().

Here is the caller graph for this function:

getInputType()

ilDidacticTemplateImport::getInputType

(

)

Get input type.

Returns

string

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

        {
                return $this->type;
        }

References $type.

Referenced by import().

Here is the caller graph for this function:

import()

ilDidacticTemplateImport::import

(

$a_dtpl_id = 0

)

Do import.

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

        {
                libxml_use_internal_errors(true);
 
                switch($this->getInputType())
                {
                        case self::IMPORT_FILE:
 
                                $root = simplexml_load_file($this->getInputFile());
                                if($root == FALSE)
                                {
                                        throw new ilDidacticTemplateImportException(
                                                $this->parseXmlErrors()
                                        );
                                }
                                break;
                }
 
                $settings = $this->parseSettings($root);
                $this->parseActions($settings,$root->didacticTemplate->actions);
 
                return $settings;
        }

References getInputFile(), getInputType(), IMPORT_FILE, parseActions(), parseSettings(), and parseXmlErrors().

Here is the call graph for this function:

parseActions()

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

protected

Parse template action from xml.

Parameters

ilDidacticTemplateSetting	$set
SimpleXMLElement	$root

Returns

void

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

        {
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateActionFactory.php';
 
                if($actions === NULL)
                {
                        return void;
                }
 
                // Local role action
                foreach($actions->localRoleAction as $ele)
                {
                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateLocalRoleAction.php';
                        $act = new ilDidacticTemplateLocalRoleAction();
                        $act->setTemplateId($set->getId());
 
                        foreach($ele->roleTemplate as $tpl)
                        {
                                // extract role
                                foreach($tpl->role as $roleDef)
                                {
                                        include_once './Services/AccessControl/classes/class.ilRoleXmlImporter.php';
                                        $rimporter = new ilRoleXmlImporter(ROLE_FOLDER_ID);
                                        $role_id = $rimporter->importSimpleXml($roleDef);
                                        $act->setRoleTemplateId($role_id);
                                }
                                $act->save();
                        }
                }
 
                // Block role action
                foreach($actions->blockRoleAction as $ele)
                {
                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateBlockRoleAction.php';
                        $act = new ilDidacticTemplateBlockRoleAction();
                        $act->setTemplateId($set->getId());
 
                        // Role filter
                        foreach($ele->roleFilter as $rfi)
                        {
                                $act->setFilterType((string) $rfi->attributes()->source);
                                foreach($rfi->includePattern as $pat)
                                {
                                        // @TODO other subtypes
                                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateIncludeFilterPattern.php';
                                        $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
                                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateExcludeFilterPattern.php';
                                        $pattern = new ilDidacticTemplateExcludeFilterPattern();
                                        $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                                        $pattern->setPattern((string) $pat->attributes()->preg);
                                        $act->addFilterPattern($pattern);
                                }
                        }
 
                        $act->save();
                }
 
 
 
                // Local policy action
                foreach($actions->localPolicyAction as $ele)
                {
                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateLocalPolicyAction.php';
                        $act = new ilDidacticTemplateLocalPolicyAction();
                        $act->setTemplateId($set->getId());
 
                        // Role filter
                        foreach($ele->roleFilter as $rfi)
                        {
                                $act->setFilterType((string) $rfi->attributes()->source);
                                foreach($rfi->includePattern as $pat)
                                {
                                        // @TODO other subtypes
                                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateIncludeFilterPattern.php';
                                        $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
                                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateExcludeFilterPattern.php';
                                        $pattern = new ilDidacticTemplateExcludeFilterPattern();
                                        $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                                        $pattern->setPattern((string) $pat->attributes()->preg);
                                        $act->addFilterPattern($pattern);
                                }
                        }
 
                        // role template assignment
                        foreach($ele->localPolicyTemplate as $lpo)
                        {
                                $act->setFilterType(ilDidacticTemplateLocalPolicyAction::FILTER_SOURCE_TITLE);
                                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)
                                {
                                        include_once './Services/AccessControl/classes/class.ilRoleXmlImporter.php';
                                        $rimporter = new ilRoleXmlImporter(ROLE_FOLDER_ID);
                                        $role_id = $rimporter->importSimpleXml($roleDef);
                                        $act->setRoleTemplateId($role_id);
                                }
                        }
 
                        // Save action including all filter patterns
                        $act->save();
                }
 
        }

References $tpl, ilDidacticTemplateAction\FILTER_SOURCE_TITLE, ilDidacticTemplateSetting\getId(), ilDidacticTemplateFilterPattern\PATTERN_SUBTYPE_REGEX, ilDidacticTemplateLocalPolicyAction\TPL_ACTION_INTERSECT, ilDidacticTemplateLocalPolicyAction\TPL_ACTION_OVERWRITE, and ilDidacticTemplateLocalPolicyAction\TPL_ACTION_UNION.

Referenced by import().

Here is the call graph for this function:

Here is the caller graph for this function:

parseSettings()

ilDidacticTemplateImport::parseSettings ( SimpleXMLElement  $root )

protected

Parse settings.

Parameters

SimpleXMLElement

$el

Returns

ilDidacticTemplateSetting

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

        {
                global $ilSetting;
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateSetting.php';
                $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));
 
                        $info = '';
                        foreach((array) $tpl->info->p as $paragraph)
                        {
                                if(strlen($info))
                                {
                                        $info .= "\n";
                                }
                                $info .= trim((string) $paragraph);
                        }
                        $setting->setInfo($info);
 
                        if(isset($tpl->effectiveFrom) && (string)$tpl->effectiveFrom["nic_id"] == $ilSetting->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();
 
                include_once("./Services/Multilingualism/classes/class.ilMultilingualism.php");
                $trans = ilMultilingualism::getInstance($setting->getId(), "dtpl");
 
                if(isset($root->didacticTemplate->translations))
                {
                        $trans->fromXML($root->didacticTemplate->translations);
                }
                $trans->save();
                
                return $setting;
        }

References $ilSetting, $info, $tpl, ilMultilingualism\getInstance(), and ilDidacticTemplateSetting\TYPE_CREATION.

Referenced by import().

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.

Returns

string

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

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

References $errors.

Referenced by import().

Here is the caller graph for this function:

setInputFile()

ilDidacticTemplateImport::setInputFile

(

$a_file

)

Set input file.

Parameters

string

$a_file

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

        {
                $this->xmlfile = $a_file;
        }

Field Documentation

$type

ilDidacticTemplateImport::$type = 0

private

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

Referenced by getInputType().

$xmlfile

ilDidacticTemplateImport::$xmlfile = ''

private

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

Referenced by getInputFile().

IMPORT_FILE

const ilDidacticTemplateImport::IMPORT_FILE = 1

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

Referenced by import(), and ilDidacticTemplateSettingsGUI\importTemplate().

---

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

• Services/DidacticTemplate/classes/class.ilDidacticTemplateImport.php