class.ilPageComponentPlugin.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2008 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

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";
        
        final function getComponentType()
        {
                return IL_COMP_SERVICE;
        }
        
        final function getComponentName()
        {
                return "COPage";
        }
        
        final function getSlot()
        {
                return "PageComponent";
        }
        
        final function getSlotId()
        {
                return "pgcp";
        }
        
        protected final function slotInit()
        {
                // nothing to do here
        }
        
        abstract function isValidParentType($a_type);
        
        abstract function getUIText($a_text_id);

        final function setMode($a_mode)
        {
                $this->mode = $a_mode;
        }

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

        final function setProperties($a_properties)
        {
                $this->properties = $a_properties;
        }

        final function getProperties()
        {
                return $this->properties;
        }

        final function addSaveCancelButtons($a_form)
        {
                global $lng;
                
                if ($this->getMode() == ilPageComponentPlugin::CMD_INSERT)
                {
                        $a_form->addCommandButton("create_plug", $lng->txt("save"));
                        $a_form->addCommandButton("cancelCreate", $lng->txt("cancel"));
                }
                else
                {
                        $a_form->addCommandButton("update_plug", $lng->txt("save"));
                        $a_form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
                }
        }
}
?>