ilPCConsultationHoursGUI Class Reference

Class ilPCConsultationHoursGUI. More...

Inheritance diagram for ilPCConsultationHoursGUI:

Collaboration diagram for ilPCConsultationHoursGUI:

Public Member Functions
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	executeCommand ()
	execute command More...
	insert (ilPropertyFormGUI $a_form=null)
	Insert consultation hours form. More...
	edit (ilPropertyFormGUI $a_form=null)
	Edit consultation hours form. More...
	create ()
	Create new consultation hours. More...
	update ()
	Update consultation hours. 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...

Protected Member Functions
	initForm ($a_insert=false)
	Init consultation hours form. More...
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...

Protected Attributes
	$user
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$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;"
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

Class ilPCConsultationHoursGUI.

Handles user commands on consultation hour data

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$I$

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

Definition at line 29 of file class.ilPCConsultationHoursGUI.php.

References $DIC, and user().

    {
        global $DIC;

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

ilPCConsultationHoursGUI::create

(

)

Create new consultation hours.

Definition at line 171 of file class.ilPCConsultationHoursGUI.php.

References $form, array, ilPageContentGUI\getPage(), initForm(), and insert().

    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $grp_ids = null;
            $mode = $form->getInput("mode");
            if ($mode == "manual") {
                $grp_ids = $form->getInput("grp");
            }
            
            $this->content_obj = new ilPCConsultationHours($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->setData($mode, (array) $grp_ids);
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }

        $form->setValuesByPost();
        return $this->insert($form);
    }

Here is the call graph for this function:

edit()

ilPCConsultationHoursGUI::edit

(

ilPropertyFormGUI

$a_form = null

)

Edit consultation hours form.

Parameters

ilPropertyFormGUI

$a_form

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

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and initForm().

Referenced by update().

    {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm();
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCConsultationHoursGUI::executeCommand

(

)

execute command

Definition at line 43 of file class.ilPCConsultationHoursGUI.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;
    }

initForm()

ilPCConsultationHoursGUI::initForm (   $a_insert = false )

protected

Init consultation hours form.

Parameters

bool

$a_insert

Returns

ilPropertyFormGUI

Definition at line 100 of file class.ilPCConsultationHoursGUI.php.

References ilPageContentGUI\$ctrl, $form, $ilCtrl, $ilUser, ilPageContentGUI\$lng, $user, ilConsultationHourGroups\getGroupsOfUser(), ilPageContentGUI\getPageConfig(), ilRadioOption\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by create(), edit(), insert(), and update().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $lng = $this->lng;

        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_consultation_hours"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_consultation_hours"));
        }
        
        $mode = new ilRadioGroupInputGUI($this->lng->txt("cont_cach_mode"), "mode");
        $mode->setRequired(true);
        $form->addItem($mode);
        
        $opt_auto = new ilRadioOption($this->lng->txt("cont_cach_mode_automatic"), "auto");
        $opt_auto->setInfo($this->lng->txt("cont_cach_mode_automatic_info"));
        $mode->addOption($opt_auto);
        
        $opt_manual = new ilRadioOption($this->lng->txt("cont_cach_mode_manual"), "manual");
        $opt_manual->setInfo($this->lng->txt("cont_cach_mode_manual_info"));
        $mode->addOption($opt_manual);
        
        if (!$this->getPageConfig()->getEnablePCType("PlaceHolder")) {
            include_once "Services/Calendar/classes/ConsultationHours/class.ilConsultationHourGroups.php";
            $grp_ids = ilConsultationHourGroups::getGroupsOfUser($ilUser->getId());
            if (sizeof($grp_ids)) {
                $this->lng->loadLanguageModule("dateplaner");
                $groups = new ilCheckboxGroupInputGUI($this->lng->txt("cal_ch_app_grp"), "grp");
                $groups->setRequired(true);
                $opt_manual->addSubItem($groups);

                foreach ($grp_ids as $grp_obj) {
                    $groups->addOption(new ilCheckboxOption($grp_obj->getTitle(), $grp_obj->getGroupId()));
                }
            } else {
                $opt_manual->setDisabled(true);
            }
        } else {
            $opt_manual->setDisabled(true);
        }
        
        if ($a_insert) {
            $mode->setValue("auto");
            
            $form->addCommandButton("create_consultation_hours", $this->lng->txt("select"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            // set values
            $grp_ids = $this->content_obj->getGroupIds();
            if (sizeof($grp_ids)) {
                $mode->setValue("manual");
                $groups->setValue($grp_ids);
            } else {
                $mode->setValue("auto");
            }
            
            $form->addCommandButton("update", $this->lng->txt("select"));
            $form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCConsultationHoursGUI::insert

(

ilPropertyFormGUI

$a_form = null

)

Insert consultation hours form.

Parameters

ilPropertyFormGUI

$a_form

Definition at line 65 of file class.ilPCConsultationHoursGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and initForm().

Referenced by create().

    {
        $tpl = $this->tpl;

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm(true);
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCConsultationHoursGUI::update

(

)

Update consultation hours.

Definition at line 197 of file class.ilPCConsultationHoursGUI.php.

References $form, array, edit(), and initForm().

    {
        $form = $this->initForm();
        if ($form->checkInput()) {
            $grp_ids = array();
            $mode = $form->getInput("mode");
            if ($mode == "manual") {
                $grp_ids = $form->getInput("grp");
            }
            
            $this->content_obj->setData($mode, $grp_ids);
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }

        $this->pg_obj->addHierIDs();
        $form->setValuesByPost();
        return $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$user

ilPCConsultationHoursGUI::$user

protected

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

Referenced by initForm().

---

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

• Modules/Portfolio/classes/class.ilPCConsultationHoursGUI.php