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 $lng;


    public function __construct()
    {
        global $DIC;

        $this->lng = $DIC->language();
    }

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

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

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

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

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

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