ilObjNewsSettingsGUI Class Reference

News Settings. More...

Inheritance diagram for ilObjNewsSettingsGUI:

Collaboration diagram for ilObjNewsSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor. More...
	executeCommand ()
	Execute command. More...
	getAdminTabs ()
	Get tabs. More...
	editSettings ()
	Edit news settings. More...
	saveSettings ()
	Save news and external webfeeds settings. More...
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 Attributes
	$rbacsystem
	$error
	$access
	$settings
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

Static Private Attributes
static	$ERROR_MESSAGE

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 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...

Detailed Description

News Settings.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilObjNewsSettingsGUI: ilPermissionGUI

Definition at line 16 of file class.ilObjNewsSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

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

Contructor.

public

Definition at line 44 of file class.ilObjNewsSettingsGUI.php.

References $DIC, and settings().

    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->error = $DIC["ilErr"];
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->type = 'nwss';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->lng->loadLanguageModule('news');
        $this->lng->loadLanguageModule('feed');
    }

Here is the call graph for this function:

Member Function Documentation

editSettings()

ilObjNewsSettingsGUI::editSettings

(

)

Edit news settings.

Definition at line 133 of file class.ilObjNewsSettingsGUI.php.

References $access, ilObjectGUI\$ctrl, $feed_set, $form, $ilCtrl, $ilSetting, ilObjectGUI\$lng, PHPMailer\PHPMailer\$options, $settings, $si, ilNewsItem\_lookupDefaultPDPeriod(), ilNewsItem\_lookupRSSPeriod(), ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), and ilCheckboxInputGUI\setValue().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $ilAccess = $this->access;
        
        $news_set = new ilSetting("news");
        $feed_set = new ilSetting("feed");
        
        $enable_internal_news = $ilSetting->get("block_activated_news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");
        $rss_title_format = $news_set->get("rss_title_format");
        $enable_private_feed = $news_set->get("enable_private_feed");
        $news_default_visibility = ($news_set->get("default_visibility") != "")
            ? $news_set->get("default_visibility")
            : "users";
        $disable_repository_feeds = $feed_set->get("disable_rep_feeds");
        $nr_personal_desktop_feeds = $ilSetting->get("block_limit_pdfeed");
        
        $allow_shorter_periods = $news_set->get("allow_shorter_periods");
        $allow_longer_periods = $news_set->get("allow_longer_periods");
    
        include_once("./Services/News/classes/class.ilNewsItem.php");
        $rss_period = ilNewsItem::_lookupRSSPeriod();
        
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        $form->setTitle($lng->txt("news_settings"));
        
        // Enable internal news
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("news_enable_internal_news"),
            "enable_internal_news"
        );
        $cb_prop->setValue("1");
        $cb_prop->setInfo($lng->txt("news_enable_internal_news_info"));
        $cb_prop->setChecked($enable_internal_news);
        $form->addItem($cb_prop);

        // Default Visibility
        $radio_group = new ilRadioGroupInputGUI($lng->txt("news_default_visibility"), "news_default_visibility");
        $radio_option = new ilRadioOption($lng->txt("news_visibility_users"), "users");
        $radio_group->addOption($radio_option);
        $radio_option = new ilRadioOption($lng->txt("news_visibility_public"), "public");
        $radio_group->addOption($radio_option);
        $radio_group->setInfo($lng->txt("news_news_item_visibility_info"));
        $radio_group->setRequired(false);
        $radio_group->setValue($news_default_visibility);
        $form->addItem($radio_group);

        // Number of news items per object
        $nr_opts = array(50 => 50, 100 => 100, 200 => 200);
        $nr_sel = new ilSelectInputGUI(
            $lng->txt("news_nr_of_items"),
            "news_max_items"
        );
        $nr_sel->setInfo($lng->txt("news_nr_of_items_info"));
        $nr_sel->setOptions($nr_opts);
        $nr_sel->setValue($news_set->get("max_items"));
        $form->addItem($nr_sel);

        // Access Cache
        $min_opts = array(0 => 0, 1 => 1, 2 => 2, 5 => 5, 10 => 10, 20 => 20, 30 => 30, 60 => 60);
        $min_sel = new ilSelectInputGUI(
            $lng->txt("news_cache"),
            "news_acc_cache_mins"
        );
        $min_sel->setInfo($lng->txt("news_cache_info"));
        $min_sel->setOptions($min_opts);
        $min_sel->setValue($news_set->get("acc_cache_mins"));
        $form->addItem($min_sel);
        
        // PD News Period
        $per_opts = array(
            2 => "2 " . $lng->txt("days"),
            3 => "3 " . $lng->txt("days"),
            5 => "5 " . $lng->txt("days"),
            7 => "1 " . $lng->txt("week"),
            14 => "2 " . $lng->txt("weeks"),
            30 => "1 " . $lng->txt("month"),
            60 => "2 " . $lng->txt("months"),
            120 => "4 " . $lng->txt("months"),
            180 => "6 " . $lng->txt("months"),
            366 => "1 " . $lng->txt("year"));
        $per_sel = new ilSelectInputGUI(
            $lng->txt("news_pd_period"),
            "news_pd_period"
        );
        $per_sel->setInfo($lng->txt("news_pd_period_info"));
        $per_sel->setOptions($per_opts);
        $per_sel->setValue((int) ilNewsItem::_lookupDefaultPDPeriod());
        $form->addItem($per_sel);

        // Allow user to choose lower values
        $sp_prop = new ilCheckboxInputGUI(
            $lng->txt("news_allow_shorter_periods"),
            "allow_shorter_periods"
        );
        $sp_prop->setValue("1");
        $sp_prop->setInfo($lng->txt("news_allow_shorter_periods_info"));
        $sp_prop->setChecked($allow_shorter_periods);
        $form->addItem($sp_prop);

        // Allow user to choose higher values
        $lp_prop = new ilCheckboxInputGUI(
            $lng->txt("news_allow_longer_periods"),
            "allow_longer_periods"
        );
        $lp_prop->setValue("1");
        $lp_prop->setInfo($lng->txt("news_allow_longer_periods_info"));
        $lp_prop->setChecked($allow_longer_periods);
        $form->addItem($lp_prop);

        // Enable rss for internal news
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("news_enable_internal_rss"),
            "enable_internal_rss"
        );
        $cb_prop->setValue("1");
        $cb_prop->setInfo($lng->txt("news_enable_internal_rss_info"));
        $cb_prop->setChecked($enable_internal_rss);

        // RSS News Period
        $rssp_opts = array(
            2 => "2 " . $lng->txt("days"),
            3 => "3 " . $lng->txt("days"),
            5 => "5 " . $lng->txt("days"),
            7 => "1 " . $lng->txt("week"),
            14 => "2 " . $lng->txt("weeks"),
            30 => "1 " . $lng->txt("month"),
            60 => "2 " . $lng->txt("months"),
            120 => "4 " . $lng->txt("months"),
            180 => "6 " . $lng->txt("months"),
            365 => "1 " . $lng->txt("year")
        );
        $rssp_sel = new ilSelectInputGUI(
            $lng->txt("news_rss_period"),
            "news_rss_period"
        );
        $rssp_sel->setOptions($rssp_opts);
        $rssp_sel->setValue((int) $rss_period);
        $cb_prop->addSubItem($rssp_sel);

        // Section Header: RSS
        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($lng->txt("news_rss"));
        $form->addItem($sh);

        // title format for rss entries
        $options = array(
            "" => $lng->txt("news_rss_title_format_obj_news"),
            "news_obj" => $lng->txt("news_rss_title_format_news_obj"),
        );
        $si = new ilSelectInputGUI($lng->txt("news_rss_title_format"), "rss_title_format");
        $si->setOptions($options);
        $si->setValue($rss_title_format);
        $cb_prop->addSubItem($si);

        $form->addItem($cb_prop);

        // Enable private news feed
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("news_enable_private_feed"),
            "enable_private_feed"
        );
        $cb_prop->setValue("1");
        $cb_prop->setInfo($lng->txt("news_enable_private_feed_info"));
        $cb_prop->setChecked($enable_private_feed);
        $form->addItem($cb_prop);


        // Section Header: External Web Feeds Settings
        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($lng->txt("feed_settings"));
        $form->addItem($sh);

        // Number of External Feeds on personal desktop
        $sel = new ilSelectInputGUI($lng->txt("feed_nr_pd_feeds"), "nr_pd_feeds");
        $sel->setInfo($lng->txt("feed_nr_pd_feeds_info"));
        $sel->setOptions(array(0 => "0",
            1 => "1",
            2 => "2",
            3 => "3",
            4 => "4",
            5 => "5"));
        $sel->setValue($nr_personal_desktop_feeds);
        $form->addItem($sel);

        // Disable External Web Feeds in catetegories
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("feed_disable_rep_feeds"),
            "disable_repository_feeds"
        );
        $cb_prop->setValue("1");
        $cb_prop->setInfo($lng->txt("feed_disable_rep_feeds_info"));
        $cb_prop->setChecked($disable_repository_feeds);
        $form->addItem($cb_prop);

        if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            // command buttons
            $form->addCommandButton("saveSettings", $lng->txt("save"));
            $form->addCommandButton("view", $lng->txt("cancel"));
        }

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

Here is the call graph for this function:

executeCommand()

ilObjNewsSettingsGUI::executeCommand

(

)

Execute command.

public

Definition at line 67 of file class.ilObjNewsSettingsGUI.php.

References $access, $error, ilObjectGUI\$ilErr, $rbacsystem, $ret, and ilObjectGUI\prepareOutput().

    {
        $rbacsystem = $this->rbacsystem;
        $ilErr = $this->error;
        $ilAccess = $this->access;

        $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);
                $ret = $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:

getAdminTabs()

ilObjNewsSettingsGUI::getAdminTabs

(

)

Get tabs.

public

Definition at line 107 of file class.ilObjNewsSettingsGUI.php.

References $access, and $rbacsystem.

    {
        $rbacsystem = $this->rbacsystem;
        $ilAccess = $this->access;

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "news_edit_news_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'
            );
        }
    }

saveSettings()

ilObjNewsSettingsGUI::saveSettings

(

)

Save news and external webfeeds settings.

Definition at line 345 of file class.ilObjNewsSettingsGUI.php.

References $_POST, $access, ilObjectGUI\$ctrl, $feed_set, $ilCtrl, $ilSetting, and $settings.

    {
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
        $ilAccess = $this->access;
        
        if (!$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $ilCtrl->redirect($this, "view");
        }
        
        // empty news cache
        include_once("./Services/News/classes/class.ilNewsCache.php");
        $this->acache = new ilNewsCache();
        $this->acache->deleteAllEntries();
        
        $news_set = new ilSetting("news");
        $feed_set = new ilSetting("feed");



        $ilSetting->set("block_activated_news", $_POST["enable_internal_news"]);
        $ilSetting->set("block_activated_pdnews", $_POST["enable_internal_news"]);
        $news_set->set("enable_rss_for_internal", $_POST["enable_internal_rss"]);
        $news_set->set("max_items", $_POST["news_max_items"]);
        $news_set->set("acc_cache_mins", $_POST["news_acc_cache_mins"]);
        $news_set->set("pd_period", $_POST["news_pd_period"]);
        $news_set->set("default_visibility", $_POST["news_default_visibility"]);
        $news_set->set("allow_shorter_periods", $_POST["allow_shorter_periods"]);
        $news_set->set("allow_longer_periods", $_POST["allow_longer_periods"]);
        $news_set->set("rss_period", $_POST["news_rss_period"]);
        $news_set->set("rss_title_format", $_POST["rss_title_format"]);
        
        $feed_set->set("disable_rep_feeds", $_POST["disable_repository_feeds"]);
        $ilSetting->set("block_limit_pdfeed", $_POST["nr_pd_feeds"]);
        if ($_POST["nr_pd_feeds"] > 0) {
            $ilSetting->set("block_activated_pdfeed", 1);
        } else {
            $ilSetting->set("block_activated_pdfeed", 0);
        }

        if ($_POST["enable_internal_rss"] != 0) {
            $news_set->set("enable_private_feed", $_POST["enable_private_feed"]);
        } else {
            $news_set->set("enable_private_feed", 0);
        }
        
        ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
        
        $ilCtrl->redirect($this, "view");
    }

Field Documentation

$access

ilObjNewsSettingsGUI::$access

protected

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

Referenced by editSettings(), executeCommand(), getAdminTabs(), and saveSettings().

$error

ilObjNewsSettingsGUI::$error

protected

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

Referenced by executeCommand().

$ERROR_MESSAGE

ilObjNewsSettingsGUI::$ERROR_MESSAGE

staticprivate

Definition at line 38 of file class.ilObjNewsSettingsGUI.php.

$rbacsystem

ilObjNewsSettingsGUI::$rbacsystem

protected

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

Referenced by executeCommand(), and getAdminTabs().

$settings

ilObjNewsSettingsGUI::$settings

protected

Definition at line 36 of file class.ilObjNewsSettingsGUI.php.

Referenced by editSettings(), and saveSettings().

---

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

• Services/News/classes/class.ilObjNewsSettingsGUI.php