ilPCPluggedGUI Class Reference

Class ilPCPluggedGUI. More...

Inheritance diagram for ilPCPluggedGUI:

Collaboration diagram for ilPCPluggedGUI:

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

Protected Attributes
	$current_plugin = null

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons.
Data Fields inherited from ilPageContentGUI
	$content_obj
	$ilias
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style.
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.

Member Function Documentation

ilPCPluggedGUI::createElement

(

array

$a_properties

)

Create new element.

Definition at line 146 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:

ilPCPluggedGUI::edit

(

$a_insert = false

)

Edit section form.

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

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

Referenced by insert().

        {
                global $ilCtrl, $tpl, $lng, $ilPluginAdmin;
                
                $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);
                        $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:

& ilPCPluggedGUI::executeCommand

(

)

execute command

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

References $cmd, $ilCtrl, ilPageContentGUI\$lng, $ret, IL_COMP_SERVICE, and setPluginName().

        {
                global $ilPluginAdmin, $ilTabs, $lng, $ilCtrl;
                
                $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);
                                $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:

ilPCPluggedGUI::getPluginName

(

)

Get PluginName.

Returns

string PluginName

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

Referenced by edit().

        {
                return $this->pluginname;
        }

Here is the caller graph for this function:

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

Constructor public.

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

References $ilCtrl, ilPageContentGUI\ilPageContentGUI(), and setPluginName().

        {
                global $ilCtrl;
                $this->setPluginName($a_plugin_name);
                parent::ilPageContentGUI($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);              
        }

Here is the call graph for this function:

ilPCPluggedGUI::insert

(

)

Insert new section form.

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

References edit().

        {
                $this->edit(true);
        }

Here is the call graph for this function:

ilPCPluggedGUI::returnToParent

(

)

Return to parent.

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

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

ilPCPluggedGUI::setPluginName

(

$a_pluginname

)

Set PluginName.

Parameters

string

$a_pluginname

PluginName

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

Referenced by executeCommand(), and ilPCPluggedGUI().

        {
                $this->pluginname = $a_pluginname;
        }

Here is the caller graph for this function:

ilPCPluggedGUI::updateElement

(

array

$a_properties

)

Update element.

Definition at line 163 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

ilPCPluggedGUI::$current_plugin = null

protected

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

---

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

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