class.ilPageComponentPlugin.php

Go to the documentation of this file.

<?php
 
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
 
include_once("./Services/Component/classes/class.ilPlugin.php");
 
abstract class ilPageComponentPlugin extends ilPlugin
{
    const TXT_CMD_INSERT = "cmd_insert";
    const CMD_INSERT = "insert";
    const CMD_EDIT = "edit";
 
    private $page_obj = null;
    
    final public function getComponentType()
    {
        return IL_COMP_SERVICE;
    }
    
    final public function getComponentName()
    {
        return "COPage";
    }
    
    final public function getSlot()
    {
        return "PageComponent";
    }
    
    final public function getSlotId()
    {
        return "pgcp";
    }
    
    final protected function slotInit()
    {
        // nothing to do here
    }
    
    abstract public function isValidParentType($a_type);
    
    public function getJavascriptFiles($a_mode)
    {
        return array();
    }
    
    public function getCssFiles($a_mode)
    {
        return array();
    }
    
    final public function setMode($a_mode)
    {
        $this->mode = $a_mode;
    }
 
    final public function getMode()
    {
        return $this->mode;
    }
 
    public function getUIClassInstance()
    {
        $class = "il" . $this->getPluginName() . "PluginGUI";
        $this->includeClass("class." . $class . ".php");
        $obj = new $class();
        $obj->setPlugin($this);
        return $obj;
    }
 
    public function setPageObj($a_page_obj)
    {
        $this->page_obj = $a_page_obj;
    }
 
    public function getPageId()
    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getId();
        }
        return 0;
    }
 
    public function getParentId()
    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getParentId();
        }
        return 0;
    }
 
    public function getParentType()
    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getParentType();
        }
        return '';
    }
 
    public function onClone(&$a_properties, $a_plugin_version)
    {
    }
 
    public function onDelete($a_properties, $a_plugin_version)
    {
    }
}