class.ilPageConfig.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilPageConfig
{
    protected $lng;

    protected $int_link_filter = array("File", "PortfolioPage", "PortfolioTemplatePage");
    protected $prevent_rte_usage = false;
    protected $use_attached_content = false;
    protected $pc_defs = array();
    protected $pc_enabled = array();
    protected $enabledinternallinks = false;
    protected $enable_keywords = false;
    protected $enable_anchors = false;
    protected $enablewikilinks = false;
    protected $page_toc = false;
    protected $activation = false;
    protected $scheduled_activation = false;
    protected $preventhtmlunmasking = false;
    protected $enabledselfassessment = false;
    protected $enabledselfassessment_scorm = false;
    protected $int_link_def_type = "";
    protected $int_link_def_id = 0;
    protected $multi_lang_support = false;
    protected $single_page_mode = false;        // currently only used by multi-lang support
    // single page means: only one page per parent_id
    protected $disable_default_qfeedback = false;
    protected $question_html = array();
    protected $use_stored_tries = false;
    protected $enable_user_links = false;

    protected $edit_lock_support = true;

    protected $use_page_container = true;

    protected $enable_permission_checks = false;

    protected $adve_set;

    protected $page_obj_key = "";
    
    final public function __construct()
    {
        global $DIC;

        $this->lng = $DIC->language();
        // load pc_defs
        include_once("./Services/COPage/classes/class.ilCOPagePCDef.php");
        $this->pc_defs = ilCOPagePCDef::getPCDefinitions();
        foreach ($this->pc_defs as $def) {
            $this->setEnablePCType($def["name"], (bool) $def["def_enabled"]);
        }

        $this->adve_set = new ilSetting("adve");

        $def = new ilCOPageObjDef();
        foreach ($def->getDefinitions() as $key => $def) {
            if (strtolower(get_class($this)) == strtolower($def["class_name"] . "Config")) {
                $this->page_obj_key = $key;
            }
        }


        $this->init();
    }
    
    public function init()
    {
    }
    
    
    public function setEnablePCType($a_pc_type, $a_val)
    {
        $this->pc_enabled[$a_pc_type] = $a_val;
    }
    
    public function getEnablePCType($a_pc_type)
    {
        return $this->pc_enabled[$a_pc_type];
    }

    public function getEnabledTopPCTypes() : array
    {
        $types = [];
        foreach ($this->pc_defs as $def) {
            if ($def["top_item"] && $this->getEnablePCType($def["name"])) {
                $types[] = $def;
            }
        }
        return $types;
    }

    public function setEnableKeywords($a_val)
    {
        $this->enable_keywords = $a_val;
    }
    
    public function getEnableKeywords()
    {
        return $this->enable_keywords;
    }

    public function setEnableAnchors($a_val)
    {
        $this->enable_anchors = $a_val;
    }
    
    public function getEnableAnchors()
    {
        return $this->enable_anchors;
    }

    public function setEnableInternalLinks($a_enabledinternallinks)
    {
        $this->enabledinternallinks = $a_enabledinternallinks;
    }

    public function getEnableInternalLinks()
    {
        return $this->enabledinternallinks;
    }

    public function getEnableUserLinks()
    {
        if (!$this->getEnableInternalLinks()) {
            return false;
        }
        if ($this->getIntLinkFilterWhiteList() && in_array("User", $this->int_link_filter)) {
            return true;
        }
        if (!$this->getIntLinkFilterWhiteList() && !in_array("User", $this->int_link_filter)) {
            return true;
        }

        return false;
    }
    
    public function setEnableWikiLinks($a_enablewikilinks)
    {
        $this->enablewikilinks = $a_enablewikilinks;
    }

    public function getEnableWikiLinks()
    {
        return $this->enablewikilinks;
    }

    public function addIntLinkFilter($a_val)
    {
        $lng = $this->lng;
        
        $this->setLocalizationLanguage($lng->getLangKey());
        if (is_array($a_val)) {
            $this->int_link_filter =
                array_merge($a_val, $this->int_link_filter);
        } else {
            $this->int_link_filter[] = $a_val;
        }
    }
    
    public function removeIntLinkFilter($a_val)
    {
        foreach ($this->int_link_filter as $k => $v) {
            if ($v == $a_val) {
                unset($this->int_link_filter[$k]);
            }
        }
    }
    
    
    public function getIntLinkFilters()
    {
        return $this->int_link_filter;
    }

    public function setIntLinkFilterWhiteList($a_white_list)
    {
        $this->link_filter_white_list = $a_white_list;
        if ($a_white_list) {
            $this->int_link_filter = array();
        }
    }

    public function getIntLinkFilterWhiteList()
    {
        return $this->link_filter_white_list;
    }

    public function setPreventRteUsage($a_val)
    {
        $this->prevent_rte_usage = $a_val;
    }

    public function getPreventRteUsage()
    {
        return $this->prevent_rte_usage;
    }
    
    public function setLocalizationLanguage($a_val)
    {
        $this->localization_lang = $a_val;
    }
    
    public function getLocalizationLanguage()
    {
        return $this->localization_lang;
    }
    
    public function setUseAttachedContent($a_val)
    {
        $this->use_attached_content = $a_val;
    }
    
    public function getUseAttachedContent()
    {
        return $this->use_attached_content;
    }
    
    public function setIntLinkHelpDefaultType($a_val)
    {
        $this->int_link_def_type = $a_val;
    }
    
    public function getIntLinkHelpDefaultType()
    {
        return $this->int_link_def_type;
    }
    
    public function setIntLinkHelpDefaultId($a_val, $a_is_ref = true)
    {
        $this->int_link_def_id = $a_val;
        $this->int_link_def_id_is_ref = $a_is_ref;
    }
    
    public function getIntLinkHelpDefaultId()
    {
        return $this->int_link_def_id;
    }

    public function getIntLinkHelpDefaultIdIsRef()
    {
        return $this->int_link_def_id_is_ref;
    }

    public function setEnableActivation($a_val)
    {
        $this->activation = $a_val;
    }
    
    public function getEnableActivation()
    {
        return $this->activation;
    }
    
    public function setEnableScheduledActivation($a_val)
    {
        $this->scheduled_activation = $a_val;
    }
    
    public function getEnableScheduledActivation()
    {
        return $this->scheduled_activation;
    }
    
    public function setEnablePageToc($a_val)
    {
        $this->page_toc = $a_val;
    }
    
    public function getEnablePageToc()
    {
        return $this->page_toc;
    }
    
    public function setPreventHTMLUnmasking($a_preventhtmlunmasking)
    {
        $this->preventhtmlunmasking = $a_preventhtmlunmasking;
    }

    public function getPreventHTMLUnmasking()
    {
        $safe = true;
        if ($this->adve_set->get("act_html_" . $this->page_obj_key)) {
            $safe = false;
        }
        return $safe;
        //return $this->preventhtmlunmasking;
    }

    public function setEnableSelfAssessment($a_enabledselfassessment, $a_scorm = true)
    {
        $this->setEnablePCType("Question", (bool) $a_enabledselfassessment);
        $this->enabledselfassessment = $a_enabledselfassessment;
        $this->enabledselfassessment_scorm = $a_scorm;
    }


    public function getEnableSelfAssessment()
    {
        return $this->enabledselfassessment;
    }

    public function getEnableSelfAssessmentScorm()
    {
        return $this->enabledselfassessment_scorm;
    }
    
    public function setDisableDefaultQuestionFeedback($a_val)
    {
        $this->disable_default_qfeedback = $a_val;
    }
    
    public function getDisableDefaultQuestionFeedback()
    {
        return $this->disable_default_qfeedback;
    }
    
    public function setMultiLangSupport($a_val)
    {
        $this->multi_lang_support = $a_val;
    }
    
    public function getMultiLangSupport()
    {
        return $this->multi_lang_support;
    }
    
    public function setSinglePageMode($a_val)
    {
        $this->single_page_mode = $a_val;
    }
    
    public function getSinglePageMode()
    {
        return $this->single_page_mode;
    }

    public function setQuestionHTML($question_html)
    {
        $this->question_html = $question_html;
    }

    public function getQuestionHTML()
    {
        return $this->question_html;
    }
    
    public function setUseStoredQuestionTries($a_val)
    {
        $this->use_stored_tries = $a_val;
    }
    
    public function getUseStoredQuestionTries()
    {
        return $this->use_stored_tries;
    }

    public function setEnablePermissionChecks($a_val)
    {
        $this->enable_permission_checks = $a_val;
    }

    public function getEnablePermissionChecks()
    {
        return $this->enable_permission_checks;
    }

    public function setEditLockSupport($a_val)
    {
        $this->edit_lock_support = $a_val;
    }

    public function getEditLockSupport()
    {
        return $this->edit_lock_support;
    }

    public function setUsePageContainer($a_val)
    {
        $this->use_page_container = $a_val;
    }

    public function getUsePageContainer()
    {
        return $this->use_page_container;
    }
}