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

Class ilObjMailGUI for admin panel. More...

+ Inheritance diagram for ilObjMailGUI:
+ Collaboration diagram for ilObjMailGUI:

Public Member Functions

 __construct ($a_data, $a_id, $a_call_by_reference)
 Constructor public.
 viewObject ()
 list childs of current object
 saveObject ()
 save object
 importObject ()
 performImportObject ()
 uploadObject ()
 __initFileObject ()
 __initParserObject ($a_xml, $a_mode)
& executeCommand ()
 execute command
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getTabs (&$tabs_gui)
 get tabs 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
 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
 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)
 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.

Private Member Functions

 initForm ()
 setDefaultValues ()

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
- 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
 __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="")

Detailed Description

Class ilObjMailGUI for admin panel.

Author
Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de
Id:
class.ilObjMailGUI.php 24141 2010-06-10 07:20:48Z mjansen

ilObjMailGUI: ilPermissionGUI

Definition at line 37 of file class.ilObjMailGUI.php.

Constructor & Destructor Documentation

ilObjMailGUI::__construct (   $a_data,
  $a_id,
  $a_call_by_reference 
)

Constructor public.

Definition at line 43 of file class.ilObjMailGUI.php.

{
$this->type = 'mail';
parent::__construct($a_data,$a_id,$a_call_by_reference, false);
$this->lng->loadLanguageModule('mail');
}

Member Function Documentation

ilObjMailGUI::__initFileObject ( )

Definition at line 268 of file class.ilObjMailGUI.php.

Referenced by importObject(), performImportObject(), and uploadObject().

{
include_once "./classes/class.ilFileDataImportMail.php";
$this->file_obj =& new ilFileDataImportMail();
return true;
}

+ Here is the caller graph for this function:

ilObjMailGUI::__initParserObject (   $a_xml,
  $a_mode 
)

Definition at line 276 of file class.ilObjMailGUI.php.

Referenced by performImportObject(), and uploadObject().

{
include_once "Services/Mail/classes/class.ilMailImportParser.php";
if(!$a_xml)
{
return false;
}
$this->parser_obj =& new ilMailImportParser($a_xml,$a_mode);
return true;
}

+ Here is the caller graph for this function:

& ilObjMailGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 290 of file class.ilObjMailGUI.php.

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

{
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
$this->prepareOutput();
switch($next_class)
{
case 'ilpermissiongui':
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 .= "Object";
$this->$cmd();
break;
}
return true;
}

+ Here is the call graph for this function:

ilObjMailGUI::getAdminTabs ( &  $tabs_gui)

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 317 of file class.ilObjMailGUI.php.

References getTabs().

{
$this->getTabs($tabs_gui);
}

+ Here is the call graph for this function:

ilObjMailGUI::getTabs ( &  $tabs_gui)

get tabs public

Parameters
objecttabs gui object

Reimplemented from ilObjectGUI.

Definition at line 327 of file class.ilObjMailGUI.php.

Referenced by getAdminTabs().

{
global $rbacsystem;
if ($rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
{
$tabs_gui->addTarget("settings",
$this->ctrl->getLinkTarget($this, "view"), array("view", 'save', ""), "", "");
}
if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId()))
{
$tabs_gui->addTarget("perm_settings",
$this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), array("perm","info","owner"), 'ilpermissiongui');
}
}

+ Here is the caller graph for this function:

ilObjMailGUI::importObject ( )

Definition at line 172 of file class.ilObjMailGUI.php.

References ilObjectGUI\$lng, and __initFileObject().

{
global $rbacsystem,$lng;
if (!$rbacsystem->checkAccess('write',$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("msg_no_perm_write"),$this->ilias->error_obj->WARNING);
}
#$this->getTemplateFile("import");
$this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_import.html", "Services/Mail");
// GET ALREADY CREATED UPLOADED XML FILE
$this->__initFileObject();
if($this->file_obj->findXMLFile())
{
$this->tpl->setVariable("TXT_IMPORTED_FILE",$lng->txt("checked_files"));
$this->tpl->setVariable("XML_FILE",basename($this->file_obj->getXMLFile()));
$this->tpl->setVariable("BTN_IMPORT",$this->lng->txt("import"));
}
$this->tpl->setVariable("FORMACTION",
$this->ctrl->getFormAction($this));
$this->tpl->setVariable("TXT_IMPORT_MAIL",$this->lng->txt("table_mail_import"));
$this->tpl->setVariable("TXT_IMPORT_FILE",$this->lng->txt("mail_import_file"));
$this->tpl->setVariable("BTN_CANCEL",$this->lng->txt("cancel"));
$this->tpl->setVariable("BTN_UPLOAD",$this->lng->txt("upload"));
return true;
}

+ Here is the call graph for this function:

ilObjMailGUI::initForm ( )
private

Definition at line 65 of file class.ilObjMailGUI.php.

References IL_MAIL_BOTH, IL_MAIL_EMAIL, IL_MAIL_LOCAL, ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilTextInputGUI\setSize(), and USER_FOLDER_ID.

Referenced by saveObject(), and viewObject().

{
include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
$this->form = new ilPropertyFormGUI();
$this->form->setFormAction($this->ctrl->getFormAction($this, 'save'));
$this->form->setTitle($this->lng->txt('general_settings'));
// Subject prefix
$pre = new ilTextInputGUI($this->lng->txt('mail_subject_prefix'),'mail_subject_prefix');
$pre->setSize(12);
$pre->setMaxLength(32);
$pre->setInfo($this->lng->txt('mail_subject_prefix_info'));
$this->form->addItem($pre);
// incoming type
include_once 'Services/Mail/classes/class.ilMailOptions.php';
$options = array(
IL_MAIL_LOCAL => $this->lng->txt('mail_incoming_local'),
IL_MAIL_EMAIL => $this->lng->txt('mail_incoming_smtp'),
IL_MAIL_BOTH => $this->lng->txt('mail_incoming_both')
);
$si = new ilSelectInputGUI($this->lng->txt('mail_incoming'), 'mail_incoming_mail');
$si->setOptions($options);
$this->ctrl->setParameterByClass('ilobjuserfoldergui', 'ref_id', USER_FOLDER_ID);
$si->setInfo(sprintf($this->lng->txt('mail_settings_incoming_type_see_also'), $this->ctrl->getLinkTargetByClass('ilobjuserfoldergui', 'settings')));
$this->ctrl->clearParametersByClass('ilobjuserfoldergui');
$this->form->addItem($si);
// noreply address
$ti = new ilTextInputGUI($this->lng->txt('mail_external_sender_noreply'), 'mail_external_sender_noreply');
$ti->setInfo($this->lng->txt('info_mail_external_sender_noreply'));
$ti->setMaxLength(255);
$this->form->addItem($ti);
// Pear Mail extension
// Note: We use the include statement to determine whether PEAR MAIL is
// installed. We use the @ operator to prevent PHP from issuing a
// warning while we test for PEAR MAIL.
$is_pear_mail_installed = @include_once 'Mail/RFC822.php';
$cb = new ilCheckboxInputGUI($this->lng->txt('mail_use_pear_mail'), 'pear_mail_enable');
if($is_pear_mail_installed)
{
$cb->setInfo($this->lng->txt('mail_use_pear_mail_info'));
}
else
{
$cb->setInfo($this->lng->txt('mail_use_pear_mail_info').' '.
$this->lng->txt('mail_pear_mail_needed'));
}
$cb->setValue('y');
$this->form->addItem($cb);
// section header
$sh = new ilFormSectionHeaderGUI();
$sh->setTitle($this->lng->txt('mail').' ('.$this->lng->txt('internal_system').')');
$this->form->addItem($sh);
// max attachment size
$ti = new ilTextInputGUI($this->lng->txt('mail_maxsize_attach'), 'mail_maxsize_attach');
$ti->setInfo($this->lng->txt('kb'));
$ti->setMaxLength(10);
$ti->setSize(10);
$this->form->addItem($ti);
$this->form->addCommandButton('save', $this->lng->txt('save'));
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjMailGUI::performImportObject ( )

Definition at line 203 of file class.ilObjMailGUI.php.

References ilObjectGUI\$lng, __initFileObject(), __initParserObject(), and ilUtil\sendInfo().

{
global $rbacsystem,$lng;
if (!$rbacsystem->checkAccess('write',$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("msg_no_perm_write"),$this->ilias->error_obj->WARNING);
}
$this->__initFileObject();
$this->file_obj->findXMLFile();
$this->__initParserObject($this->file_obj->getXMLFile(),"import");
$this->parser_obj->startParsing();
$number = $this->parser_obj->getCountImported();
ilUtil::sendInfo($lng->txt("import_finished")." ".$number,true);
$this->ctrl->redirect($this, "import");
}

+ Here is the call graph for this function:

ilObjMailGUI::saveObject ( )

save object

public

Reimplemented from ilObjectGUI.

Definition at line 147 of file class.ilObjMailGUI.php.

References initForm(), and ilUtil\sendSuccess().

{
global $ilAccess;
if(!$ilAccess->checkAccess('write,read', '', $this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
}
$this->initForm();
if($this->form->checkInput())
{
$this->ilias->setSetting('mail_subject_prefix',$this->form->getInput('mail_subject_prefix'));
$this->ilias->setSetting('mail_incoming_mail', (int)$this->form->getInput('mail_incoming_mail'));
$this->ilias->setSetting('mail_maxsize_attach', $this->form->getInput('mail_maxsize_attach'));
$this->ilias->setSetting('pear_mail_enable', $this->form->getInput('pear_mail_enable'));
$this->ilias->setSetting('mail_external_sender_noreply', $this->form->getInput('mail_external_sender_noreply'));
ilUtil::sendSuccess($this->lng->txt('saved_successfully'));
}
$this->form->setValuesByPost();
$this->tpl->setContent($this->form->getHTML());
}

+ Here is the call graph for this function:

ilObjMailGUI::setDefaultValues ( )
private

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

Referenced by viewObject().

{
$settings = $this->ilias->getAllSettings();
$is_pear_mail_installed = @include_once 'Mail/RFC822.php';
$this->form->setValuesByArray(array(
'mail_subject_prefix' => $settings['mail_subject_prefix'] ? $settings['mail_subject_prefix'] : '[ILIAS]',
'mail_incoming_mail' => (int)$settings['mail_incoming_mail'],
'pear_mail_enable' => ($settings['pear_mail_enable'] == 'y' && $is_pear_mail_installed) ? true : false,
'mail_external_sender_noreply' => $settings['mail_external_sender_noreply'],
'mail_maxsize_attach' => $settings['mail_maxsize_attach']
));
}

+ Here is the caller graph for this function:

ilObjMailGUI::uploadObject ( )

Definition at line 223 of file class.ilObjMailGUI.php.

References ilObjectGUI\$lng, __initFileObject(), __initParserObject(), and ilUtil\sendInfo().

{
global $rbacsystem,$lng;
if (!$rbacsystem->checkAccess('write',$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("msg_no_perm_write"),$this->ilias->error_obj->WARNING);
}
$this->__initFileObject();
if(!$this->file_obj->storeUploadedFile($_FILES["importFile"])) // STEP 1 save file in ...import/mail
{
$this->message = $lng->txt("import_file_not_valid");
$this->file_obj->unlinkLast();
}
else if(!$this->file_obj->unzip())
{
$this->message = $lng->txt("cannot_unzip_file"); // STEP 2 unzip uplaoded file
$this->file_obj->unlinkLast();
}
else if(!$this->file_obj->findXMLFile()) // STEP 3 getXMLFile
{
$this->message = $lng->txt("cannot_find_xml");
$this->file_obj->unlinkLast();
}
else if(!$this->__initParserObject($this->file_obj->getXMLFile(),"check"))
{
$this->message = $lng->txt("error_parser"); // STEP 4 init sax parser
}
else if(!$this->parser_obj->startParsing())
{
$this->message = $lng->txt("users_not_imported").":<br/>"; // STEP 5 start parsing
$this->message .= $this->parser_obj->getNotAssignableUsers();
}
// FINALLY CHECK ERROR
if(!$this->message)
{
$this->message = $lng->txt("uploaded_and_checked");
}
ilUtil::sendInfo($this->message,true);
$this->ctrl->redirect($this, "import");
}

+ Here is the call graph for this function:

ilObjMailGUI::viewObject ( )

list childs of current object

public

Reimplemented from ilObjectGUI.

Definition at line 51 of file class.ilObjMailGUI.php.

References initForm(), and setDefaultValues().

{
global $ilAccess;
if(!$ilAccess->checkAccess('write,read', '', $this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt('msg_no_perm_write'), $this->ilias->error_obj->WARNING);
}
$this->initForm();
$this->setDefaultValues();
$this->tpl->setContent($this->form->getHTML());
}

+ Here is the call graph for this function:

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