ilObjectServiceSettingsGUI Class Reference

GUI class for service settings (calendar, notes, comments) More...

Collaboration diagram for ilObjectServiceSettingsGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_obj_id, $a_modes)
	Constructor. More...
	executeCommand ()
	Control class handling. More...
	getModes ()
	Get active modes. More...
	getObjId ()
	Get obj id. More...

Static Public Member Functions
static	initServiceSettingsForm ($a_obj_id, ilPropertyFormGUI $form, $services)
	Init service settings form. More...
static	updateServiceSettingsForm ($a_obj_id, ilPropertyFormGUI $form, $services)
	Update service settings. More...

Data Fields
const	CALENDAR_VISIBILITY = 'cont_show_calendar'
const	NEWS_VISIBILITY = 'cont_show_news'
const	USE_NEWS = 'cont_use_news'
const	AUTO_RATING_NEW_OBJECTS = 'cont_auto_rate_new_obj'
const	INFO_TAB_VISIBILITY = 'cont_show_info_tab'
const	TAXONOMIES = 'cont_taxonomies'
const	TAG_CLOUD = 'cont_tag_cloud'
const	CUSTOM_METADATA = 'cont_custom_md'
const	BADGES = 'cont_badges'

Protected Member Functions
	cancel ()
	editSettings (ilPropertyFormGUI $form=null)
	Edit tool settings (calendar, news, comments, ...) More...
	updateToolSettings ()
	Update settings. More...
	isModeActive ($a_mode)
	Check if specific mode is active. More...

Private Attributes
	$gui = null
	$modes = array()
	$obj_id = 0

Detailed Description

GUI class for service settings (calendar, notes, comments)

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

@ilCtrl_Calls ilObjectServiceSettingsGUI:

Definition at line 14 of file class.ilObjectServiceSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjectServiceSettingsGUI::__construct	(		$a_parent_gui,
			$a_obj_id,
			$a_modes
	)

Constructor.

Parameters

type

$a_parent_gui

Definition at line 39 of file class.ilObjectServiceSettingsGUI.php.

        {
                $this->gui = $a_parent_gui;
                $this->modes = $a_modes;
                $this->obj_id = $a_obj_id;
        }

Member Function Documentation

cancel()

ilObjectServiceSettingsGUI::cancel ( )

protected

Definition at line 346 of file class.ilObjectServiceSettingsGUI.php.

        {
                $GLOBALS['ilCtrl']->returnToParent($this);
        }

References $GLOBALS.

editSettings()

ilObjectServiceSettingsGUI::editSettings ( ilPropertyFormGUI  $form = null )

protected

Edit tool settings (calendar, news, comments, ...)

Parameters

ilPropertyFormGUI

$form

Definition at line 355 of file class.ilObjectServiceSettingsGUI.php.

        {
                if(!$form instanceof ilPropertyFormGUI)
                {
                        $form = $this->initSettingsForm();
                }
                $GLOBALS['tpl']->setContent($form->getHTML());
        }

References $GLOBALS.

Referenced by updateToolSettings().

Here is the caller graph for this function:

executeCommand()

ilObjectServiceSettingsGUI::executeCommand

(

)

Control class handling.

Returns

Definition at line 52 of file class.ilObjectServiceSettingsGUI.php.

        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd('editSettings');
                
                switch($next_class)
                {
                        default:
                                $this->$cmd();
                                break;
                }
        }

References $cmd, and $ilCtrl.

getModes()

ilObjectServiceSettingsGUI::getModes

(

)

Get active modes.

Returns

bool

Definition at line 332 of file class.ilObjectServiceSettingsGUI.php.

        {
                return $this->modes;
        }

References $modes.

Referenced by isModeActive().

Here is the caller graph for this function:

getObjId()

ilObjectServiceSettingsGUI::getObjId

(

)

Get obj id.

Returns

type

Definition at line 341 of file class.ilObjectServiceSettingsGUI.php.

        {
                return $this->obj_id;
        }

References $obj_id.

Referenced by updateToolSettings().

Here is the caller graph for this function:

initServiceSettingsForm()

static ilObjectServiceSettingsGUI::initServiceSettingsForm (   $a_obj_id, ilPropertyFormGUI  $form,   $services  )

static

Init service settings form.

Parameters

ilPropertyFormGUI	$form
type	$services

Definition at line 72 of file class.ilObjectServiceSettingsGUI.php.

        {
                global $ilSetting, $ilCtrl;
                
                // info tab
                if(in_array(self::INFO_TAB_VISIBILITY, $services))
                {
                        $info = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_info_tab'), self::INFO_TAB_VISIBILITY);
                        $info->setValue(1);
                        $info->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::INFO_TAB_VISIBILITY,
                                                true
                                ));
                        //$info->setOptionTitle($GLOBALS['lng']->txt('obj_tool_setting_info_tab'));
                        $info->setInfo($GLOBALS['lng']->txt('obj_tool_setting_info_tab_info'));
                        $form->addItem($info);
                }
                
                // calendar
                if(in_array(self::CALENDAR_VISIBILITY, $services))
                {
                        include_once './Services/Calendar/classes/class.ilObjCalendarSettings.php';
                        if(ilCalendarSettings::_getInstance()->isEnabled())
                        {
                                // Container tools (calendar, news, ... activation)
                                $cal = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_calendar'), self::CALENDAR_VISIBILITY);
                                $cal->setValue(1);
                                include_once './Services/Calendar/classes/class.ilObjCalendarSettings.php';
                                $cal->setChecked(ilCalendarSettings::lookupCalendarActivated($a_obj_id));
                                //$cal->setOptionTitle($GLOBALS['lng']->txt('obj_tool_setting_calendar'));
                                $cal->setInfo($GLOBALS['lng']->txt('obj_tool_setting_calendar_info'));
                                $form->addItem($cal);
                        }
                }
                
                // news
                if(in_array(self::USE_NEWS, $services))
                {
                        $news = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_use_news'), self::USE_NEWS);
                        $news->setValue(1);
                        $checked = ilContainer::_lookupContainerSetting(
                                $a_obj_id,
                                self::USE_NEWS,
                                true
                        );
                        $news->setChecked($checked);
                        $info = $GLOBALS['lng']->txt('obj_tool_setting_use_news_info');
                        if ($checked)
                        {
                                $info.=" <a href='".$ilCtrl->getLinkTargetByClass("ilcontainernewssettingsgui", "").
                                        "'>» ".$GLOBALS['lng']->txt('obj_tool_setting_use_news_open_settings')."</a>";
                        }
                        $news->setInfo($info);
                        $form->addItem($news);
 
                }
                if(in_array(self::NEWS_VISIBILITY, $services))
                {
                        if($ilSetting->get('block_activated_news'))
                        {
                                // Container tools (calendar, news, ... activation)
                                $news = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_news'), self::NEWS_VISIBILITY);
                                $news->setValue(1);
                                $news->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::NEWS_VISIBILITY,
                                                $ilSetting->get('block_activated_news',true)
                                ));
                                //$news->setOptionTitle($GLOBALS['lng']->txt('obj_tool_setting_news'));
                                $news->setInfo($GLOBALS['lng']->txt('obj_tool_setting_news_info'));
                                $form->addItem($news);
                                
                                if(in_array(ilObject::_lookupType($a_obj_id), array('crs', 'grp')))
                                {                                       
                                        $ref_id = array_pop(ilObject::_getAllReferences($a_obj_id));
                                        
                                        include_once 'Services/Membership/classes/class.ilMembershipNotifications.php';
                                        ilMembershipNotifications::addToSettingsForm($ref_id, null, $news);
                                }
                        }
                }
                
                // (local) custom metadata
                if(in_array(self::CUSTOM_METADATA, $services))
                {                                               
                        $md = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_custom_metadata'), self::CUSTOM_METADATA);
                        $md->setInfo($GLOBALS['lng']->txt('obj_tool_setting_custom_metadata_info'));
                        $md->setValue(1);               
                        $md->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::CUSTOM_METADATA,
                                                false
                                ));
                        $form->addItem($md);                                                                    
                }               
                                
                // tag cloud
                if(in_array(self::TAG_CLOUD, $services))
                {                       
                        $tags_active = new ilSetting("tags");
                        if($tags_active->get("enable", false))
                        {
                                $tag = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_tag_cloud'), self::TAG_CLOUD);
                                $tag->setInfo($GLOBALS['lng']->txt('obj_tool_setting_tag_cloud_info'));
                                $tag->setValue(1);              
                                $tag->setChecked(ilContainer::_lookupContainerSetting(
                                                        $a_obj_id,
                                                        self::TAG_CLOUD,
                                                        false
                                        ));
                                $form->addItem($tag);                                           
                        }                       
                }               
                
                // taxonomies
                if(in_array(self::TAXONOMIES, $services))
                {       
                        $tax = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_taxonomies'), self::TAXONOMIES);
                        $tax->setValue(1);              
                        $tax->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::TAXONOMIES,
                                                false
                                ));
                        $form->addItem($tax);                   
                }
                
                // auto rating
                if(in_array(self::AUTO_RATING_NEW_OBJECTS, $services))
                {                       
                        $GLOBALS['lng']->loadLanguageModule("rating");
                        
                        // auto rating for new objects
                        $rate = new ilCheckboxInputGUI($GLOBALS['lng']->txt('rating_new_objects_auto'), self::AUTO_RATING_NEW_OBJECTS);
                        $rate->setValue(1);
                        //$rate->setOptionTitle($GLOBALS['lng']->txt('rating_new_objects_auto'));
                        $rate->setInfo($GLOBALS['lng']->txt('rating_new_objects_auto_info'));
                        $rate->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::AUTO_RATING_NEW_OBJECTS,
                                                false
                                ));
                        $form->addItem($rate);                  
                }
                
                // badges
                if(in_array(self::BADGES, $services))
                {               
                        include_once 'Services/Badge/classes/class.ilBadgeHandler.php';
                        if(ilBadgeHandler::getInstance()->isActive())
                        {
                                $bdg = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_badges'), self::BADGES);
                                $bdg->setInfo($GLOBALS['lng']->txt('obj_tool_setting_badges_info'));
                                $bdg->setValue(1);              
                                $bdg->setChecked(ilContainer::_lookupContainerSetting(
                                                        $a_obj_id,
                                                        self::BADGES,
                                                        false
                                        ));
                                $form->addItem($bdg);           
                        }
                }               
                
                return $form;
        }

References $GLOBALS, $ilCtrl, $ilSetting, $info, $ref_id, ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilContainer\_lookupContainerSetting(), ilObject\_lookupType(), ilPropertyFormGUI\addItem(), ilMembershipNotifications\addToSettingsForm(), ilBadgeHandler\getInstance(), and ilCalendarSettings\lookupCalendarActivated().

Referenced by ilObjBookingPoolGUI\addExternalEditFormCustom(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjGlossaryGUI\initSettingsForm(), and ilObjWikiGUI\initSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

isModeActive()

ilObjectServiceSettingsGUI::isModeActive (   $a_mode )

protected

Check if specific mode is active.

Parameters

type

$a_mode

Returns

type

Definition at line 395 of file class.ilObjectServiceSettingsGUI.php.

        {
                return in_array($a_mode, $this->getModes());
        }

References getModes().

Referenced by updateToolSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

updateServiceSettingsForm()

static ilObjectServiceSettingsGUI::updateServiceSettingsForm (   $a_obj_id, ilPropertyFormGUI  $form,   $services  )

static

Update service settings.

Parameters

type	$a_obj_id
ilPropertyFormGUI	$form
type	$services

Definition at line 245 of file class.ilObjectServiceSettingsGUI.php.

        {
                // info
                if(in_array(self::INFO_TAB_VISIBILITY, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::INFO_TAB_VISIBILITY,(int) $form->getInput(self::INFO_TAB_VISIBILITY));
                }
                
                // calendar
                if(in_array(self::CALENDAR_VISIBILITY, $services))
                {
                        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
                        if(ilCalendarSettings::_getInstance()->isEnabled())
                        {
                                include_once './Services/Container/classes/class.ilContainer.php';
                                ilContainer::_writeContainerSetting($a_obj_id,self::CALENDAR_VISIBILITY,(int) $form->getInput(self::CALENDAR_VISIBILITY));
                        }
                }
                
                // news
                if(in_array(self::USE_NEWS, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::USE_NEWS,(int) $form->getInput(self::USE_NEWS));
                }
                if(in_array(self::NEWS_VISIBILITY, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::NEWS_VISIBILITY,(int) $form->getInput(self::NEWS_VISIBILITY));
                        
                        if(in_array(ilObject::_lookupType($a_obj_id), array('crs', 'grp')))
                        {                                       
                                $ref_id = array_pop(ilObject::_getAllReferences($a_obj_id));
                                        
                                include_once "Services/Membership/classes/class.ilMembershipNotifications.php";
                                ilMembershipNotifications::importFromForm($ref_id, $form);
                        }
                }
                
                // rating
                if(in_array(self::AUTO_RATING_NEW_OBJECTS, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::AUTO_RATING_NEW_OBJECTS,(int) $form->getInput(self::AUTO_RATING_NEW_OBJECTS));
                }
                
                // taxonomies
                if(in_array(self::TAXONOMIES, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::TAXONOMIES,(int) $form->getInput(self::TAXONOMIES));
                }
                
                // tag cloud
                if(in_array(self::TAG_CLOUD, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::TAG_CLOUD,(int) $form->getInput(self::TAG_CLOUD));
                }
                
                // (local) custom metadata
                if(in_array(self::CUSTOM_METADATA, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::CUSTOM_METADATA,(int) $form->getInput(self::CUSTOM_METADATA));
                }
                
                // badges
                if(in_array(self::BADGES, $services))
                {
                        include_once 'Services/Badge/classes/class.ilBadgeHandler.php';
                        if(ilBadgeHandler::getInstance()->isActive())
                        {
                                include_once './Services/Container/classes/class.ilContainer.php';
                                ilContainer::_writeContainerSetting($a_obj_id,self::BADGES,(int) $form->getInput(self::BADGES));
                        }
                }
                
                return true;
        }

References $ref_id, ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilObject\_lookupType(), ilContainer\_writeContainerSetting(), ilPropertyFormGUI\getInput(), ilBadgeHandler\getInstance(), and ilMembershipNotifications\importFromForm().

Referenced by ilObjGlossaryGUI\saveProperties(), ilObjWikiGUI\saveSettingsObject(), ilObjBookingPoolGUI\updateCustom(), ilObjCategoryGUI\updateObject(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

updateToolSettings()

ilObjectServiceSettingsGUI::updateToolSettings ( )

protected

Update settings.

Definition at line 368 of file class.ilObjectServiceSettingsGUI.php.

        {
                $form = $this->initSettingsForm();
                if($form->checkInput())
                {
                        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
                        if(ilCalendarSettings::_getInstance()->isEnabled())
                        {
                                if($this->isModeActive(self::CALENDAR_VISIBILITY))
                                {
                                        ilContainer::_writeContainerSetting($this->getObjId(),'show_calendar',(int) $form->getInput('calendar'));
                                }
                        }
                        ilUtil::sendSuccess($GLOBALS['lng']->txt('settings_saved'),true);
                        $GLOBALS['ilCtrl']->redirect($this);
                }
                
                ilUtil::sendFailure($GLOBALS['lng']->txt('err_check_input'));
                $form->setValuesByPost();
                $this->editSettings($form);
        }

References $GLOBALS, ilCalendarSettings\_getInstance(), ilContainer\_writeContainerSetting(), editSettings(), getObjId(), isModeActive(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

Field Documentation

$gui

ilObjectServiceSettingsGUI::$gui = null

private

Definition at line 31 of file class.ilObjectServiceSettingsGUI.php.

$modes

ilObjectServiceSettingsGUI::$modes = array()

private

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

Referenced by getModes().

$obj_id

ilObjectServiceSettingsGUI::$obj_id = 0

private

Definition at line 33 of file class.ilObjectServiceSettingsGUI.php.

Referenced by getObjId().

AUTO_RATING_NEW_OBJECTS

const ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS = 'cont_auto_rate_new_obj'

Definition at line 24 of file class.ilObjectServiceSettingsGUI.php.

Referenced by ilObject\hasAutoRating(), ilObjectDataSet\importRecord(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjectDataSet\readData(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

BADGES

const ilObjectServiceSettingsGUI::BADGES = 'cont_badges'

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

Referenced by ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilBadgeHandler\isObjectActive(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

CALENDAR_VISIBILITY

const ilObjectServiceSettingsGUI::CALENDAR_VISIBILITY = 'cont_show_calendar'

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

Referenced by ilObjCourseGUI\executeCommand(), ilObjGroupGUI\executeCommand(), ilObjectDataSet\importRecord(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjectDataSet\readData(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

CUSTOM_METADATA

const ilObjectServiceSettingsGUI::CUSTOM_METADATA = 'cont_custom_md'

Definition at line 28 of file class.ilObjectServiceSettingsGUI.php.

Referenced by ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilObjBookingPoolGUI\addExternalEditFormCustom(), ilObjectMetaDataGUI\hasAdvancedMDSettings(), ilObjectDataSet\importRecord(), ilAdvancedMetaDataImporter\importXmlRepresentation(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGlossaryGUI\initSettingsForm(), ilObjWikiGUI\initSettingsForm(), ilObjectDataSet\readData(), ilObjGlossaryGUI\saveProperties(), ilObjWikiGUI\saveSettingsObject(), ilObjBookingPoolGUI\updateCustom(), ilObjCategoryGUI\updateObject(), and ilObjCourseGUI\updateObject().

INFO_TAB_VISIBILITY

const ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY = 'cont_show_info_tab'

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

Referenced by ilObjCategoryGUI\__construct(), ilObjCategoryListGUI\getInfoScreenStatus(), ilObjectDataSet\importRecord(), ilObjCategoryGUI\initEditForm(), ilObjectListGUI\insertCommands(), ilObjectDataSet\readData(), and ilObjCategoryGUI\updateObject().

NEWS_VISIBILITY

const ilObjectServiceSettingsGUI::NEWS_VISIBILITY = 'cont_show_news'

Definition at line 22 of file class.ilObjectServiceSettingsGUI.php.

Referenced by ilContainer\create(), ilObjectDataSet\importRecord(), ilObjCategoryGUI\initEditForm(), ilContainerNewsSettingsGUI\initForm(), ilContainer\readContainerSettings(), ilObjectDataSet\readData(), ilContainerNewsSettingsGUI\save(), ilContainer\update(), and ilObjCategoryGUI\updateObject().

TAG_CLOUD

const ilObjectServiceSettingsGUI::TAG_CLOUD = 'cont_tag_cloud'

Definition at line 27 of file class.ilObjectServiceSettingsGUI.php.

Referenced by ilObjectDataSet\importRecord(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilTaggingClassificationProvider\isActive(), ilObjectDataSet\readData(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

TAXONOMIES

const ilObjectServiceSettingsGUI::TAXONOMIES = 'cont_taxonomies'

Definition at line 26 of file class.ilObjectServiceSettingsGUI.php.

Referenced by ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId(), ilObjTaxonomyAdministration\getRepositoryTaxonomies(), ilTaxMDGUI\getSelectableTaxonomies(), ilObjCategoryGUI\getTabs(), ilObjectDataSet\importRecord(), ilObjCategoryGUI\initEditForm(), ilObjectDataSet\readData(), and ilObjCategoryGUI\updateObject().

USE_NEWS

const ilObjectServiceSettingsGUI::USE_NEWS = 'cont_use_news'

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

Referenced by ilContainer\create(), ilObjectDataSet\importRecord(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilContainer\readContainerSettings(), ilObjectDataSet\readData(), ilContainer\update(), ilObjCourseGUI\updateObject(), and ilObjGroupGUI\updateObject().

---

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

• Services/Object/classes/class.ilObjectServiceSettingsGUI.php