ilPCLayoutTemplateGUI Class Reference

ilPCLayoutTemplateGUI: ilPageEditorGUI More...

Inheritance diagram for ilPCLayoutTemplateGUI:

Collaboration diagram for ilPCLayoutTemplateGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	Execute command. More...
	insert ()
	Insert content template. More...
	initCreationForm ()
	Init creation from. More...
	create ()
	Insert the template. More...
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	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 (string $a_type="")
	Get table templates. More...

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

ilPCLayoutTemplateGUI: ilPageEditorGUI

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

Constructor & Destructor Documentation

__construct()

ilPCLayoutTemplateGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

Definition at line 26 of file class.ilPCLayoutTemplateGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        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

create()

ilPCLayoutTemplateGUI::create

(

)

Insert the template.

Definition at line 111 of file class.ilPCLayoutTemplateGUI.php.

References ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), ilPageContentGUI\getPage(), and ILIAS\UICore\GlobalTemplate\setContent().

                            : void
    {
        $tpl = $this->tpl;

        $form = $this->initForm();
        if ($form->checkInput()) {
            $this->content_obj = new ilPCLayoutTemplate($this->getPage());
            $this->content_obj->create(
                $this->pg_obj,
                $this->hier_id,
                $this->pc_id,
                (int) $form->getInput("tmpl")
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                return;
            }
        }
        $this->displayValidationError();
        $form->setValuesByPost();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilPCLayoutTemplateGUI::executeCommand

(

)

Execute command.

Definition at line 43 of file class.ilPCLayoutTemplateGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        // 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:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

initCreationForm()

ilPCLayoutTemplateGUI::initCreationForm

(

)

Init creation from.

Definition at line 73 of file class.ilPCLayoutTemplateGUI.php.

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ilPageLayout\activeLayouts(), ilPageContentGUI\getPage(), ILIAS\Repository\lng(), ilFormPropertyGUI\setRequired(), ilRadioOption\setValue(), and ilLanguage\txt().

Referenced by ilPCLayoutTemplateEditorGUI\getEditComponentForm().

                                      : ilPropertyFormGUI
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        // edit form
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        $form->setTitle($this->lng->txt("cont_ed_insert_lay"));

        $config = $this->getPage()->getPageConfig();
        $templates = ilPageLayout::activeLayouts($config->getLayoutTemplateType());
        $first = true;
        if ($templates) {
            $use_template = new ilRadioGroupInputGUI($this->lng->txt("cont_layout"), "tmpl");
            $use_template->setRequired(true);
            $form->addItem($use_template);

            foreach ($templates as $templ) {
                $templ->readObject();
                $opt = new ilRadioOption($templ->getTitle() . $templ->getPreview(), (string) $templ->getId());
                $use_template->addOption($opt);
                if ($first) {
                    $use_template->setValue((string) $templ->getId());
                    $first = false;
                }
            }
        }

        $form->addCommandButton("create", $lng->txt("insert"));
        $form->addCommandButton("cancelCreate", $lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCLayoutTemplateGUI::insert

(

)

Insert content template.

Definition at line 61 of file class.ilPCLayoutTemplateGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and ILIAS\UICore\GlobalTemplate\setContent().

                            : void
    {
        $tpl = $this->tpl;

        $this->displayValidationError();
        $form = $this->initForm();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

---

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

• components/ILIAS/COPage/PC/LayoutTemplate/class.ilPCLayoutTemplateGUI.php