class.ilPageComponentPluginGUI.php

Go to the documentation of this file.

<?php

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

abstract class ilPageComponentPluginGUI
{
        protected $plugin;
        protected $pc_gui;
        protected $pc;
        
        function setPCGUI($a_val)
        {
                $this->pc_gui = $a_val;
        }
        
        function getPCGUI()
        {
                return $this->pc_gui;
        }
        
        function setPlugin($a_val)
        {
                $this->plugin = $a_val;
        }
        
        function getPlugin()
        {
                return $this->plugin;
        }
        
        final function setMode($a_mode)
        {
                $this->mode = $a_mode;
        }

        final function getMode()
        {
                return $this->mode;
        }

        function getHTML()
        {
                if ($this->getMode() == ilPageComponentPlugin::CMD_INSERT)
                {
                        $this->insert();
                }
                else if ($this->getMode() == ilPageComponentPlugin::CMD_EDIT)
                {
                        $this->edit();
                }
                
        }

        abstract function executeCommand();
        abstract function insert();
        abstract function edit();
        abstract function create();
        abstract function getElementHTML($a_mode, array $a_properties, $plugin_version);
        
        function createElement(array $a_properties)
        {
                return $this->getPCGUI()->createElement($a_properties);
        }
        
        function updateElement(array $a_properties)
        {
                return $this->getPCGUI()->updateElement($a_properties);
        }
        
        function returnToParent()
        {
                $this->getPCGUI()->returnToParent();
        }

        function setProperties(array $a_val)
        {
                $co = $this->getPCGUI()->getContentObject();
                if (is_object($co))
                {
                        $co->setProperties($a_val);
                }
        }
        
        function getProperties()
        {
                $co = $this->getPCGUI()->getContentObject();
                if (is_object($co))
                {
                        return $co->getProperties($a_val);
                }
                return array();
        }

        final protected function addCreationButton($a_form)
        {
                global $lng;
                
                $a_form->addCommandButton("create_plug", $lng->txt("save"));
        }
}
?>