ilObjForumAdministrationGUI Class Reference

Forum Administration Settings. More...

Inheritance diagram for ilObjForumAdministrationGUI:

Collaboration diagram for ilObjForumAdministrationGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor public. More...
	executeCommand ()
	getAdminTabs ()
	editSettings (ilPropertyFormGUI $form=null)
	saveSettings ()
	Save settings. More...
	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 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...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Protected Member Functions
	populateForm (ilPropertyFormGUI $form)
	getSettingsForm ()
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...
	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...

Private Attributes
	$rbac

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...
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 Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

Detailed Description

Forum Administration Settings.

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Version

$Id:$ ilObjForumAdministrationGUI: ilPermissionGUI ilObjForumAdministrationGUI: ilAdministrationGUI

Definition at line 13 of file class.ilObjForumAdministrationGUI.php.

Constructor & Destructor Documentation

__construct()

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

Contructor public.

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

References $DIC.

    {
        global $DIC;
        $this->rbac = $DIC->rbac();

        $this->type = 'frma';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $this->lng->loadLanguageModule('forum');
    }

Member Function Documentation

addToExternalSettingsForm()

ilObjForumAdministrationGUI::addToExternalSettingsForm

(

$a_form_id

)

Parameters

string

$a_form_id

Returns

array

Definition at line 237 of file class.ilObjForumAdministrationGUI.php.

References ilAdministrationSettingsFormHandler\FORM_ACCESSIBILITY, ilAdministrationSettingsFormHandler\FORM_PRIVACY, settings(), and ilAdministrationSettingsFormHandler\VALUE_BOOL.

    {
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_PRIVACY:

                $fields = array(
                    'enable_fora_statistics' => array($this->settings->get('enable_fora_statistics', false), ilAdministrationSettingsFormHandler::VALUE_BOOL),
                    'enable_anonymous_fora' => array($this->settings->get('enable_anonymous_fora', false), ilAdministrationSettingsFormHandler::VALUE_BOOL)
                );

                return array(array("editSettings", $fields));

            case ilAdministrationSettingsFormHandler::FORM_ACCESSIBILITY:
                $fields = array(
                    'adm_captcha_anonymous_short' => array(ilCaptchaUtil::isActiveForForum(), ilAdministrationSettingsFormHandler::VALUE_BOOL)
                );

                return array('obj_frma' => array('editSettings', $fields));
        }
    }

Here is the call graph for this function:

editSettings()

ilObjForumAdministrationGUI::editSettings

(

ilPropertyFormGUI

$form = null

)

Parameters

ilPropertyFormGUI

$form

Definition at line 84 of file class.ilObjForumAdministrationGUI.php.

References $form, getSettingsForm(), and populateForm().

Referenced by saveSettings().

    {
        $this->tabs_gui->activateTab('settings');

        if (!$form) {
            $form = $this->getSettingsForm();
            $this->populateForm($form);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjForumAdministrationGUI::executeCommand

(

)

Returns

bool

Definition at line 34 of file class.ilObjForumAdministrationGUI.php.

References ilObjectGUI\prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                break;

            default:
                if (!$cmd || $cmd == 'view') {
                    $cmd = 'editSettings';
                }

                $this->$cmd();
                break;
        }
        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjForumAdministrationGUI::getAdminTabs

(

)

Definition at line 61 of file class.ilObjForumAdministrationGUI.php.

    {
        if ($this->rbac->system()->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'settings',
                $this->ctrl->getLinkTarget($this, 'editSettings'),
                array('editSettings', 'view')
            );
        }

        if ($this->rbac->system()->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm'),
                array(),
                'ilpermissiongui'
            );
        }
    }

getSettingsForm()

ilObjForumAdministrationGUI::getSettingsForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 156 of file class.ilObjForumAdministrationGUI.php.

References $form, ilAdministrationSettingsFormHandler\addFieldsToForm(), ilRadioGroupInputGUI\addOption(), ilNumberInputGUI\allowDecimals(), ilCaptchaUtil\checkFreetype(), ilObjectGUI\checkPermissionBool(), ilForumProperties\FILE_UPLOAD_GLOBALLY_ALLOWED, ilForumProperties\FILE_UPLOAD_INDIVIDUAL, ilAdministrationSettingsFormHandler\FORM_FORUM, ilCronManager\isJobActive(), and ilFormPropertyGUI\setInfo().

Referenced by editSettings(), and saveSettings().

    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveSettings'));
        $form->setTitle($this->lng->txt('settings'));

        $frm_radio = new ilRadioGroupInputGUI($this->lng->txt('frm_displayed_infos'), 'forum_overview');
        $frm_radio->addOption(new ilRadioOption($this->lng->txt('new') . ', ' . $this->lng->txt('is_read') . ', ' . $this->lng->txt('unread'), '0'));
        $frm_radio->addOption(new ilRadioOption($this->lng->txt('is_read') . ', ' . $this->lng->txt('unread'), '1'));
        $frm_radio->setInfo($this->lng->txt('frm_disp_info_desc'));
        $form->addItem($frm_radio);

        $check = new ilCheckboxInputGui($this->lng->txt('enable_fora_statistics'), 'fora_statistics');
        $check->setInfo($this->lng->txt('enable_fora_statistics_desc'));
        $form->addItem($check);

        $check = new ilCheckboxInputGui($this->lng->txt('enable_anonymous_fora'), 'anonymous_fora');
        $check->setInfo($this->lng->txt('enable_anonymous_fora_desc'));
        $form->addItem($check);

        $file_upload = new ilRadioGroupInputGUI($this->lng->txt('file_upload_allowed_fora'), 'file_upload_allowed_fora');
        $file_upload->addOption(new ilRadioOption($this->lng->txt('file_upload_option_allow'), ilForumProperties::FILE_UPLOAD_GLOBALLY_ALLOWED));
        $file_upload->addOption(new ilRadioOption($this->lng->txt('file_upload_option_disallow'), ilForumProperties::FILE_UPLOAD_INDIVIDUAL));
        $file_upload->setInfo($this->lng->txt('file_upload_allowed_fora_desc'));
        $form->addItem($file_upload);

        if (ilCronManager::isJobActive('frm_notification')) {
            ilAdministrationSettingsFormHandler::addFieldsToForm(
                ilAdministrationSettingsFormHandler::FORM_FORUM,
                $form,
                $this
            );
        } else {
            $notifications = new ilCheckboxInputGui($this->lng->txt('cron_forum_notification'), 'forum_notification');
            $notifications->setInfo($this->lng->txt('cron_forum_notification_desc'));
            $notifications->setValue(1);
            $form->addItem($notifications);
        }

        $check = new ilCheckboxInputGui($this->lng->txt('enable_send_attachments'), 'send_attachments_by_mail');
        $check->setInfo($this->lng->txt('enable_send_attachments_desc'));
        $check->setValue(1);
        $form->addItem($check);

        $cap = new ilCheckboxInputGUI($this->lng->txt('adm_captcha_anonymous_short'), 'activate_captcha_anonym');
        $cap->setInfo($this->lng->txt('adm_captcha_anonymous_frm'));
        $cap->setValue(1);
        if (!ilCaptchaUtil::checkFreetype()) {
            $cap->setAlert(ilCaptchaUtil::getPreconditionsMessage());
        }
        $form->addItem($cap);

        $drafts = new ilCheckboxInputGUI($this->lng->txt('adm_save_drafts'), 'save_post_drafts');
        $drafts->setInfo($this->lng->txt('adm_save_drafts_desc'));
        $drafts->setValue(1);

        $autosave_drafts = new ilCheckboxInputGUI($this->lng->txt('adm_autosave_drafts'), 'autosave_drafts');
        $autosave_drafts->setInfo($this->lng->txt('adm_autosave_drafts_desc'));
        $autosave_drafts->setValue(1);

        $autosave_interval = new ilNumberInputGUI($this->lng->txt('adm_autosave_ival'), 'autosave_drafts_ival');
        $autosave_interval->allowDecimals(false);
        $autosave_interval->setMinValue(30);
        $autosave_interval->setMaxValue(60 * 60);
        $autosave_interval->setSize(10);
        $autosave_interval->setSuffix($this->lng->txt('seconds'));
        $autosave_drafts->addSubItem($autosave_interval);
        $drafts->addSubItem($autosave_drafts);
        $form->addItem($drafts);

        if ($this->checkPermissionBool("write")) {
            $form->addCommandButton('saveSettings', $this->lng->txt('save'));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateForm()

ilObjForumAdministrationGUI::populateForm ( ilPropertyFormGUI  $form )

protected

Parameters

ilPropertyFormGUI

$form

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

References ilForumProperties\FILE_UPLOAD_GLOBALLY_ALLOWED, settings(), and ilPropertyFormGUI\setValuesByArray().

Referenced by editSettings().

    {
        $frma_set = new ilSetting('frma');

        $form->setValuesByArray(array(
            'forum_overview' => (bool) $frma_set->get('forum_overview', false),
            'fora_statistics' => (bool) $this->settings->get('enable_fora_statistics', false),
            'anonymous_fora' => (bool) $this->settings->get('enable_anonymous_fora', false),
            'forum_notification' => (int) $this->settings->get('forum_notification') === 1 ? true : false,
            'activate_captcha_anonym' => ilCaptchaUtil::isActiveForForum(),
            'file_upload_allowed_fora' => (int) $this->settings->get('file_upload_allowed_fora', ilForumProperties::FILE_UPLOAD_GLOBALLY_ALLOWED),
            'save_post_drafts' => (int) $this->settings->get('save_post_drafts', 0),
            'autosave_drafts' => (int) $this->settings->get('autosave_drafts', 0),
            'autosave_drafts_ival' => (int) $this->settings->get('autosave_drafts_ival', 30),
            'send_attachments_by_mail' => (bool) $this->settings->get('send_attachments_by_mail', false)
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveSettings()

ilObjForumAdministrationGUI::saveSettings

(

)

Save settings.

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

References $form, ilObjectGUI\checkPermission(), editSettings(), getSettingsForm(), ilCronManager\isJobActive(), and settings().

    {
        $this->checkPermission("write");

        $form = $this->getSettingsForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->editSettings($form);
            return;
        }

        $frma_set = new ilSetting('frma');
        $frma_set->set('forum_overview', $form->getInput('forum_overview'));
        $this->settings->set('file_upload_allowed_fora', (int) $form->getInput('file_upload_allowed_fora'));
        $this->settings->set('send_attachments_by_mail', (int) $form->getInput('send_attachments_by_mail'));
        $this->settings->set('enable_fora_statistics', (int) $form->getInput('fora_statistics'));
        $this->settings->set('enable_anonymous_fora', (int) $form->getInput('anonymous_fora'));

        if (!ilCronManager::isJobActive('frm_notification')) {
            $this->settings->set('forum_notification', (int) $form->getInput('forum_notification'));
        }

        ilCaptchaUtil::setActiveForForum((bool) $form->getInput('activate_captcha_anonym'));

        $this->settings->set('save_post_drafts', (int) $form->getInput('save_post_drafts'));
        $this->settings->set('autosave_drafts', (int) $form->getInput('autosave_drafts'));
        $this->settings->set('autosave_drafts_ival', (int) $form->getInput('autosave_drafts_ival'));
        
        ilUtil::sendSuccess($this->lng->txt('settings_saved'));
        $form->setValuesByPost();
        $this->editSettings($form);
    }

Here is the call graph for this function:

Field Documentation

$rbac

ilObjForumAdministrationGUI::$rbac

private

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

---

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

• Modules/Forum/classes/class.ilObjForumAdministrationGUI.php