class.ilDidacticTemplateAction.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilDidacticTemplateAction
{
        const TYPE_LOCAL_POLICY = 1;
        const TYPE_LOCAL_ROLE = 2;
        const TYPE_BLOCK_ROLE = 3;

        const FILTER_SOURCE_TITLE = 1;
        const FILTER_SOURCE_OBJ_ID = 2;
        const FILTER_PARENT_ROLES = 3;

        const PATTERN_PARENT_TYPE = 'action';
        
        private $logger = null;

        private $action_id = 0;
        private $tpl_id = 0;
        private $type = 0;


        private $ref_id = 0;


        public function __construct($action_id = 0)
        {
                $this->logger = $GLOBALS['DIC']->logger()->otpl();
                
                $this->setActionId($action_id);
                $this->read();
        }
        
        public function getLogger()
        {
                return $this->logger;
        }

        public function getActionId()
        {
                return $this->action_id;
        }

        public function setActionId($a_action_id)
        {
                $this->action_id = $a_action_id;
        }

        public function setType($a_type_id)
        {
                $this->type = $a_type_id;
        }

        public function setTemplateId($a_id)
        {
                $this->tpl_id = $a_id;
        }

        public function getTemplateId()
        {
                return $this->tpl_id;
        }

        public function setRefId($a_ref_id)
        {
                $this->ref_id = $a_ref_id;
        }

        public function getRefId()
        {
                return $this->ref_id;
        }

        public function save()
        {
                global $ilDB;

                if($this->getActionId())
                {
                        return false;
                }

                $this->setActionId($ilDB->nextId('didactic_tpl_a'));
                $query = 'INSERT INTO didactic_tpl_a (id, tpl_id, type_id) '.
                        'VALUES( '.
                        $ilDB->quote($this->getActionId(),'integer').', '.
                        $ilDB->quote($this->getTemplateId(),'integer').', '.
                        $ilDB->quote($this->getType(),'integer').
                        ')';
                $ilDB->manipulate($query);
                return $this->getActionId();
        }

        public function delete()
        {
                global $ilDB;

                $query = 'DELETE FROM didactic_tpl_a '.
                        'WHERE id = '.$ilDB->quote($this->getActionId(),'integer');
                $ilDB->manipulate($query);
        }

        public function read()
        {
                global $ilDB;

                $query = 'SELECT * FROM didactic_tpl_a '.
                        'WHERE id = '.$ilDB->quote($this->getActionId(), 'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $this->setTemplateId($row->tpl_id);
                }
                return true;
        }

        abstract public function getType();

        abstract public function apply();

        abstract public function revert();


        public function __clone()
        {
                $this->setActionId(0);
        }


        abstract function toXml(ilXmlWriter $writer);


        protected function initSourceObject()
        {
                include_once './Services/Object/classes/class.ilObjectFactory.php';
                $s = ilObjectFactory::getInstanceByRefId($this->getRefId(),false);
                return $s;
        }

        protected function filterRoles(ilObject $source)
        {
                global $rbacreview;

                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateFilterPatternFactory.php';
                $patterns = ilDidacticTemplateFilterPatternFactory::lookupPatternsByParentId(
                        $this->getActionId(),
                        self::PATTERN_PARENT_TYPE
                );

                $filtered = array();
                foreach($rbacreview->getParentRoleIds($source->getRefId()) as $role_id => $role)
                {
                        switch($this->getFilterType())
                        {
                                case self::FILTER_PARENT_ROLES:
                                        
                                        ilLoggerFactory::getLogger('dtpl')->dump($role);
                                        if(
                                                ($role['parent'] == $source->getRefId()) &&
                                                ($role['assign'] == 'y')
                                        )
                                        {
                                                ilLoggerFactory::getLogger('dtpl')->debug('Excluding local role: ' . $role['title']);
                                                break;
                                        }
                                        foreach($patterns as $pattern)
                                        {
                                                if($pattern->valid(ilObject::_lookupTitle($role_id)))
                                                {
                                                        ilLoggerFactory::getLogger('otpl')->debug('Role is valid: '. ilObject::_lookupTitle($role_id));
                                                        $filtered[$role_id] = $role;
                                                }
                                        }
                                        break;
                                
                                default:
                                case self::FILTER_SOURCE_TITLE:
                                        foreach($patterns as $pattern)
                                        {
                                                if($pattern->valid(ilObject::_lookupTitle($role_id)))
                                                {
                                                        ilLoggerFactory::getLogger('otpl')->debug('Role is valid: '. ilObject::_lookupTitle($role_id));
                                                        $filtered[$role_id] = $role;
                                                }
                                        }
                                        break;
                        }
                        
                        
                }
                return $filtered;
        }
}
?>