ilPCSectionGUI Class Reference

Class ilPCSectionGUI. More...

Inheritance diagram for ilPCSectionGUI:

Collaboration diagram for ilPCSectionGUI:

Public Member Functions
	ilPCSectionGUI (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public.
&	executeCommand ()
	execute command
	insert ()
	Insert new section form.
	edit ($a_insert=false)
	Edit section form.
	create ()
	Create new Section.
	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.
	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.

Static Public Member Functions
static	_getStandardCharacteristics ()
	Get standard characteristics.
static	_getCharacteristics ($a_style_id)
	Get characteristics.
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons.

Additional Inherited Members
Data Fields inherited from ilPageContentGUI
	$content_obj
	$ilias
	$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.
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

Class ilPCSectionGUI.

User Interface for Section Editing

Author

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

Version

$Id$

Definition at line 17 of file class.ilPCSectionGUI.php.

Member Function Documentation

static ilPCSectionGUI::_getCharacteristics (   $a_style_id )

static

Get characteristics.

Definition at line 51 of file class.ilPCSectionGUI.php.

References _getStandardCharacteristics(), and ilObject\_lookupType().

Referenced by ilPageEditorGUI\initCharacteristicForm().

        {
                $chars = ilPCSectionGUI::_getStandardCharacteristics();

                if ($a_style_id > 0 &&
                        ilObject::_lookupType($a_style_id) == "sty")
                {
                        include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                        $style = new ilObjStyleSheet($a_style_id);
                        $chars = $style->getCharacteristics("section");
                        $new_chars = array();
                        foreach ($chars as $char)
                        {
                                if ($chars[$char] != "")        // keep lang vars for standard chars
                                {
                                        $new_chars[$char] = $chars[$char];
                                }
                                else
                                {
                                        $new_chars[$char] = $char;
                                }
                                asort($new_chars);
                        }
                        $chars = $new_chars;
                }
                return $chars;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilPCSectionGUI::_getStandardCharacteristics ( )

static

Get standard characteristics.

Definition at line 34 of file class.ilPCSectionGUI.php.

References ilPageContentGUI\$lng.

Referenced by _getCharacteristics(), and ilPCSectionGUI().

        {
                global $lng;
                
                return array("Block" => $lng->txt("cont_Block"),
                        "Mnemonic" => $lng->txt("cont_Mnemonic"),
                        "Remark" => $lng->txt("cont_Remark"),
                        "Example" => $lng->txt("cont_Example"),
                        "Additional" => $lng->txt("cont_Additional"),
                        "Special" => $lng->txt("cont_Special"),
                        "Excursus" => $lng->txt("cont_Excursus"),
                        "AdvancedKnowledge" => $lng->txt("cont_AdvancedKnowledge"));
        }

Here is the caller graph for this function:

ilPCSectionGUI::create

(

)

Create new Section.

Definition at line 183 of file class.ilPCSectionGUI.php.

References $_POST, ilPageContentGUI\getPage(), and insert().

        {
                $this->content_obj = new ilPCSection($this->getPage());
                $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
                $this->content_obj->setCharacteristic($_POST["characteristic"]);
                $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:

ilPCSectionGUI::edit

(

$a_insert = false

)

Edit section form.

Definition at line 113 of file class.ilPCSectionGUI.php.

References $ilCtrl, ilPageContentGUI\$lng, $ret, ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and ilPageContentGUI\getCharacteristics().

Referenced by insert(), and update().

        {
                global $ilCtrl, $tpl, $lng;
                
                $this->displayValidationError();
                
                // edit form
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setFormAction($ilCtrl->getFormAction($this));
                if ($a_insert)
                {
                        $form->setTitle($this->lng->txt("cont_insert_section"));
                }
                else
                {
                        $form->setTitle($this->lng->txt("cont_update_section"));
                }
                
                // characteristic selection
                require_once("./Services/Form/classes/class.ilAdvSelectInputGUI.php");
                $char_prop = new ilAdvSelectInputGUI($this->lng->txt("cont_characteristic"),
                        "characteristic");
                        
                $chars = $this->getCharacteristics();
                if (is_object($this->content_obj))
                {
                        if ($chars[$a_seleted_value] == "" && ($this->content_obj->getCharacteristic() != ""))
                        {
                                $chars = array_merge(
                                        array($this->content_obj->getCharacteristic() => $this->content_obj->getCharacteristic()),
                                        $chars);
                        }
                }

                $selected = ($a_insert)
                        ? "Block"
                        : $this->content_obj->getCharacteristic();
                        
                foreach($chars as $k => $char)
                {
                        $html = '<div class="ilCOPgEditStyleSelectionItem"><div class="ilc_section_'.$k.'" style="'.self::$style_selector_reset.'">'.
                                $char.'</div></div>';
                        $char_prop->addOption($k, $char, $html);
                }

                $char_prop->setValue($selected); 
                $form->addItem($char_prop);
                
                // save/cancel buttons
                if ($a_insert)
                {
                        $form->addCommandButton("create_section", $lng->txt("save"));
                        $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
                }
                else
                {
                        $form->addCommandButton("update", $lng->txt("save"));
                        $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
                }
                $html = $form->getHTML();
                $tpl->setContent($html);
                return $ret;

        }

Here is the call graph for this function:

Here is the caller graph for this function:

& ilPCSectionGUI::executeCommand

(

)

execute command

Definition at line 82 of file class.ilPCSectionGUI.php.

References $cmd, $ret, and ilPageContentGUI\getCharacteristicsOfCurrentStyle().

        {
                $this->getCharacteristicsOfCurrentStyle("section");     // scorm-2004
                
                // 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;
        }

Here is the call graph for this function:

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

Constructor public.

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

References _getStandardCharacteristics(), ilPageContentGUI\ilPageContentGUI(), and ilPageContentGUI\setCharacteristics().

        {
                parent::ilPageContentGUI($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
                
                $this->setCharacteristics(ilPCSectionGUI::_getStandardCharacteristics());
        }

Here is the call graph for this function:

ilPCSectionGUI::insert

(

)

Insert new section form.

Definition at line 105 of file class.ilPCSectionGUI.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:

ilPCSectionGUI::update

(

)

Update Section.

Definition at line 202 of file class.ilPCSectionGUI.php.

References $_POST, and edit().

        {
                $this->content_obj->setCharacteristic($_POST["characteristic"]);
                $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.ilPCSectionGUI.php