ILIAS  Release_3_10_x_branch Revision 61812
 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.
 settings ()
 Edit news settings.
 saveSettings ()
 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
 assignObject ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 showMountWebfolderIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 setActions ($a_actions="")
 set possible actions for objects in list.
 setSubObjects ($a_sub_objects="")
 set possible subobjects for this object.
 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)
 undeleteObject ()
 get object back from trash
 insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
 recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
 confirmedDeleteObject ()
 confirmed deletion if object -> objects are moved to trash
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
 remove already deleted objects within the objects in trash recursive function
 createObject ()
 create new object form
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 saveObject ()
 save object
 importObject ()
 import new object form
 editObject ()
 edit object
 displayEditForm ($fields)
 display edit form (usually called by editObject)
 updateObject ()
 updates object entry in object_data
 afterUpdate ()
 permObject ()
 show permissions of current node
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 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
 permSaveObject ()
 save permissions
 isVisible ($a_ref_id, $a_type)
 displayList ()
 display object list
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 display deletion confirmation screen only for referenced objects.
 trashObject ()
 show trash content of object
 addRoleObject ()
 adds a local role This method is only called when choose the option 'you may add local roles'.
 showActions ($with_subobjects=false)
 show possible action (form buttons)
 getActions ()
 Get Actions.
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 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="")
 infoObject ()
 __buildRoleFilterSelect ()
 __filterRoles ($a_roles, $a_filter)
 ownerObject ()
 changeOwnerObject ()
 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.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")

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
 searchCloneSourceObject ()
 Search clone source by title.
 buildCloneSelect ($existing_objs)
 Build a select box for clonable objects (permission write)

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 191 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 236 of file class.ilObjMDSettingsGUI.php.

References ilUtil\sendInfo(), and settings().

{
if(!is_array($_POST['entry_id']) or !count($_POST['entry_id']))
{
ilUtil::sendInfo($this->lng->txt('select_one'));
$this->settings();
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"), "settings");
$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 271 of file class.ilObjMDSettingsGUI.php.

References ilUtil\sendInfo(), and settings().

{
if(!is_array($_POST['entry_id']) or !count($_POST['entry_id']))
{
ilUtil::sendInfo($this->lng->txt('select_one'));
$this->settings();
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->settings();
return true;
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::editEntry ( )

edit one selection

public

Definition at line 177 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("./classes/class.ilPermissionGUI.php");
$perm_gui =& new ilPermissionGUI($this);
$ret =& $this->ctrl->forwardCommand($perm_gui);
break;
default:
$this->tabs_gui->setTabActive('md_copyright');
$this->initMDSettings();
if(!$cmd || $cmd == 'view')
{
$cmd = "settings";
}
$this->$cmd();
break;
}
return true;
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::getAdminTabs ( )

Get tabs.

public

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

{
global $rbacsystem, $ilAccess;
if ($rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
{
$this->tabs_gui->addTarget("md_copyright",
$this->ctrl->getLinkTarget($this, "settings"),
array("settings", "view"));
$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 353 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('settings',$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('settings',$this->lng->txt('cancel'));
break;
}
}

+ 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 408 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 326 of file class.ilObjMDSettingsGUI.php.

References ilCheckboxInputGUI\setChecked().

Referenced by settings().

{
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('saveSettings',$this->lng->txt('save'));
$this->form->addCommandButton('settings',$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::saveEntry ( )

save new entry

public

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

References $ilErr, addEntry(), ilUtil\sendInfo(), settings(), 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->settings();
return true;
}

+ Here is the call graph for this function:

ilObjMDSettingsGUI::saveSettings ( )

Save news and external webfeeds settings.

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

References ilUtil\sendInfo(), and settings().

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

+ Here is the call graph for this function:

ilObjMDSettingsGUI::settings ( )

Edit news settings.

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

References initSettingsForm().

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

{
$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,'settings');
$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::stripSlashes (   $a_str)
protected

Special function to strip slashes for copyright fields.

protected

Definition at line 419 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 297 of file class.ilObjMDSettingsGUI.php.

References $ilErr, editEntry(), ilUtil\sendInfo(), settings(), 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->settings();
return true;
}

+ Here is the call graph for this function:

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