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.
	create ()
	Create new plugged component.
	update ()
	Update Section.
Public Member Functions inherited from ilPageContentGUI
	ilPageContentGUI (&$a_pg_obj, &$a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public.
	setStyleId ($a_styleid)
	Set Style Id.
	getStyleId ()
	Get Style Id.
	setEnableInternalLinks ($a_val)
	Set enable internal links.
	getEnableInternalLinks ()
	Get enable internal links.
	setEnableKeywords ($a_val)
	Set enable keywords handling.
	getEnableKeywords ()
	Get enable keywords handling.
	setEnableAnchors ($a_val)
	Set enable anchors.
	getEnableAnchors ()
	Get enable anchors.
	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
	deactivate ()
	gui function set enabled if is not enabled and vice versa
	getTemplateOptions ($a_type)
	Get table templates.

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
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 37 of file class.ilPCPluggedGUI.php.

Member Function Documentation

ilPCPluggedGUI::create

(

)

Create new plugged component.

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

References $_POST, and insert().

        {
                $this->content_obj = new ilPCPlugged($this->dom);
                $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
                $properties = array(
                        "Table" => $_POST["table"]
                        );
                $this->content_obj->setProperties($properties);
                $this->updated = $this->pg_obj->update();
                if ($this->updated === true)
                {
                        $this->ctrl->returnToParent($this, "jump".$this->hier_id);
                }
                else
                {
                        $this->insert();
                }
        }

Here is the call graph for this function:

ilPCPluggedGUI::edit

(

$a_insert = false

)

Edit section form.

Definition at line 111 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(), and update().

        {
                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);
                        if ($a_insert)
                        {
                                $plugin_obj->setMode(ilPageComponentPlugin::CMD_INSERT);
                        }
                        else
                        {
                                $plugin_obj->setMode(ilPageComponentPlugin::CMD_EDIT);
                        }
                        $html = $ilCtrl->getHTML($plugin_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 82 of file class.ilPCPluggedGUI.php.

References $cmd, and $ret.

        {
                // get next class that processes or forwards current command
                $next_class = $this->ctrl->getNextClass($this);

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

                switch($next_class)
                {
                        default:
                                $ret =& $this->$cmd();
                                break;
                }

                return $ret;
        }

ilPCPluggedGUI::getPluginName

(

)

Get PluginName.

Returns

string PluginName

Definition at line 74 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 44 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);
                
                if ($a_plugin_name != "")
                {
                        $ilCtrl->setParameter($this, "plugin_name", rawurlencode($a_plugin_name));
                }
                $ilCtrl->saveParameter($this, "plugin_name");
        }

Here is the call graph for this function:

ilPCPluggedGUI::insert

(

)

Insert new section form.

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

References edit().

Referenced by create().

        {
                $this->edit(true);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPCPluggedGUI::setPluginName

(

$a_pluginname

)

Set PluginName.

Parameters

string

$a_pluginname

PluginName

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

Referenced by ilPCPluggedGUI().

        {
                $this->pluginname = $a_pluginname;
        }

Here is the caller graph for this function:

ilPCPluggedGUI::update

(

)

Update Section.

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

References $_POST, and edit().

        {
                $properties = array(
                        "Table" => $_POST["table"]);
                $this->content_obj->setProperties($properties);
                $this->updated = $this->pg_obj->update();
                if ($this->updated === true)
                {
                        $this->ctrl->returnToParent($this, "jump".$this->hier_id);
                }
                else
                {
                        $this->pg_obj->addHierIDs();
                        $this->edit();
                }
        }

Here is the call graph for this function:

---

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

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