ilMembershipAdministrationGUI Class Reference

Membership Administration Settings. More...

Inheritance diagram for ilMembershipAdministrationGUI:

Collaboration diagram for ilMembershipAdministrationGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	executeCommand ()
	execute command More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	editSettings (ilPropertyFormGUI $a_form=null)
	saveSettings ()
	addToExternalSettingsForm ($a_form_id)
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 @access 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 ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	@inheritDoc More...
	removeFromDeskObject ()
	@inheritDoc More...
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
const	SUB_TAB_GENERAL_SETTINGS = 'settings'
const	SUB_TAB_PRINT_VIEW = 'print_view'
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
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
	getType ()
	getParentObjType ()
	getAdministrationFormId ()
	addChildContentsTo ($form)
	saveChildSettings ($form)
	getChildSettingsInfo ($a_form_id)
	initFormSettings ()
	addFieldsToForm (ilPropertyFormGUI $a_form)
	save (ilPropertyFormGUI $a_form)
	setSubTabs ($a_main_tab, $a_active_tab)
	Set sub tabs. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	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...
	setTabs ()
	set admin tabs @access public More...
	setAdminTabs ()
	set admin tabs @access 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...

Additional Inherited Members
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...
Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites
	$request

Detailed Description

Membership Administration Settings.

Author

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

Version

$Id:$

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

Constructor & Destructor Documentation

__construct()

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

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

    {
        $this->type = $this->getType();
 
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
 
        $this->lng->loadLanguageModule("grp");
        $this->lng->loadLanguageModule('mem');
    }

References ILIAS\GlobalScreen\Provider\__construct(), and getType().

Here is the call graph for this function:

Member Function Documentation

addChildContentsTo()

ilMembershipAdministrationGUI::addChildContentsTo (   $form )

abstractprotected

Parameters

ilPropertyFormGUI

$form

Returns

ilPropertyFormGUI

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by initFormSettings().

Here is the caller graph for this function:

addFieldsToForm()

ilMembershipAdministrationGUI::addFieldsToForm ( ilPropertyFormGUI  $a_form )

protected

Definition at line 225 of file class.ilMembershipAdministrationGUI.php.

    {
    }

Referenced by initFormSettings().

Here is the caller graph for this function:

addToExternalSettingsForm()

ilMembershipAdministrationGUI::addToExternalSettingsForm

(

$a_form_id

)

Definition at line 208 of file class.ilMembershipAdministrationGUI.php.

    {
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_MAIL:
                
                $this->lng->loadLanguageModule("mail");
                
                $fields = array(
                    'mail_enable_' . $this->getParentObjType() . '_member_notification' => array($this->settings->get('mail_' . $this->getParentObjType() . '_member_notification', true), ilAdministrationSettingsFormHandler::VALUE_BOOL),
                    'mail_enable_' . $this->getParentObjType() . '_admin_notification' => array($this->settings->get('mail_' . $this->getParentObjType() . '_admin_notification', true), ilAdministrationSettingsFormHandler::VALUE_BOOL)
                );
 
                return array(array("editSettings", $fields));
        }
        return $this->getChildSettingsInfo($a_form_id);
    }

References ilAdministrationSettingsFormHandler\FORM_MAIL, getChildSettingsInfo(), getParentObjType(), settings(), and ilAdministrationSettingsFormHandler\VALUE_BOOL.

Here is the call graph for this function:

editSettings()

ilMembershipAdministrationGUI::editSettings

(

ilPropertyFormGUI

$a_form = null

)

Definition at line 123 of file class.ilMembershipAdministrationGUI.php.

    {
        $this->setSubTabs('settings', self::SUB_TAB_GENERAL_SETTINGS);
        $this->tabs_gui->setTabActive('settings');
                
        if (!$a_form) {
            $a_form = $this->initFormSettings();
        }
        $this->tpl->setContent($a_form->getHTML());
        return true;
    }

References initFormSettings(), and setSubTabs().

Referenced by saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilMembershipAdministrationGUI::executeCommand

(

)

execute command

Reimplemented from ilObjectGUI.

Definition at line 53 of file class.ilMembershipAdministrationGUI.php.

    {
        global $DIC;
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        if (!$DIC->rbac()->system()->checkAccess("visible,read", $this->object->getRefId())) {
            $DIC['ilErr']->raiseError($this->lng->txt("no_permission"), $DIC['ilErr']->WARNING);
        }
 
        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive("perm_settings");
                include_once "Services/AccessControl/classes/class.ilPermissionGUI.php";
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            
            case 'ilmemberexportsettingsgui':
                $this->setSubTabs('settings', self::SUB_TAB_PRINT_VIEW);
                include_once './Services/Membership/classes/Export/class.ilMemberExportSettingsGUI.php';
                $settings_gui = new ilMemberExportSettingsGUI($this->getParentObjType());
                $this->ctrl->forwardCommand($settings_gui);
                break;
 
            case 'iluseractionadmingui':
                include_once("./Services/User/Actions/classes/class.ilUserActionAdminGUI.php");
                include_once("./Services/User/Gallery/classes/class.ilGalleryUserActionContext.php");
                $gui = new ilUserActionAdminGUI();
                $gui->setActionContext(new ilGalleryUserActionContext());
                $this->setSubTabs('settings', "actions");
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                if (!$cmd || $cmd == "view") {
                    $cmd = "editSettings";
                }
                $this->$cmd();
                break;
        }
        return true;
    }

References $DIC, getParentObjType(), ilObjectGUI\prepareOutput(), and setSubTabs().

Here is the call graph for this function:

getAdministrationFormId()

ilMembershipAdministrationGUI::getAdministrationFormId ( )

abstractprotected

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by initFormSettings().

Here is the caller graph for this function:

getAdminTabs()

ilMembershipAdministrationGUI::getAdminTabs

(

)

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 99 of file class.ilMembershipAdministrationGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "settings",
                $this->ctrl->getLinkTarget($this, "editSettings"),
                array("editSettings", "view")
            );
        }
 
        if ($rbacsystem->checkAccess("edit_permission", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"),
                array(),
                "ilpermissiongui"
            );
        }
    }

References $DIC, and ilObjectGUI\$rbacsystem.

getChildSettingsInfo()

ilMembershipAdministrationGUI::getChildSettingsInfo (   $a_form_id )

abstractprotected

Parameters

int

$a_form_id

Returns

null|array

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by addToExternalSettingsForm().

Here is the caller graph for this function:

getParentObjType()

ilMembershipAdministrationGUI::getParentObjType ( )

abstractprotected

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by addToExternalSettingsForm(), executeCommand(), and saveSettings().

Here is the caller graph for this function:

getType()

ilMembershipAdministrationGUI::getType ( )

abstractprotected

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by __construct().

Here is the caller graph for this function:

initFormSettings()

ilMembershipAdministrationGUI::initFormSettings ( )

protected

Definition at line 163 of file class.ilMembershipAdministrationGUI.php.

    {
        global $DIC;
 
        
        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "saveSettings"));
        $form->setTitle($this->lng->txt("settings"));
                
        $this->addFieldsToForm($form);
                
        $this->lng->loadLanguageModule("mail");
 
 
        ilAdministrationSettingsFormHandler::addFieldsToForm(
            $this->getAdministrationFormId(),
            $form,
            $this
        );
 
        $sec = new ilFormSectionHeaderGUI();
        $sec->setTitle($this->lng->txt('mail_notification_membership_section'));
        $form->addItem($sec);
 
        // member notification
        $cn = new ilCheckboxInputGUI($this->lng->txt('mail_enable_' . $this->getParentObjType() . '_member_notification'), 'mail_member_notification');
        $cn->setInfo($this->lng->txt('mail_enable_' . $this->getParentObjType() . '_member_notification_info'));
        $cn->setChecked($this->settings->get('mail_' . $this->getParentObjType() . '_member_notification', true));
        $form->addItem($cn);
 
        // default admin membership notification
        $an = new ilCheckboxInputGUI($this->lng->txt('mail_enable_' . $this->getParentObjType() . '_admin_notification'), 'mail_admin_notification');
        $an->setInfo($this->lng->txt('mail_enable_' . $this->getParentObjType() . '_admin_notification_info'));
        $an->setChecked($this->settings->get('mail_' . $this->getParentObjType() . '_admin_notification', true));
        $form->addItem($an);
 
        if ($this->access->checkAccess("write", "", $this->object->getRefId())) {
            $form->addCommandButton("saveSettings", $this->lng->txt("save"));
            $form->addCommandButton("view", $this->lng->txt("cancel"));
        }
 
        return $this->addChildContentsTo($form);
    }

References $DIC, addChildContentsTo(), ilAdministrationSettingsFormHandler\addFieldsToForm(), addFieldsToForm(), getAdministrationFormId(), and settings().

Referenced by editSettings(), and saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilMembershipAdministrationGUI::save ( ilPropertyFormGUI  $a_form )

protected

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

    {
        return true;
    }

Referenced by saveSettings().

Here is the caller graph for this function:

saveChildSettings()

ilMembershipAdministrationGUI::saveChildSettings (   $form )

abstractprotected

Parameters

ilPropertyFormGUI

$form

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by saveSettings().

Here is the caller graph for this function:

saveSettings()

ilMembershipAdministrationGUI::saveSettings

(

)

Definition at line 135 of file class.ilMembershipAdministrationGUI.php.

    {
        $this->checkPermission("write");
        
        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            if ($this->save($form)) {
                $this->settings->set(
                    'mail_' . $this->getParentObjType() . '_member_notification',
                    (int) $form->getInput('mail_member_notification')
                );
 
                $this->settings->set(
                    'mail_' . $this->getParentObjType() . '_admin_notification',
                    (int) $form->getInput('mail_admin_notification')
                );
 
                $this->saveChildSettings($form);
 
                ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
                $this->ctrl->redirect($this, "editSettings");
            }
        }
        
        $form->setValuesByPost();
        $this->editSettings($form);
    }

References ilObjectGUI\checkPermission(), editSettings(), getParentObjType(), initFormSettings(), save(), saveChildSettings(), and settings().

Here is the call graph for this function:

setSubTabs()

ilMembershipAdministrationGUI::setSubTabs (   $a_main_tab,   $a_active_tab  )

protected

Set sub tabs.

Parameters

string	$main_tab
type	$a_active_tab

Definition at line 239 of file class.ilMembershipAdministrationGUI.php.

    {
        if ($a_main_tab == 'settings') {
            $GLOBALS['DIC']['ilTabs']->addSubTab(
                self::SUB_TAB_GENERAL_SETTINGS,
                $GLOBALS['DIC']['lng']->txt('mem_settings_tab_' . self::SUB_TAB_GENERAL_SETTINGS),
                $GLOBALS['DIC']['ilCtrl']->getLinkTarget($this, 'editSettings')
            );
            $GLOBALS['DIC']['ilTabs']->addSubTab(
                self::SUB_TAB_PRINT_VIEW,
                $GLOBALS['DIC']['lng']->txt('mem_settings_tab_' . self::SUB_TAB_PRINT_VIEW),
                $GLOBALS['DIC']['ilCtrl']->getLinkTargetByClass('ilMemberExportSettingsGUI', 'printViewSettings')
            );
            $GLOBALS['DIC']['ilTabs']->addSubTab(
                "actions",
                $GLOBALS['DIC']['lng']->txt("mmbr_gallery_user_actions"),
                $GLOBALS['DIC']['ilCtrl']->getLinkTargetByClass("iluseractionadmingui")
            );
 
            $GLOBALS['DIC']['ilTabs']->activateTab($a_main_tab);
            $GLOBALS['DIC']['ilTabs']->activateSubTab($a_active_tab);
        }
    }

References $GLOBALS.

Referenced by editSettings(), and executeCommand().

Here is the caller graph for this function:

Field Documentation

SUB_TAB_GENERAL_SETTINGS

const ilMembershipAdministrationGUI::SUB_TAB_GENERAL_SETTINGS = 'settings'

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

SUB_TAB_PRINT_VIEW

const ilMembershipAdministrationGUI::SUB_TAB_PRINT_VIEW = 'print_view'

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

---

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

• Services/Membership/classes/class.ilMembershipAdministrationGUI.php