ilPCGridGUI Class Reference

Responsive Grid UI class. More...

Inheritance diagram for ilPCGridGUI:

Collaboration diagram for ilPCGridGUI:

Public Member Functions
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor. More...
	executeCommand ()
	Execute command. More...
	insert ()
	Insert new grid. More...
	editProperties ()
	Edit grid cells. More...
	initCreationForm ()
	Init creation form. More...
	create ()
	Create new grid element. More...
	afterCreation ()
	After creation processing. More...
	edit ()
	List all cells. More...
	saveCells ()
	Save cell properties. More...
	addCell ()
	Add cell. More...
	confirmCellDeletion ()
	Confirm cell deletion. More...
	cancelCellDeletion ()
	Cancel cell deletion. More...
	deleteCells ()
	Delete Cells. More...
	setTabs ()
	Set tabs. More...
	saveCellData ()
	Save tabs properties in db and return to page edit screen. 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...

Data Fields
const	TEMPLATE_MANUAL = 0
const	TEMPLATE_TWO_COLUMN = 1
const	TEMPLATE_THREE_COLUMN = 2
const	TEMPLATE_MAIN_SIDE = 3
const	TEMPLATE_TWO_BY_TWO = 4
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null

Protected Attributes
	$toolbar
	$tabs
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
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

Responsive Grid UI class.

Author

Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 15 of file class.ilPCGridGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCGridGUI::__construct	(		$a_pg_obj,
			$a_content_obj,
			$a_hier_id,
			$a_pc_id = ""
	)

Constructor.

Parameters

	$a_pg_obj
	$a_content_obj
	$a_hier_id
string	$a_pc_id

Definition at line 33 of file class.ilPCGridGUI.php.

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

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $ilToolbar = $DIC->toolbar();
        $ilTabs = $DIC->tabs();

        $this->toolbar = $ilToolbar;
        $this->tabs = $ilTabs;
        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

addCell()

ilPCGridGUI::addCell

(

)

Add cell.

Definition at line 263 of file class.ilPCGridGUI.php.

    {
        $this->content_obj->addCell("", "", "", "");
        $this->updated = $this->pg_obj->update();

        ilUtil::sendSuccess($this->lng->txt("cont_added_cell"), true);
        $this->ctrl->redirect($this, "edit");
    }

afterCreation()

ilPCGridGUI::afterCreation

(

)

After creation processing.

Definition at line 212 of file class.ilPCGridGUI.php.

References edit(), and ilPageContentGUI\setHierId().

Referenced by create().

    {
        $this->pg_obj->stripHierIDs();
        $this->pg_obj->addHierIDs();
        $this->ctrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
        $this->ctrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
        $this->content_obj->setHierId($this->content_obj->readHierId());
        $this->setHierId($this->content_obj->readHierId());
        $this->content_obj->setPCId($this->content_obj->readPCId());
        $this->edit();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancelCellDeletion()

ilPCGridGUI::cancelCellDeletion

(

)

Cancel cell deletion.

Definition at line 303 of file class.ilPCGridGUI.php.

    {
        $this->ctrl->redirect($this, "edit");
    }

confirmCellDeletion()

ilPCGridGUI::confirmCellDeletion

(

)

Confirm cell deletion.

Definition at line 275 of file class.ilPCGridGUI.php.

References $_POST, $i, ilUtil\sendInfo(), and setTabs().

    {
        $this->setTabs();

        if (!is_array($_POST["tid"]) || count($_POST["tid"]) == 0) {
            ilUtil::sendInfo($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "edit");
        } else {
            include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($this->ctrl->getFormAction($this));
            $cgui->setHeaderText($this->lng->txt("cont_grid_cell_confirm_deletion"));
            $cgui->setCancel($this->lng->txt("cancel"), "cancelCellDeletion");
            $cgui->setConfirm($this->lng->txt("delete"), "deleteCells");
            
            foreach ($_POST["tid"] as $k => $i) {
                $id = explode(":", $k);
                $id = explode("_", $id[0]);
                $cgui->addItem("tid[]", $k, $this->lng->txt("cont_grid_cell") . " " . $id[count($id) - 1]);
            }
            
            $this->tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

create()

ilPCGridGUI::create

(

)

Create new grid element.

Definition at line 155 of file class.ilPCGridGUI.php.

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

    {
        $form = $this->initCreationForm();
        if ($form->checkInput()) {
            $post_layout_template = (int) $_POST["layout_template"];
            $this->content_obj = new ilPCGrid($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);

            switch ($post_layout_template) {
                case self::TEMPLATE_TWO_COLUMN:
                    $this->content_obj->addGridCell(12, 6, 6, 6);
                    $this->content_obj->addGridCell(12, 6, 6, 6);
                    break;

                case self::TEMPLATE_THREE_COLUMN:
                    $this->content_obj->addGridCell(12, 4, 4, 4);
                    $this->content_obj->addGridCell(12, 4, 4, 4);
                    $this->content_obj->addGridCell(12, 4, 4, 4);
                    break;

                case self::TEMPLATE_MAIN_SIDE:
                    $this->content_obj->addGridCell(12, 6, 8, 9);
                    $this->content_obj->addGridCell(12, 6, 4, 3);
                    break;

                case self::TEMPLATE_TWO_BY_TWO:
                    $this->content_obj->addGridCell(12, 6, 6, 3);
                    $this->content_obj->addGridCell(12, 6, 6, 3);
                    $this->content_obj->addGridCell(12, 6, 6, 3);
                    $this->content_obj->addGridCell(12, 6, 6, 3);
                    break;


                case self::TEMPLATE_MANUAL:
                    for ($i = 0; $i < (int) $_POST["number_of_cells"]; $i++) {
                        $this->content_obj->addGridCell($_POST["s"], $_POST["m"], $_POST["l"], $_POST["xl"]);
                    }
                    break;
            }

            $this->updated = $this->pg_obj->update();

            if ($this->updated === true) {
                $this->afterCreation();
            //$this->ctrl->returnToParent($this, "jump".$this->hier_id);
            } else {
                $this->insert();
            }
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

deleteCells()

ilPCGridGUI::deleteCells

(

)

Delete Cells.

Definition at line 311 of file class.ilPCGridGUI.php.

References $_POST, ilPageContentGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;
        
        if (is_array($_POST["tid"])) {
            foreach ($_POST["tid"] as $tid) {
                $ids = explode(":", $tid);
                $this->content_obj->deleteGridCell($ids[0], $ids[1]);
            }
        }
        $this->updated = $this->pg_obj->update();
        
        $ilCtrl->redirect($this, "edit");
    }

edit()

ilPCGridGUI::edit

(

)

List all cells.

Definition at line 232 of file class.ilPCGridGUI.php.

References setTabs().

Referenced by afterCreation().

    {
        $this->toolbar->addButton(
            $this->lng->txt("cont_add_cell"),
            $this->ctrl->getLinkTarget($this, "addCell")
        );

        $this->setTabs();
        $this->tabs->activateTab("settings");
        include_once("./Services/COPage/classes/class.ilPCGridCellTableGUI.php");
        $table_gui = new ilPCGridCellTableGUI($this, "edit", $this->content_obj);
        $this->tpl->setContent($table_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editProperties()

ilPCGridGUI::editProperties

(

)

Edit grid cells.

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

References ilPageContentGUI\displayValidationError(), and setTabs().

    {
        $this->displayValidationError();
        $this->setTabs();
        
        $form = $this->initForm();
        $this->getFormValues($form);
        $html = $form->getHTML();
        $this->tpl->setContent($html);
    }

Here is the call graph for this function:

executeCommand()

ilPCGridGUI::executeCommand

(

)

Execute command.

Definition at line 49 of file class.ilPCGridGUI.php.

References $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;
    }

initCreationForm()

ilPCGridGUI::initCreationForm

(

)

Init creation form.

Returns

ilPropertyFormGUI

Definition at line 97 of file class.ilPCGridGUI.php.

References ilPageContentGUI\$lng, $si, ilPCGrid\getSizes(), ilPCGrid\getWidths(), ilNumberInputGUI\setMaxLength(), and ilRadioGroupInputGUI\setValue().

Referenced by create(), and insert().

    {
        $lng = $this->lng;

        // edit form
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("cont_ed_insert_grid"));
        $form->setDescription($this->lng->txt("cont_ed_insert_grid_info"));
        
        //
        $radg = new ilRadioGroupInputGUI($lng->txt("cont_pc_grid"), "layout_template");
        $radg->setValue(self::TEMPLATE_TWO_COLUMN);
        $op1 = new ilRadioOption($lng->txt("cont_grid_t_two_column"), self::TEMPLATE_TWO_COLUMN, $lng->txt("cont_grid_t_two_column_info"));
        $radg->addOption($op1);
        $op2 = new ilRadioOption($lng->txt("cont_grid_t_three_column"), self::TEMPLATE_THREE_COLUMN, $lng->txt("cont_grid_t_three_column_info"));
        $radg->addOption($op2);
        $op3 = new ilRadioOption($lng->txt("cont_grid_t_main_side"), self::TEMPLATE_MAIN_SIDE, $lng->txt("cont_grid_t_main_side_info"));
        $radg->addOption($op3);
        $op4 = new ilRadioOption($lng->txt("cont_grid_t_two_by_two"), self::TEMPLATE_TWO_BY_TWO, $lng->txt("cont_grid_t_two_by_two_info"));
        $radg->addOption($op4);
        $op5 = new ilRadioOption($lng->txt("cont_grid_t_manual"), self::TEMPLATE_MANUAL, $lng->txt("cont_grid_t_manual_info"));
        $radg->addOption($op5);
        $form->addItem($radg);
        

        // number of cells
        $ni = new ilNumberInputGUI($this->lng->txt("cont_grid_nr_cells"), "number_of_cells");
        $ni->setMaxLength(2);
        $ni->setSize(2);
        $op5->addSubItem($ni);

        /*$sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt("cont_ed_grid_col_width"));
        $sh->setInfo($this->lng->txt("cont_ed_grid_col_width_info"));
        $form->addItem($sh);*/

        $options = array("" => "") + ilPCGrid::getWidths();

        // widths
        foreach (ilPCGrid::getSizes() as $s) {
            $si = new ilSelectInputGUI($this->lng->txt("cont_grid_width_" . $s), $s);
            $si->setInfo($this->lng->txt("cont_grid_width_" . $s . "_info"));
            $si->setOptions($options);
            $op5->addSubItem($si);
        }

        // save/cancel buttons
        $form->addCommandButton("create_grid", $this->lng->txt("save"));
        $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCGridGUI::insert

(

)

Insert new grid.

Definition at line 69 of file class.ilPCGridGUI.php.

References ilPageContentGUI\displayValidationError(), and initCreationForm().

Referenced by create().

    {
        $this->displayValidationError();
        $form = $this->initCreationForm();
        if ($this->ctrl->getCmd() == "create") {
            $form->setValuesByPost();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveCellData()

ilPCGridGUI::saveCellData

(

)

Save tabs properties in db and return to page edit screen.

Definition at line 347 of file class.ilPCGridGUI.php.

References $_POST, and ilUtil\stripSlashesArray().

    {
        $width_s = ilUtil::stripSlashesArray($_POST["width_s"]);
        $width_m = ilUtil::stripSlashesArray($_POST["width_m"]);
        $width_l = ilUtil::stripSlashesArray($_POST["width_l"]);
        $width_xl = ilUtil::stripSlashesArray($_POST["width_xl"]);
        $this->content_obj->saveWidths($width_s, $width_m, $width_l, $width_xl);

        if (is_array($_POST["position"])) {
            $positions = ilUtil::stripSlashesArray($_POST["position"]);
            $this->content_obj->savePositions($positions);
        }
        $this->updated = $this->pg_obj->update();
        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "edit");
    }

Here is the call graph for this function:

saveCells()

ilPCGridGUI::saveCells

(

)

Save cell properties.

Definition at line 249 of file class.ilPCGridGUI.php.

References $_POST, and ilUtil\stripSlashesArray().

    {
        if (is_array($_POST["position"])) {
            $positions = ilUtil::stripSlashesArray($_POST["position"]);
            $this->content_obj->savePositions($positions);
        }
        $this->updated = $this->pg_obj->update();
        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "edit");
    }

Here is the call graph for this function:

setTabs()

ilPCGridGUI::setTabs

(

)

Set tabs.

Definition at line 330 of file class.ilPCGridGUI.php.

Referenced by confirmCellDeletion(), edit(), and editProperties().

    {
        $this->tabs->setBackTarget(
            $this->lng->txt("pg"),
            $this->ctrl->getParentReturn($this)
        );

        $this->tabs->addTab(
            "settings",
            $this->lng->txt("settings"),
            $this->ctrl->getLinkTarget($this, "edit")
        );
    }

Here is the caller graph for this function:

Field Documentation

$tabs

ilPCGridGUI::$tabs

protected

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

$toolbar

ilPCGridGUI::$toolbar

protected

Definition at line 23 of file class.ilPCGridGUI.php.

TEMPLATE_MAIN_SIDE

const ilPCGridGUI::TEMPLATE_MAIN_SIDE = 3

Definition at line 20 of file class.ilPCGridGUI.php.

TEMPLATE_MANUAL

const ilPCGridGUI::TEMPLATE_MANUAL = 0

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

TEMPLATE_THREE_COLUMN

const ilPCGridGUI::TEMPLATE_THREE_COLUMN = 2

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

TEMPLATE_TWO_BY_TWO

const ilPCGridGUI::TEMPLATE_TWO_BY_TWO = 4

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

TEMPLATE_TWO_COLUMN

const ilPCGridGUI::TEMPLATE_TWO_COLUMN = 1

Definition at line 18 of file class.ilPCGridGUI.php.

---

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

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