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
	getAdminTabs ()
	editSettings (ilPropertyFormGUI $a_form=null)
	saveSettings ()
	addToExternalSettingsForm ($a_form_id)
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not)
	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
	getCreationMode ()
	get creation mode
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
	cancelDeleteObject ()
	cancel deletion of object
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	createObject ()
	create new object form
	cancelCreation ()
	cancel create action and go back to repository parent
	saveObject ()
	save object
	editObject ()
	edit object
	updateObject ()
	updates object entry in object_data
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object
	deleteObject ($a_error=false)
	Display deletion confirmation screen.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.

Protected Member Functions
	initFormSettings ()
	addFieldsToForm (ilPropertyFormGUI $a_form)
	save (ilPropertyFormGUI $a_form)
	getType ()
	getParentObjType ()
	getAdministrationFormId ()
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu.
	insertHeaderAction ($a_list_gui)
	Insert header action into main template.
	addHeaderAction ()
	Add header action menu.
	redrawHeaderActionObject ()
	Ajax call: redraw action header only.
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	setLocator ()
	set Locator
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded)
	initCreationForms ($a_new_type)
	Init creation froms.
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion)
	initCreateForm ($a_new_type)
	Init object creation form.
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types.
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates.
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen.
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position.
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook.
	initEditForm ()
	Init object edit form.
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form.
	getEditFormValues ()
	Get values for edit form.
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields.
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput())
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object.
	afterUpdate ()
	Post (successful) object update hook.
	initImportForm ($a_new_type)
	Init object import form.
	importFileObject ($parent_id=null)
	Import.
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook.
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g.
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g.
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste
	getTabs (&$tabs_gui)
	get tabs abstract method.
	__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
	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
	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.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error.
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission.
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files.
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting.

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root.
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root.
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$ilias
	$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

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

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

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

References getType(), and ilObjectGUI\ilObjectGUI().

        {
                $this->type = $this->getType();
                parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

                $this->lng->loadLanguageModule("grp");
        }

Here is the call graph for this function:

Member Function Documentation

ilMembershipAdministrationGUI::addFieldsToForm ( ilPropertyFormGUI  $a_form )

protected

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

Referenced by initFormSettings().

        {
                
        }

Here is the caller graph for this function:

ilMembershipAdministrationGUI::addToExternalSettingsForm

(

$a_form_id

)

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

References $ilSetting, ilAdministrationSettingsFormHandler\FORM_MAIL, getParentObjType(), and ilAdministrationSettingsFormHandler\VALUE_BOOL.

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

Here is the call graph for this function:

ilMembershipAdministrationGUI::editSettings

(

ilPropertyFormGUI

$a_form = null

)

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

References initFormSettings().

Referenced by saveSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilMembershipAdministrationGUI::executeCommand

(

)

execute command

Reimplemented from ilObjectGUI.

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

References $cmd, $ilErr, and ilObjectGUI\prepareOutput().

        {               
                global $ilAccess, $ilErr;
                
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();

                $this->prepareOutput();

                if(!$ilAccess->checkAccess("read", "", $this->object->getRefId()))
                {
                        $ilErr->raiseError($this->lng->txt("no_permission"), $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;

                        default:
                                if(!$cmd || $cmd == "view")
                                {
                                        $cmd = "editSettings";
                                }
                                $this->$cmd();
                                break;
                }
                return true;
        }

Here is the call graph for this function:

ilMembershipAdministrationGUI::getAdministrationFormId ( )

abstractprotected

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by initFormSettings().

Here is the caller graph for this function:

ilMembershipAdministrationGUI::getAdminTabs

(

)

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

        {
                global $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");
                }
        }

ilMembershipAdministrationGUI::getParentObjType ( )

abstractprotected

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by addToExternalSettingsForm(), and saveSettings().

Here is the caller graph for this function:

ilMembershipAdministrationGUI::getType ( )

abstractprotected

Reimplemented in ilObjCourseAdministrationGUI, and ilObjGroupAdministrationGUI.

Referenced by __construct().

Here is the caller graph for this function:

ilMembershipAdministrationGUI::initFormSettings ( )

protected

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

References $ilSetting, addFieldsToForm(), getAdministrationFormId(), and ilFormPropertyGUI\setInfo().

Referenced by editSettings(), and saveSettings().

        {           
                global $ilSetting;
                
                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");
        
                // 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($ilSetting->get('mail_'.$this->getParentObjType().'_member_notification', true));
                $form->addItem($cn);
                
                ilAdministrationSettingsFormHandler::addFieldsToForm(
                        $this->getAdministrationFormId(), 
                        $form,
                        $this
                );
                
                $form->addCommandButton("saveSettings", $this->lng->txt("save"));
                $form->addCommandButton("view", $this->lng->txt("cancel"));

                return $form;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMembershipAdministrationGUI::save ( ilPropertyFormGUI  $a_form )

protected

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

Referenced by saveSettings().

        {
                return true;    
        }

Here is the caller graph for this function:

ilMembershipAdministrationGUI::saveSettings

(

)

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

References $ilSetting, ilObjectGUI\checkPermission(), editSettings(), getParentObjType(), initFormSettings(), save(), and ilUtil\sendSuccess().

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

Here is the call graph for this function:

---

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

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