ilPCPluggedGUI Class Reference

Class ilPCPluggedGUI. More...

Inheritance diagram for ilPCPluggedGUI:

Collaboration diagram for ilPCPluggedGUI:

Public Member Functions
	__construct (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_plugin_name="", $a_pc_id="")
	Constructor public. More...
	setPluginName ($a_pluginname)
	Set PluginName. More...
	getPluginName ()
	Get PluginName. More...
	executeCommand ()
	execute command More...
	insert ()
	Insert new section form. More...
	edit ($a_insert=false)
	Edit section form. More...
	createElement (array $a_properties)
	Create new element. More...
	updateElement (array $a_properties)
	Update element. More...
	returnToParent ()
	Return to parent. More...
Public Member Functions inherited from ilPageContentGUI
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	displayValidationError ()
	display validation errors More...
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions ($a_type)
	Get table templates. More...

Protected Attributes
	$plugin_admin
	$tabs
	$current_plugin = null
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

Class ilPCPluggedGUI.

User Interface for plugged page component

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 19 of file class.ilPCPluggedGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCPluggedGUI::__construct	(	&	$a_pg_obj,
		&	$a_content_obj,
			$a_hier_id,
			$a_plugin_name = "",
			$a_pc_id = ""
	)

Constructor public.

Definition at line 37 of file class.ilPCPluggedGUI.php.

References $DIC, and setPluginName().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->plugin_admin = $DIC["ilPluginAdmin"];
        $this->tabs = $DIC->tabs();
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];

        $this->setPluginName($a_plugin_name);
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

createElement()

ilPCPluggedGUI::createElement

(

array

$a_properties

)

Create new element.

Definition at line 171 of file class.ilPCPluggedGUI.php.

References ilPageContentGUI\getPage().

    {
        $this->content_obj = new ilPCPlugged($this->getPage());
        $this->content_obj->create(
            $this->pg_obj,
            $this->hier_id,
            $this->pc_id,
            $this->current_plugin->getPluginName(),
            $this->current_plugin->getVersion()
        );
        $this->content_obj->setProperties($a_properties);
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

edit()

ilPCPluggedGUI::edit

(

$a_insert = false

)

Edit section form.

Definition at line 131 of file class.ilPCPluggedGUI.php.

References ilPageContentGUI\$ctrl, $html, $ilCtrl, ilPageContentGUI\$lng, $plugin_admin, ilPageContentGUI\$tpl, ilPageComponentPlugin\CMD_EDIT, ilPageComponentPlugin\CMD_INSERT, ilPageContentGUI\displayValidationError(), ilPageContentGUI\getPage(), getPluginName(), and IL_COMP_SERVICE.

Referenced by insert().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilPluginAdmin = $this->plugin_admin;
        
        $this->displayValidationError();
        
        // edit form
        if ($a_insert) {
            $plugin_name = $this->getPluginName();
        } else {
            $plugin_name = $this->content_obj->getPluginName();
        }
        if ($ilPluginAdmin->isActive(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name)) {
            $plugin_obj = $ilPluginAdmin->getPluginObject(
                IL_COMP_SERVICE,
                "COPage",
                "pgcp",
                $plugin_name
            );
            $plugin_obj->setPageObj($this->getPage());
            $gui_obj = $plugin_obj->getUIClassInstance();
            $gui_obj->setPCGUI($this);
            if ($a_insert) {
                $gui_obj->setMode(ilPageComponentPlugin::CMD_INSERT);
            } else {
                $gui_obj->setMode(ilPageComponentPlugin::CMD_EDIT);
            }
            $html = $ilCtrl->getHTML($gui_obj);
        }
        
        $tpl->setContent($html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCPluggedGUI::executeCommand

(

)

execute command

Definition at line 74 of file class.ilPCPluggedGUI.php.

References ilPageContentGUI\$ctrl, $ilCtrl, ilPageContentGUI\$lng, $plugin_admin, $ret, $tabs, ilPageContentGUI\getPage(), IL_COMP_SERVICE, and setPluginName().

    {
        $ilPluginAdmin = $this->plugin_admin;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $ilTabs->setBackTarget($lng->txt("pg"), $ilCtrl->getLinkTarget($this, "returnToParent"));
        
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get all plugins and check, whether next class belongs to one
        // of them, then forward
        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(
            IL_COMP_SERVICE,
            "COPage",
            "pgcp"
        );
        foreach ($pl_names as $pl_name) {
            if ($next_class == strtolower("il" . $pl_name . "plugingui")) {
                $plugin = $ilPluginAdmin->getPluginObject(
                    IL_COMP_SERVICE,
                    "COPage",
                    "pgcp",
                    $pl_name
                );
                $plugin->setPageObj($this->getPage());
                $this->current_plugin = $plugin;
                $this->setPluginName($pl_name);
                $gui_obj = $plugin->getUIClassInstance();
                $gui_obj->setPCGUI($this);
                $ret = $this->ctrl->forwardCommand($gui_obj);
            }
        }

        // get current command
        $cmd = $this->ctrl->getCmd();

        if ($next_class == "" || $next_class == "ilpcpluggedgui") {
            $ret = $this->$cmd();
        }

        return $ret;
    }

Here is the call graph for this function:

getPluginName()

ilPCPluggedGUI::getPluginName

(

)

Get PluginName.

Returns

string PluginName

Definition at line 66 of file class.ilPCPluggedGUI.php.

Referenced by edit().

    {
        return $this->pluginname;
    }

Here is the caller graph for this function:

insert()

ilPCPluggedGUI::insert

(

)

Insert new section form.

Definition at line 123 of file class.ilPCPluggedGUI.php.

References edit().

    {
        $this->edit(true);
    }

Here is the call graph for this function:

returnToParent()

ilPCPluggedGUI::returnToParent

(

)

Return to parent.

Definition at line 206 of file class.ilPCPluggedGUI.php.

    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

setPluginName()

ilPCPluggedGUI::setPluginName

(

$a_pluginname

)

Set PluginName.

Parameters

string

$a_pluginname

PluginName

Definition at line 56 of file class.ilPCPluggedGUI.php.

Referenced by __construct(), and executeCommand().

    {
        $this->pluginname = $a_pluginname;
    }

Here is the caller graph for this function:

updateElement()

ilPCPluggedGUI::updateElement

(

array

$a_properties

)

Update element.

Definition at line 192 of file class.ilPCPluggedGUI.php.

    {
        $this->content_obj->setProperties($a_properties);
        $this->content_obj->setPluginVersion($this->current_plugin->getVersion());
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            return true;
        }
        return false;
    }

Field Documentation

$current_plugin

ilPCPluggedGUI::$current_plugin = null

protected

Definition at line 31 of file class.ilPCPluggedGUI.php.

$plugin_admin

ilPCPluggedGUI::$plugin_admin

protected

Definition at line 24 of file class.ilPCPluggedGUI.php.

Referenced by edit(), and executeCommand().

$tabs

ilPCPluggedGUI::$tabs

protected

Definition at line 29 of file class.ilPCPluggedGUI.php.

Referenced by executeCommand().

---

The documentation for this class was generated from the following file:

• Services/COPage/classes/class.ilPCPluggedGUI.php