ilObjNotificationAdminGUI Class Reference

GUI class for notification objects. More...

Inheritance diagram for ilObjNotificationAdminGUI:

Collaboration diagram for ilObjNotificationAdminGUI:

Public Member Functions
	__construct ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public. More...
	executeCommand ()
	setTabs ()
	__initSubTabs ()
	addLocatorItems ()
	showGeneralSettingsObject ($form=null)
	saveGeneralSettingsObject ()
	showTypesObject ()
	showChannelsObject ()
	saveTypesObject ()
	saveChannelsObject ()
	showConfigMatrixObject ()
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Static Public Member Functions
static	_forwards ()
static	saveObject2 ($params=array())
	save object More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Private Member Functions
	saveConfigMatrixObject ()

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Detailed Description

GUI class for notification objects.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

ilObjNotificationAdminGUI: ilPermissionGUI ilObjNotificationAdminGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

__construct()

ilObjNotificationAdminGUI::__construct	(		$a_data,
			$a_id = 0,
			$a_call_by_reference = true,
			$a_prepare_output = true
	)

Constructor public.

Definition at line 25 of file class.ilObjNotificationAdminGUI.php.

    {
        $this->type = "nota";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->lng->loadLanguageModule('notification');
    }

Member Function Documentation

__initSubTabs()

ilObjNotificationAdminGUI::__initSubTabs

(

)

Definition at line 112 of file class.ilObjNotificationAdminGUI.php.

References $ilCtrl, and $ilSetting.

Referenced by executeCommand().

    {
        global $ilTabs, $ilSetting, $ilCtrl;

        $ilTabs->addSubTabTarget("notification_general", $this->ctrl->getLinkTargetByClass('ilObjNotificationAdminGUI', "showGeneralSettings"));
        //$ilTabs->addSubTabTarget("notification_admin_channels", $this->ctrl->getLinkTargetByClass('ilObjNotificationAdminGUI', "showChannels"));
        $ilTabs->addSubTabTarget("notification_admin_types", $this->ctrl->getLinkTargetByClass('ilObjNotificationAdminGUI', "showTypes"));
        $ilTabs->addSubTabTarget("notification_admin_matrix", $this->ctrl->getLinkTargetByClass('ilObjNotificationAdminGUI', "showConfigMatrix"));
    }

Here is the caller graph for this function:

_forwards()

static ilObjNotificationAdminGUI::_forwards ( )

static

Definition at line 32 of file class.ilObjNotificationAdminGUI.php.

References array.

    {
        return array();
    }

addLocatorItems()

ilObjNotificationAdminGUI::addLocatorItems

(

)

Definition at line 122 of file class.ilObjNotificationAdminGUI.php.

References $_GET, and object.

    {
        global $ilLocator;
        
        if (is_object($this->object)) {
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $_GET["ref_id"]);
        }
    }

executeCommand()

ilObjNotificationAdminGUI::executeCommand

(

)

Definition at line 37 of file class.ilObjNotificationAdminGUI.php.

References $ilCtrl, $ilUser, $ret, __initSubTabs(), and ilObjectGUI\prepareOutput().

    {
        global $ilAccess, $ilNavigationHistory, $ilCtrl, $ilUser, $ilTabs;
        
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
    
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                //$ilTabs->activateTab("id_permissions");
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret =&$this->ctrl->forwardCommand($perm_gui);
                break;

                        default:
                $this->__initSubTabs();
                                $ilTabs->activateTab("view");
                            
                if (empty($cmd) || $cmd == 'view') {
                    $cmd = 'showTypes';
                }

                $cmd .= "Object";
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

saveChannelsObject()

ilObjNotificationAdminGUI::saveChannelsObject

(

)

Definition at line 229 of file class.ilObjNotificationAdminGUI.php.

References $type, ilNotificationDatabaseHandler\setConfigTypeForChannel(), and showChannelsObject().

    {
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';
        foreach ($_REQUEST['notifications'] as $type => $value) {
            ilNotificationDatabaseHandler::setConfigTypeForChannel($type, $value);
        }
        $this->showChannelsObject();
    }

Here is the call graph for this function:

saveConfigMatrixObject()

ilObjNotificationAdminGUI::saveConfigMatrixObject ( )

private

Definition at line 261 of file class.ilObjNotificationAdminGUI.php.

References $ilCtrl, $ilUser, array, ilNotificationDatabaseHandler\setUserConfig(), and showConfigMatrixObject().

    {
        global $ilUser, $ilCtrl;
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';

        ilNotificationDatabaseHandler::setUserConfig(-1, $_REQUEST['notification'] ? $_REQUEST['notification'] : array());
        $this->showConfigMatrixObject();
    }

Here is the call graph for this function:

saveGeneralSettingsObject()

ilObjNotificationAdminGUI::saveGeneralSettingsObject

(

)

Todo:

dirty...

push all notifiation settings to the form to enable custom settings per channel

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

References $_POST, $form, ilObjectGUI\$settings, $type, ilNotificationAdminSettingsForm\getGeneralSettingsForm(), ilNotificationDatabaseHandler\setConfigTypeForChannel(), and showGeneralSettingsObject().

    {
        require_once 'Services/Notifications/classes/class.ilNotificationAdminSettingsForm.php';
        #require_once 'Services/Administration/classes/class.ilSetting.php';

        $settings = new ilSetting('notifications');

        $form = ilNotificationAdminSettingsForm::getGeneralSettingsForm();
        $form->setValuesByPost();
        if (!$form->checkInput()) {
            $this->showGeneralSettingsObject($form);
        } else {
            $values = $form->store_values;//array('enable_osd', 'osd_polling_intervall', 'enable_mail');
                
            // handle custom channel settings
            foreach ($values as $v) {
                $settings->set($v, $_POST[$v]);
            }

            foreach ($_REQUEST['notifications'] as $type => $value) {
                ilNotificationDatabaseHandler::setConfigTypeForChannel($type, $value);
            }

            $this->showGeneralSettingsObject();
        }
    }

Here is the call graph for this function:

saveObject2()

static ilObjNotificationAdminGUI::saveObject2 (   $params = array() )

static

save object

public

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

References $ilUser, and ilObjectGUI\$objDefinition.

    {
        global $objDefinition, $ilUser;

        // create and insert file in grp_tree
        require_once 'Services/Notifications/classes/class.ilObjNotificationAdmin.php';
        $fileObj = new ilObjNotificationAdmin();
        $fileObj->setTitle('notification admin');
        $fileObj->create();
        $fileObj->createReference();
        $fileObj->putInTree(SYSTEM_FOLDER_ID);
        //$fileObj->setPermissions($params['ref_id']);
                // upload file to filesystem
    }

saveTypesObject()

ilObjNotificationAdminGUI::saveTypesObject

(

)

Definition at line 220 of file class.ilObjNotificationAdminGUI.php.

References $type, ilNotificationDatabaseHandler\setConfigTypeForType(), and showTypesObject().

    {
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';
        foreach ($_REQUEST['notifications'] as $type => $value) {
            ilNotificationDatabaseHandler::setConfigTypeForType($type, $value);
        }
        $this->showTypesObject();
    }

Here is the call graph for this function:

setTabs()

ilObjNotificationAdminGUI::setTabs

(

)

Definition at line 88 of file class.ilObjNotificationAdminGUI.php.

References ilObjectGUI\$lng, and array.

    {
        global $ilAccess, $ilTabs, $lng;

        $this->ctrl->setParameter($this, "ref_id", $this->ref_id);

        if ($ilAccess->checkAccess("visible", "", $this->ref_id)) {
            $ilTabs->addTab(
                "id_info",
                $lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass(array("ilobjfilegui", "ilinfoscreengui"), "showSummary")
            );
        }

        if ($ilAccess->checkAccess("edit_permission", "", $this->ref_id)) {
            $ilTabs->addTab(
                    "id_permissions",
                    $lng->txt("perm_settings"),
                    $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
                );
        }
    }

showChannelsObject()

ilObjNotificationAdminGUI::showChannelsObject

(

)

Definition at line 204 of file class.ilObjNotificationAdminGUI.php.

References $form, ilNotificationDatabaseHandler\getAvailableChannels(), and ilNotificationAdminSettingsForm\getChannelForm().

Referenced by saveChannelsObject().

    {
        global $ilTabs;

        $ilTabs->activateSubTab('notification_admin_channels');

        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';
        require_once 'Services/Notifications/classes/class.ilNotificationAdminSettingsForm.php';

        $form = ilNotificationAdminSettingsForm::getChannelForm(ilNotificationDatabaseHandler::getAvailableChannels());
        $form->setFormAction($this->ctrl->getFormAction($this, 'showChannels'));
        $form->addCommandButton('saveChannels', $this->lng->txt('save'));
        $form->addCommandButton('showChannels', $this->lng->txt('cancel'));
        $this->tpl->setContent($form->getHtml());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showConfigMatrixObject()

ilObjNotificationAdminGUI::showConfigMatrixObject

(

)

Definition at line 238 of file class.ilObjNotificationAdminGUI.php.

References $ilCtrl, ilObjectGUI\$lng, $table, $userdata, ilNotificationDatabaseHandler\getAvailableChannels(), ilNotificationDatabaseHandler\getAvailableTypes(), and ilNotificationDatabaseHandler\loadUserConfig().

Referenced by saveConfigMatrixObject().

    {
        global $ilTabs;

        $ilTabs->activateSubTab('notification_admin_matrix');

        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';
        require_once 'Services/Notifications/classes/class.ilNotificationSettingsTable.php';

        global $ilCtrl, $lng;

        $userdata = ilNotificationDatabaseHandler::loadUserConfig(-1);

        $table = new ilNotificationSettingsTable($this, 'a title', ilNotificationDatabaseHandler::getAvailableChannels(), $userdata, true);
        $table->setFormAction($ilCtrl->getFormAction($this, 'saveConfigMatrix'));
        $table->setData(ilNotificationDatabaseHandler::getAvailableTypes());
        $table->setDescription($lng->txt('notification_admin_matrix_settings_table_desc'));
        $table->addCommandButton('saveConfigMatrix', $lng->txt('save'));
        $table->addCommandButton('showConfigMatrix', $lng->txt('cancel'));

        $this->tpl->setContent($table->getHtml());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showGeneralSettingsObject()

ilObjNotificationAdminGUI::showGeneralSettingsObject

(

$form = null

)

Todo:

dirty...

push all notifiation settings to the form to enable custom settings per channel

Definition at line 131 of file class.ilObjNotificationAdminGUI.php.

References $form, ilObjectGUI\$settings, and ilNotificationAdminSettingsForm\getGeneralSettingsForm().

Referenced by saveGeneralSettingsObject().

    {
        require_once 'Services/Notifications/classes/class.ilNotificationAdminSettingsForm.php';

        if ($form == null) {
            $form = ilNotificationAdminSettingsForm::getGeneralSettingsForm();
            $settings = new ilSetting('notifications');

            $form->setValuesByArray(array_merge($settings->getAll(), $form->restored_values));
        }

        $form->setFormAction($this->ctrl->getFormAction($this, 'saveGeneralSettings'));
        $form->addCommandButton('saveGeneralSettings', 'save');
        $form->addCommandButton('showGeneralSettings', 'cancel');

        $this->tpl->setContent($form->getHtml());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showTypesObject()

ilObjNotificationAdminGUI::showTypesObject

(

)

Definition at line 188 of file class.ilObjNotificationAdminGUI.php.

References $form, ilNotificationDatabaseHandler\getAvailableTypes(), and ilNotificationAdminSettingsForm\getTypeForm().

Referenced by saveTypesObject().

    {
        global $ilTabs;
            
        $ilTabs->activateSubTab('notification_admin_types');

        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';
        require_once 'Services/Notifications/classes/class.ilNotificationAdminSettingsForm.php';
            
        $form = ilNotificationAdminSettingsForm::getTypeForm(ilNotificationDatabaseHandler::getAvailableTypes());
        $form->setFormAction($this->ctrl->getFormAction($this, 'showTypes'));
        $form->addCommandButton('saveTypes', $this->lng->txt('save'));
        $form->addCommandButton('showTypes', $this->lng->txt('cancel'));
        $this->tpl->setContent($form->getHtml());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/Notifications/classes/class.ilObjNotificationAdminGUI.php