ilObjTaggingSettingsGUI Class Reference

Media Cast Settings. More...

Inheritance diagram for ilObjTaggingSettingsGUI:

Collaboration diagram for ilObjTaggingSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor.
	executeCommand ()
	Execute command.
	getAdminTabs ()
	Get tabs.
	addSubTabs ()
	Add subtabs.
	editSettings ()
	Edit mediacast settings.
	saveSettings ()
	Save mediacast settings.
	cancel ()
	Save mediacast settings.
	editForbiddenTags ()
	Edit forbidden tags.
	initForbiddenTagsForm ()
	Init forbidden tags form.
	saveForbiddenTags ()
	Save forbidden tags.
	showUsers ($a_search=false)
	Show users.
	searchUsersForTag ()
	Search users for tag.
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 ()
	undeleteObject ()
	Get objects back from trash.
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	createObject ()
	create new object form
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	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.
	trashObject ()
	Show trash content of object.
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.

Protected Member Functions
	initFormSettings ()
	Init settings property form.
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	showUpperIcon ()
	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 ()
	should be overwritten to add object specific items (repository items are preloaded)
	displayEditForm ($fields)
	display edit form (usually called by editObject)
	afterUpdate ()
	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)
	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
	__showClipboardTable ($a_result_set, $a_from="")
	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="")

Static Private Attributes
static	$ERROR_MESSAGE

Additional Inherited Members
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

Detailed Description

Media Cast Settings.

Author

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

Version

$Id$

ilObjTaggingSettingsGUI: ilPermissionGUI ilObjTaggingSettingsGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

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

Contructor.

public

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

References ilObjectGUI\ilObjectGUI().

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

                $this->lng->loadLanguageModule('tagging');
        }

Here is the call graph for this function:

Member Function Documentation

ilObjTaggingSettingsGUI::addSubTabs

(

)

Add subtabs.

Definition at line 101 of file class.ilObjTaggingSettingsGUI.php.

References $ilCtrl, and ilObjectGUI\$lng.

Referenced by editForbiddenTags(), editSettings(), and showUsers().

        {
                global $ilTabs, $lng, $ilCtrl, $ilAccess;
                
                $tags_set = new ilSetting("tags");
                if ($tags_set->get("enable"))
                {
                        $ilTabs->addSubTab("settings", $lng->txt("settings"),
                                $ilCtrl->getLinkTarget($this, "editSettings"));

                        if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
                        {
                                $ilTabs->addSubTab("forbidden_tags", $lng->txt("tagging_forbidden_tags"),
                                        $ilCtrl->getLinkTarget($this, "editForbiddenTags"));
        
                                $ilTabs->addSubTab("users", $lng->txt("users"),
                                        $ilCtrl->getLinkTarget($this, "showUsers"));
                        }
                }
        }

Here is the caller graph for this function:

ilObjTaggingSettingsGUI::cancel

(

)

Save mediacast settings.

Definition at line 158 of file class.ilObjTaggingSettingsGUI.php.

References $ilCtrl.

        {
                global $ilCtrl;
                
                $ilCtrl->redirect($this, "view");
        }

ilObjTaggingSettingsGUI::editForbiddenTags

(

)

Edit forbidden tags.

Definition at line 210 of file class.ilObjTaggingSettingsGUI.php.

References ilObjectGUI\$tpl, addSubTabs(), and initForbiddenTagsForm().

        {
                global $ilTabs, $tpl;
                
                $this->addSubTabs();
                $ilTabs->activateSubTab("forbidden_tags");
                $ilTabs->activateTab("tagging_edit_settings");
                $this->initForbiddenTagsForm();
                
                $tpl->setContent($this->form->getHTML());
        }

Here is the call graph for this function:

ilObjTaggingSettingsGUI::editSettings

(

)

Edit mediacast settings.

Definition at line 126 of file class.ilObjTaggingSettingsGUI.php.

References addSubTabs(), and initFormSettings().

        {
                global $ilTabs;
                
                $this->tabs_gui->setTabActive('tagging_edit_settings');
                $this->addSubTabs();
                $ilTabs->activateSubTab("settings");            
                $this->initFormSettings();
                return true;
        }

Here is the call graph for this function:

ilObjTaggingSettingsGUI::executeCommand

(

)

Execute command.

public

Reimplemented from ilObjectGUI.

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

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

        {
                global $rbacsystem,$ilErr,$ilAccess;

                $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:

ilObjTaggingSettingsGUI::getAdminTabs

(

)

Get tabs.

public

Definition at line 79 of file class.ilObjTaggingSettingsGUI.php.

        {
                global $rbacsystem, $ilAccess;

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

ilObjTaggingSettingsGUI::initForbiddenTagsForm

(

)

Init forbidden tags form.

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

References $ilCtrl, ilObjectGUI\$lng, and ilTextAreaInputGUI\setCols().

Referenced by editForbiddenTags(), and saveForbiddenTags().

        {
                global $lng, $ilCtrl;
        
                $tags_set = new ilSetting("tags");
                $forbidden = $tags_set->get("forbidden_tags");

                if ($forbidden != "")
                {
                        $tags_array = unserialize($forbidden);
                        $forb_str = implode($tags_array, " ");
                }
                
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $this->form = new ilPropertyFormGUI();
                
                // tags
                $ta = new ilTextAreaInputGUI($this->lng->txt("tagging_tags"), "forbidden_tags");
                $ta->setCols(50);
                $ta->setRows(10);
                $ta->setValue($forb_str);
                $this->form->addItem($ta);
        
                $this->form->addCommandButton("saveForbiddenTags", $lng->txt("save"));
                        
                $this->form->setTitle($lng->txt("tagging_forbidden_tags"));
                $this->form->setFormAction($ilCtrl->getFormAction($this));
         
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjTaggingSettingsGUI::initFormSettings ( )

protected

Init settings property form.

protected

Definition at line 170 of file class.ilObjTaggingSettingsGUI.php.

References ilObjectGUI\$lng, ilFormPropertyGUI\setInfo(), and ilCheckboxInputGUI\setValue().

Referenced by editSettings().

        {
            global $lng;
                
                $tags_set = new ilSetting("tags");
                
                
                include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->lng->txt('tagging_settings'));
                $form->addCommandButton('saveSettings',$this->lng->txt('save'));
                $form->addCommandButton('cancel',$this->lng->txt('cancel'));

                // enable tagging
                $cb_prop = new ilCheckboxInputGUI($lng->txt("tagging_enable_tagging"),
                        "enable_tagging");
                $cb_prop->setValue("1");
                $cb_prop->setChecked($tags_set->get("enable"));
                
                        // enable all users info
                        $cb_prop2 = new ilCheckboxInputGUI($lng->txt("tagging_enable_all_users"),
                                "enable_all_users");
                        $cb_prop2->setInfo($lng->txt("tagging_enable_all_users_info"));
                        $cb_prop2->setChecked($tags_set->get("enable_all_users"));
                        $cb_prop->addSubItem($cb_prop2);

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjTaggingSettingsGUI::saveForbiddenTags

(

)

Save forbidden tags.

Definition at line 258 of file class.ilObjTaggingSettingsGUI.php.

References $_POST, $ilCtrl, ilObjectGUI\$lng, $t, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), initForbiddenTagsForm(), and ilUtil\sendSuccess().

        {
                global $tpl, $lng, $ilCtrl;

                $this->initForbiddenTagsForm();
                $this->form->checkInput();
                
                $this->checkPermission("write");
                
                $tags = str_replace(",", " ", $_POST["forbidden_tags"]);
                $tags = explode(" ", $tags);
                $tags_array = array();
                foreach ($tags as $t)
                {
                        $t = strtolower(trim($t));
                        if ($t != "")
                        {
                                $tags_array[$t] = $t;
                        }
                }
                
                asort($tags_array);
                
                $tags_set = new ilSetting("tags");
                
                $tags_set->set("forbidden_tags", serialize($tags_array));
                
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->redirect($this, "editForbiddenTags");
        }

Here is the call graph for this function:

ilObjTaggingSettingsGUI::saveSettings

(

)

Save mediacast settings.

Definition at line 140 of file class.ilObjTaggingSettingsGUI.php.

References $_POST, $ilCtrl, $ilSetting, ilObjectGUI\checkPermission(), ilUtil\sendSuccess(), and ilUtil\stripSlashes().

        {
                global $ilCtrl, $ilSetting;
                
                $this->checkPermission("write");

                $tags_set = new ilSetting("tags");
                $tags_set->set("enable", ilUtil::stripSlashes($_POST["enable_tagging"]));
                $tags_set->set("enable_all_users", ilUtil::stripSlashes($_POST["enable_all_users"]));
                $ilSetting->set("block_activated_pdtag", $_POST["enable_tagging"]);

                ilUtil::sendSuccess($this->lng->txt("settings_saved"),true);
                $ilCtrl->redirect($this, "view");
        }

Here is the call graph for this function:

ilObjTaggingSettingsGUI::searchUsersForTag

(

)

Search users for tag.

Definition at line 336 of file class.ilObjTaggingSettingsGUI.php.

References showUsers().

        {
                $this->showUsers(true);
        }

Here is the call graph for this function:

ilObjTaggingSettingsGUI::showUsers

(

$a_search = false

)

Show users.

Definition at line 298 of file class.ilObjTaggingSettingsGUI.php.

References $_GET, $_POST, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, addSubTabs(), ilObjectGUI\checkPermission(), ilTextInputGUI\setSize(), and ilUtil\stripSlashes().

Referenced by searchUsersForTag().

        {
                global $ilTabs, $tpl, $ilToolbar, $lng, $ilCtrl;
                
                $this->checkPermission("write");
                
                $this->addSubTabs();
                $ilTabs->activateTab("tagging_edit_settings");
                $ilTabs->activateSubTab("users");

                $tag = ($_POST["tag"] != "")
                        ? ilUtil::stripSlashes($_POST["tag"])
                        : $_GET["tag"];
                
                // tag input
                include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                $ti = new ilTextInputGUI($lng->txt("tagging_tag"), "tag");
                $ti->setSize(15);
                $ti->setValue($tag);
                $ilToolbar->addInputItem($ti, true);
                
                $ilToolbar->addFormButton($lng->txt("tagging_search_users"), "searchUsersForTag");
                $ilToolbar->setFormAction($ilCtrl->getFormAction($this, "searchUsersForTag"));
                
                if ($a_search)
                {
                        include_once("./Services/Tagging/classes/class.ilUserForTagTableGUI.php");
                        $ilCtrl->setParameter($this, "tag", $tag);
                        $table = new ilUserForTagTableGUI($this, "searchUsersForTag",
                                $tag);
                        $tpl->setContent($table->getHTML());
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ilObjTaggingSettingsGUI::$ERROR_MESSAGE

staticprivate

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

---

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

• Services/Tagging/classes/class.ilObjTaggingSettingsGUI.php