ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilObjMDSettingsGUI Class Reference

Meta Data Settings. More...

+ Inheritance diagram for ilObjMDSettingsGUI:
+ Collaboration diagram for ilObjMDSettingsGUI:

Public Member Functions

 __construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
 Contructor.
 executeCommand ()
 Execute command.
 getAdminTabs ()
 Get tabs.
 showGeneralSettings ()
 Edit general settings.
 initGeneralSettingsForm ($a_mode="edit")
 Init general settings form.
 saveGeneralSettings ()
 Save general settings.
 showCopyrightSettings ()
 Edit copyright settings.
 saveCopyrightSettings ()
 Save news and external webfeeds settings.
 editEntry ()
 edit one selection
 addEntry ()
 add new entry
 saveEntry ()
 save new entry
 confirmDeleteEntries ()
 confirm deletion of entries
 deleteEntries ()
 delete entries
 updateEntry ()
 update one entry
 initCopyrightEditForm ($a_mode= 'edit')
 public
- 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

 initSettingsForm ()
 protected
 initMDSettings ()
 init Md settings
 stripSlashes ($a_str)
 Special function to strip slashes for copyright fields.
- 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.
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 Add an object search in case the number of existing objects is too big to offer a selection list.
 searchCloneSourceObject ()
 Search clone source by title.
 buildCloneSelect ($existing_objs)
 Build a select box for clonable objects (permission write)
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")

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

Meta Data Settings.

Author
Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de
Version
$Id$

ilObjMDSettingsGUI: ilPermissionGUI, ilAdvancedMDSettingsGUI

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

Constructor & Destructor Documentation

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

Contructor.

public

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

References ilObjectGUI\$lng, and ilObjectGUI\ilObjectGUI().

{
global $lng;
$this->type = 'mds';
parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
$this->lng = $lng;
$this->lng->loadLanguageModule("meta");
}

+ Here is the call graph for this function:

Member Function Documentation

ilObjMDSettingsGUI::addEntry ( )

add new entry

public

Parameters

Definition at line 251 of file class.ilObjMDSettingsGUI.php.

References initCopyrightEditForm().

Referenced by saveEntry().

{
$this->initCopyrightEditForm('add');
$this->tpl->setContent($this->form->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::confirmDeleteEntries ( )

confirm deletion of entries

public

Definition at line 296 of file class.ilObjMDSettingsGUI.php.

References $_POST, ilUtil\sendInfo(), and showCopyrightSettings().

{
if(!is_array($_POST['entry_id']) or !count($_POST['entry_id']))
{
ilUtil::sendInfo($this->lng->txt('select_one'));
$this->showCopyrightSettings();
return true;
}
include_once('Services/Utilities/classes/class.ilConfirmationGUI.php');
$c_gui = new ilConfirmationGUI();
// set confirm/cancel commands
$c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteEntries"));
$c_gui->setHeaderText($this->lng->txt("md_delete_cp_sure"));
$c_gui->setCancel($this->lng->txt("cancel"), "showCopyrightSettings");
$c_gui->setConfirm($this->lng->txt("confirm"), "deleteEntries");
include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
// add items to delete
foreach($_POST["entry_id"] as $entry_id)
{
$entry = new ilMDCopyrightSelectionEntry($entry_id);
$c_gui->addItem('entry_id[]',$entry_id,$entry->getTitle());
}
$this->tpl->setContent($c_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::deleteEntries ( )

delete entries

public

Definition at line 331 of file class.ilObjMDSettingsGUI.php.

References $_POST, ilUtil\sendInfo(), and showCopyrightSettings().

{
if(!is_array($_POST['entry_id']) or !count($_POST['entry_id']))
{
ilUtil::sendInfo($this->lng->txt('select_one'));
$this->showCopyrightSettings();
return true;
}
include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
foreach($_POST["entry_id"] as $entry_id)
{
$entry = new ilMDCopyrightSelectionEntry($entry_id);
$entry->delete();
}
ilUtil::sendInfo($this->lng->txt('md_copyrights_deleted'));
$this->showCopyrightSettings();
return true;
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::editEntry ( )

edit one selection

public

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

References initCopyrightEditForm().

Referenced by updateEntry().

{
$this->ctrl->saveParameter($this,'entry_id');
$this->initCopyrightEditForm();
$this->tpl->setContent($this->form->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::executeCommand ( )

Execute command.

public

Reimplemented from ilObjectGUI.

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

References $cmd, $ilErr, $ret, initMDSettings(), 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 'iladvancedmdsettingsgui':
$this->tabs_gui->setTabActive('md_advanced');
include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDSettingsGUI.php');
$adv_md = new ilAdvancedMDSettingsGUI();
$ret = $this->ctrl->forwardCommand($adv_md);
break;
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:
$this->initMDSettings();
if(!$cmd || $cmd == 'view')
{
$cmd = "showGeneralSettings";
}
$this->$cmd();
break;
}
return true;
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::getAdminTabs ( )

Get tabs.

public

Definition at line 110 of file class.ilObjMDSettingsGUI.php.

{
global $rbacsystem, $ilAccess;
if ($rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
{
$this->tabs_gui->addTarget("md_general_settings",
$this->ctrl->getLinkTarget($this, "showGeneralSettings"),
array("showGeneralSettings", "view"));
$this->tabs_gui->addTarget("md_copyright",
$this->ctrl->getLinkTarget($this, "showCopyrightSettings"),
array("showCopyrightSettings"));
$this->tabs_gui->addTarget("md_advanced",
$this->ctrl->getLinkTargetByClass('iladvancedmdsettingsgui', ""),
'',
'iladvancedmdsettingsgui');
}
if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId()))
{
$this->tabs_gui->addTarget("perm_settings",
$this->ctrl->getLinkTargetByClass('ilpermissiongui',"perm"),
array(),'ilpermissiongui');
}
}
ilObjMDSettingsGUI::initCopyrightEditForm (   $a_mode = 'edit')

public

Parameters

Definition at line 413 of file class.ilObjMDSettingsGUI.php.

References ilTextInputGUI\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by addEntry(), and editEntry().

{
if(is_object($this->form))
{
return true;
}
if(!is_object($this->entry))
{
include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
$this->entry = new ilMDCopyrightSelectionEntry((int) $_REQUEST['entry_id']);
}
include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
$this->form = new ilPropertyFormGUI();
$this->form->setFormAction($this->ctrl->getFormAction($this));
$tit = new ilTextInputGUI($this->lng->txt('title'),'title');
$tit->setValue($this->entry->getTitle());
$tit->setRequired(true);
$tit->setSize(40);
$tit->setMaxLength(255);
$this->form->addItem($tit);
$des = new ilTextAreaInputGUI($this->lng->txt('description'),'description');
$des->setValue($this->entry->getDescription());
$des->setRows(3);
$this->form->addItem($des);
$cop = new ilTextAreaInputGUI($this->lng->txt('md_copyright_value'),'copyright');
$cop->setValue($this->entry->getCopyright());
$cop->setRows(5);
$this->form->addItem($cop);
switch($a_mode)
{
case 'edit':
$this->form->setTitle($this->lng->txt('md_copyright_edit'));
$this->form->addCommandButton('updateEntry',$this->lng->txt('save'));
$this->form->addCommandButton('showCopyrightSettings',$this->lng->txt('cancel'));
break;
case 'add':
$this->form->setTitle($this->lng->txt('md_copyright_add'));
$this->form->addCommandButton('saveEntry',$this->lng->txt('save'));
$this->form->addCommandButton('showCopyrightSettings',$this->lng->txt('cancel'));
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::initGeneralSettingsForm (   $a_mode = "edit")

Init general settings form.

Parameters
int$a_modeEdit Mode

Definition at line 155 of file class.ilObjMDSettingsGUI.php.

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

Referenced by showGeneralSettings().

{
global $lng;
$this->tabs_gui->setTabActive('md_general_settings');
include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
$this->form = new ilPropertyFormGUI();
$ti = new ilTextInputGUI($this->lng->txt("md_delimiter"), "delimiter");
$ti->setInfo($this->lng->txt("md_delimiter_info"));
$ti->setMaxLength(1);
$ti->setSize(1);
$ti->setValue($this->md_settings->getDelimiter());
$this->form->addItem($ti);
$this->form->addCommandButton("saveGeneralSettings", $lng->txt("save"));
$this->form->addCommandButton("showGeneralSettings", $lng->txt("cancel"));
$this->form->setTitle($lng->txt("md_general_settings"));
$this->form->setFormAction($this->ctrl->getFormAction($this));
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::initMDSettings ( )
protected

init Md settings

protected

Definition at line 468 of file class.ilObjMDSettingsGUI.php.

References ilMDSettings\_getInstance().

Referenced by executeCommand().

{
include_once('Services/MetaData/classes/class.ilMDSettings.php');
$this->md_settings = ilMDSettings::_getInstance();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::initSettingsForm ( )
protected

protected

Definition at line 386 of file class.ilObjMDSettingsGUI.php.

References ilCheckboxInputGUI\setChecked().

Referenced by showCopyrightSettings().

{
if(is_object($this->form))
{
return true;
}
include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
$this->form = new ilPropertyFormGUI();
$this->form->setFormAction($this->ctrl->getFormAction($this));
$this->form->setTitle($this->lng->txt('md_copyright_settings'));
$this->form->addCommandButton('saveCopyrightSettings',$this->lng->txt('save'));
$this->form->addCommandButton('showCopyrightSettings',$this->lng->txt('cancel'));
$check = new ilCheckboxInputGUI($this->lng->txt('md_copyright_enabled'),'active');
$check->setChecked($this->md_settings->isCopyrightSelectionActive());
$check->setValue(1);
$check->setInfo($this->lng->txt('md_copyright_enable_info'));
$this->form->addItem($check);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::saveCopyrightSettings ( )

Save news and external webfeeds settings.

Definition at line 222 of file class.ilObjMDSettingsGUI.php.

References $_POST, ilUtil\sendInfo(), and showCopyrightSettings().

{
$this->md_settings->activateCopyrightSelection((int) $_POST['active']);
$this->md_settings->save();
ilUtil::sendInfo($this->lng->txt('settings_saved'));
$this->showCopyrightSettings();
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::saveEntry ( )

save new entry

public

Definition at line 264 of file class.ilObjMDSettingsGUI.php.

References $_POST, $ilErr, addEntry(), ilUtil\sendInfo(), showCopyrightSettings(), stripSlashes(), and ilUtil\stripSlashes().

{
global $ilErr;
include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
$this->entry = new ilMDCopyrightSelectionEntry(0);
$this->entry->setTitle(ilUtil::stripSlashes($_POST['title']));
$this->entry->setDescription(ilUtil::stripSlashes($_POST['description']));
$this->entry->setCopyright($this->stripSlashes($_POST['copyright']));
$this->entry->setLanguage('en');
$this->entry->setCopyrightAndOtherRestrictions(true);
$this->entry->setCosts(false);
if(!$this->entry->validate())
{
ilUtil::sendInfo($this->lng->txt('fill_out_all_required_fields'));
$this->addEntry();
return false;
}
$this->entry->add();
ilUtil::sendInfo($this->lng->txt('settings_saved'));
$this->showCopyrightSettings();
return true;
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::saveGeneralSettings ( )

Save general settings.

Definition at line 182 of file class.ilObjMDSettingsGUI.php.

References $_POST, $ilCtrl, and ilUtil\sendInfo().

{
global $ilCtrl;
$delim = (trim($_POST['delimiter']) == "")
? ","
: trim($_POST['delimiter']);
$this->md_settings->setDelimiter($delim);
$this->md_settings->save();
ilUtil::sendInfo($this->lng->txt('settings_saved'), true);
$ilCtrl->redirect($this, "showGeneralSettings");
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::showCopyrightSettings ( )

Edit copyright settings.

Definition at line 200 of file class.ilObjMDSettingsGUI.php.

References initSettingsForm().

Referenced by confirmDeleteEntries(), deleteEntries(), saveCopyrightSettings(), saveEntry(), and updateEntry().

{
$this->tabs_gui->setTabActive('md_copyright');
$this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.settings.html','Services/MetaData');
$this->initSettingsForm();
$this->tpl->setVariable('SETTINGS_TABLE',$this->form->getHTML());
include_once("./Services/MetaData/classes/class.ilMDCopyrightTableGUI.php");
$table_gui = new ilMDCopyrightTableGUI($this,'showCopyrightSettings');
$table_gui->setTitle($this->lng->txt("md_copyright_selection"));
$table_gui->parseSelections();
// $table_gui->addCommandButton("updateCopyrightSelection", $this->lng->txt("save"));
$table_gui->addCommandButton('addEntry',$this->lng->txt('add'));
$table_gui->addMultiCommand("confirmDeleteEntries", $this->lng->txt("delete"));
$table_gui->setSelectAllCheckbox("entry_id");
$this->tpl->setVariable('COPYRIGHT_TABLE',$table_gui->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::showGeneralSettings ( )

Edit general settings.

Definition at line 142 of file class.ilObjMDSettingsGUI.php.

References ilObjectGUI\$tpl, and initGeneralSettingsForm().

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

+ Here is the call graph for this function:

ilObjMDSettingsGUI::stripSlashes (   $a_str)
protected

Special function to strip slashes for copyright fields.

protected

Definition at line 479 of file class.ilObjMDSettingsGUI.php.

Referenced by saveEntry(), and updateEntry().

{
if (ini_get("magic_quotes_gpc"))
{
$a_str = stripslashes($a_str);
}
return $a_str;
}

+ Here is the caller graph for this function:

ilObjMDSettingsGUI::updateEntry ( )

update one entry

public

Definition at line 357 of file class.ilObjMDSettingsGUI.php.

References $_POST, $ilErr, editEntry(), ilUtil\sendInfo(), showCopyrightSettings(), stripSlashes(), and ilUtil\stripSlashes().

{
global $ilErr;
include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
$this->entry = new ilMDCopyrightSelectionEntry((int) $_REQUEST['entry_id']);
$this->entry->setTitle(ilUtil::stripSlashes($_POST['title']));
$this->entry->setDescription(ilUtil::stripSlashes($_POST['description']));
$this->entry->setCopyright($this->stripSlashes($_POST['copyright']));
if(!$this->entry->validate())
{
ilUtil::sendInfo($this->lng->txt('fill_out_all_required_fields'));
$this->editEntry();
return false;
}
$this->entry->update();
ilUtil::sendInfo($this->lng->txt('settings_saved'));
$this->showCopyrightSettings();
return true;
}

+ Here is the call graph for this function:

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