ilMailTemplateGUI Class Reference

Class ilMailTemplateGUI. More...

Collaboration diagram for ilMailTemplateGUI:

Public Member Functions
	executeCommand ()
	getAjaxPlaceholdersById ()

Protected Member Functions
	showTemplates ()
	insertTemplate ()
	showInsertTemplateForm (ilPropertyFormGUI $form=NULL)
	updateTemplate ()
	showEditTemplateForm (ilPropertyFormGUI $form=NULL)
	populateFormWithTemplate (ilPropertyFormGUI $form, ilMailTemplate $template)
	confirmDeleteTemplate ()
	deleteTemplate ()
	getTemplateForm (ilMailTemplate $template=null)

Protected Attributes
	$form
	$tpl
	$ctrl
	$lng
	$toolbar

Detailed Description

Class ilMailTemplateGUI.

Author

Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de @ilCtrl_isCalledBy ilMailTemplateGUI: ilObjMailGUI

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

Member Function Documentation

confirmDeleteTemplate()

ilMailTemplateGUI::confirmDeleteTemplate ( )

protected

Definition at line 281 of file class.ilMailTemplateGUI.php.

        {
                if(isset($_POST['tpl_id']) && is_array($_POST['tpl_id']) && count($_POST['tpl_id']) > 0)
                {
                        $tpl_ids = array_filter(array_map('intval', $_POST['tpl_id']));
                }
                else if(isset($_GET['tpl_id']) && strlen($_GET['tpl_id']))
                {
                        $tpl_ids = array_filter(array((int)$_GET['tpl_id']));
                }
                else
                {
                        $tpl_ids = array();
                }
 
                if(count($tpl_ids) == 0)
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        $this->showTemplates();
                        return;
                }
 
                require_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
                $confirm = new ilConfirmationGUI();
                $confirm->setFormAction($this->ctrl->getFormAction($this, 'deleteTemplate'));
                $confirm->setHeaderText($this->lng->txt('mail_sure_delete_entry'));
                $confirm->setConfirm($this->lng->txt('confirm'), 'deleteTemplate');
                $confirm->setCancel($this->lng->txt('cancel'), 'showTemplates');
 
                foreach($tpl_ids as $tpl_id)
                {
                        $template = $this->provider->getTemplateById((int)$tpl_id);
                        $confirm->addItem('tpl_id[]', $tpl_id, $template->getTitle());
                }
                $this->tpl->setContent($confirm->getHTML());
        }

References $_GET, $_POST, ilUtil\sendFailure(), and showTemplates().

Here is the call graph for this function:

deleteTemplate()

ilMailTemplateGUI::deleteTemplate ( )

protected

Definition at line 321 of file class.ilMailTemplateGUI.php.

        {
                if(isset($_POST['tpl_id']) && is_array($_POST['tpl_id']) && count($_POST['tpl_id']) > 0)
                {
                        $tpl_ids = array_filter(array_map('intval', $_POST['tpl_id']));
                        if(0 == count($tpl_ids))
                        {
                                ilUtil::sendFailure($this->lng->txt('select_one'));
                                $this->showTemplates();
                                return;
                        }
                }
                else
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        $this->showTemplates();
                        return;
                }
 
                $this->provider->deleteTemplates($tpl_ids);
 
                if(1 == count($tpl_ids))
                {
                        ilUtil::sendSuccess($this->lng->txt('mail_tpl_deleted_s'), true);
                }
                else
                {
                        ilUtil::sendSuccess($this->lng->txt('mail_tpl_deleted_p'), true);
                }
                $this->ctrl->redirect($this, 'showTemplates');
        }

References $_POST, ilUtil\sendFailure(), ilUtil\sendSuccess(), and showTemplates().

Here is the call graph for this function:

executeCommand()

ilMailTemplateGUI::executeCommand

(

)

Definition at line 69 of file class.ilMailTemplateGUI.php.

        {
                $next_class = $this->ctrl->getNextClass($this);
                $cmd        = $this->ctrl->getCmd();
 
                switch($next_class)
                {
                        default:
                                if(!$cmd || !method_exists($this, $cmd))
                                {
                                        $cmd = 'showTemplates';
                                }
 
                                $this->$cmd();
                                break;
                }
        }

References $cmd.

getAjaxPlaceholdersById()

ilMailTemplateGUI::getAjaxPlaceholdersById

(

)

Definition at line 353 of file class.ilMailTemplateGUI.php.

        {
                $context_id = ilUtil::stripSlashes($_GET['context_id']);
                require_once 'Services/Mail/classes/Form/class.ilManualPlaceholderInputGUI.php';
                $placeholders = new ilManualPlaceholderInputGUI($this->ctrl->getLinkTarget($this, 'getAjaxPlaceholdersById', '', true, false));
                $context = ilMailTemplateService::getTemplateContextById($context_id);
                foreach( $context->getPlaceholders() as $key => $value)
                {
                        $placeholders->addPlaceholder($value['placeholder'], $value['label'] );
                }
                $placeholders->render(true);
                exit();
        }

References $_GET, exit, ilMailTemplateService\getTemplateContextById(), and ilUtil\stripSlashes().

Here is the call graph for this function:

getTemplateForm()

ilMailTemplateGUI::getTemplateForm ( ilMailTemplate  $template = null )

protected

Parameters

ilMailTemplate

$template

Returns

ilPropertyFormGUI

Definition at line 371 of file class.ilMailTemplateGUI.php.

        {
                $form  = new ilPropertyFormGUI();
 
                $title = new ilTextInputGUI($this->lng->txt('mail_template_title'), 'title');
                $title->setRequired(true);
                $form->addItem($title);
 
                $context  = new ilRadioGroupInputGUI($this->lng->txt('mail_template_context'), 'context');
                $contexts = ilMailTemplateService::getTemplateContexts();
 
                if(count($contexts) <= 1)
                {
                        ilUtil::sendFailure($this->lng->txt('mail_template_no_context_available'), true);
                        $this->ctrl->redirect($this, 'showTemplates');
                }
 
                $context_sort    = array();
                $context_options = array();
                $generic_context = new ilMailTemplateGenericContext();
                foreach($contexts as $ctx)
                {
                        if($ctx->getId() != $generic_context->getId())
                        {
                                $context_options[$ctx->getId()] = $ctx;
                                $context_sort[$ctx->getId()]    = $ctx->getTitle();
                        }
                }
                asort($context_sort);
                $first = null;
                foreach($context_sort as $id => $title)
                {
                        $ctx    = $context_options[$id];
                        $option = new ilRadioOption($ctx->getTitle(), $ctx->getId());
                        $option->setInfo($ctx->getDescription());
                        $context->addOption($option);
                        
                        if(!$first)
                        {
                                $first = $id;
                        }
                }
                $context->setValue($first);
                $context->setRequired(true);
                $form->addItem($context);
 
                /*$lang = new ilSelectInputGUI($this->lng->txt('language'), 'lang');
                $options = array();
                foreach($this->lng->getInstalledLanguages() as $iso2code)
                {
                        $options[$iso2code] = $this->lng->txt('meta_l_' . $iso2code);
                }
                asort($options);
                $lang->setOptions(array('' => $this->lng->txt('please_choose')) + $options);
                $lang->setRequired(true);
                $form->addItem($lang);*/
                $hidde_language = new ilHiddenInputGUI('lang');
                $hidde_language->setValue($this->lng->getLangKey());
                $form->addItem($hidde_language);
 
                $subject = new ilTextInputGUI($this->lng->txt('subject'), 'm_subject');
                $subject->setSize(50);
                $form->addItem($subject);
 
                $message = new ilTextAreaInputGUI($this->lng->txt('message'), 'm_message');
                $message->setRequired(true);
                $message->setCols(60);
                $message->setRows(10);
                $form->addItem($message);
 
                require_once 'Services/Mail/classes/Form/class.ilManualPlaceholderInputGUI.php';
                $placeholders = new ilManualPlaceholderInputGUI($this->ctrl->getLinkTarget($this, 'getAjaxPlaceholdersById', '', true, false));
                
                if( $template === null )
                {
                        $context_id = $generic_context->getId();
                }
                else
                {
                        $context_id = $template->getContext();
                }
                $context = ilMailTemplateService::getTemplateContextById($context_id);
                foreach( $context->getPlaceholders() as $key => $value)
                {
                        $placeholders->addPlaceholder($value['placeholder'], $value['label'] );
                }
                $form->addItem($placeholders);
                if($template instanceof ilMailTemplate && $template->getTplId() > 0)
                {
                        $id = new ilHiddenInputGUI('tpl_id');
                        $form->addItem($id);
 
                        $form->setTitle($this->lng->txt('mail_edit_tpl'));
                        $form->setFormAction($this->ctrl->getFormaction($this, 'updateTemplate'));
                        $form->addCommandButton('updateTemplate', $this->lng->txt('save'));
                }
                else
                {
                        $form->setTitle($this->lng->txt('mail_create_tpl'));
                        $form->setFormAction($this->ctrl->getFormaction($this, 'insertTemplate'));
                        $form->addCommandButton('insertTemplate', $this->lng->txt('save'));
                }
 
                $form->addCommandButton('showTemplates', $this->lng->txt('cancel'));
                return $form;
        }

References $form, ilMailTemplateService\getTemplateContextById(), ilMailTemplateService\getTemplateContexts(), ilMailTemplate\getTplId(), and ilUtil\sendFailure().

Referenced by insertTemplate(), showEditTemplateForm(), showInsertTemplateForm(), and updateTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

insertTemplate()

ilMailTemplateGUI::insertTemplate ( )

protected

Definition at line 117 of file class.ilMailTemplateGUI.php.

        {
                $form = $this->getTemplateForm();
 
                if(!$form->checkInput())
                {
                        $form->setValuesByPost();
                        $this->showInsertTemplateForm($form);
                        return;
                }
 
                $generic_context = new ilMailTemplateGenericContext();
                if($form->getInput('context') == $generic_context->getId())
                {
                        $form->getItemByPostVar('context')->setAlert($this->lng->txt('mail_template_no_valid_context'));
                        $form->setValuesByPost();
                        $this->showInsertTemplateForm($form);
                        return;
                }
 
                try
                {
                        $context = ilMailTemplateService::getTemplateContextById($form->getInput('context'));
                        $template = new ilMailTemplate();
                        $template->setTitle($form->getInput('title'));
                        $template->setContext($context->getId());
                        $template->setLang($form->getInput('lang'));
                        $template->setSubject($form->getInput('m_subject'));
                        $template->setMessage($form->getInput('m_message'));
                        $template->insert();
 
                        ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
                        $this->ctrl->redirect($this, 'showTemplates');
                }
                catch(Exception $e)
                {
                        $form->getItemByPostVar('context')->setAlert($this->lng->txt('mail_template_no_valid_context'));
                        ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
                }
 
                $form->setValuesByPost();
                $this->showInsertTemplateForm($form);
        }

References $form, ilMailTemplateService\getTemplateContextById(), getTemplateForm(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and showInsertTemplateForm().

Here is the call graph for this function:

populateFormWithTemplate()

ilMailTemplateGUI::populateFormWithTemplate ( ilPropertyFormGUI  $form, ilMailTemplate  $template  )

protected

Parameters

ilPropertyFormGUI	$form
ilMailTemplate	$template

Definition at line 266 of file class.ilMailTemplateGUI.php.

        {
                $form->setValuesByArray(array(
                        'tpl_id'    => $template->getTplId(),
                        'title'     => $template->getTitle(),
                        'context'   => $template->getContext(),
                        'lang'      => $template->getLang(),
                        'm_subject' => $template->getSubject(),
                        'm_message' => $template->getMessage()
                ));
        }

References $form, ilMailTemplate\getContext(), ilMailTemplate\getLang(), ilMailTemplate\getMessage(), ilMailTemplate\getSubject(), ilMailTemplate\getTitle(), and ilMailTemplate\getTplId().

Referenced by showEditTemplateForm().

Here is the call graph for this function:

Here is the caller graph for this function:

showEditTemplateForm()

ilMailTemplateGUI::showEditTemplateForm ( ilPropertyFormGUI  $form = NULL )

protected

Parameters

ilPropertyFormGUI

$form

Definition at line 236 of file class.ilMailTemplateGUI.php.

        {
                if(!($form instanceof ilPropertyFormGUI))
                {
                        if(!isset($_GET['tpl_id']) || !strlen($_GET['tpl_id']))
                        {
                                ilUtil::sendFailure($this->lng->txt('mail_template_missing_id'));
                                $this->showTemplates();
                                return;
                        }
 
                        $template = $this->provider->getTemplateById((int)$_GET['tpl_id']);
                        if(!($template instanceof ilMailTemplate))
                        {
                                ilUtil::sendFailure($this->lng->txt('mail_template_missing_id'));
                                $this->showTemplates();
                                return;
                        }
 
                        $form = $this->getTemplateForm($template);
                        $this->populateFormWithTemplate($form, $template);
                }
 
                $this->tpl->setContent($form->getHTML());
        }

References $_GET, $form, getTemplateForm(), populateFormWithTemplate(), ilUtil\sendFailure(), and showTemplates().

Referenced by updateTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

showInsertTemplateForm()

ilMailTemplateGUI::showInsertTemplateForm ( ilPropertyFormGUI  $form = NULL )

protected

Parameters

ilPropertyFormGUI

$form

Definition at line 164 of file class.ilMailTemplateGUI.php.

        {
                if(!($form instanceof ilPropertyFormGUI))
                {
                        $form = $this->getTemplateForm();
                }
                $this->tpl->setContent($form->getHTML());
        }

References $form, and getTemplateForm().

Referenced by insertTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

showTemplates()

ilMailTemplateGUI::showTemplates ( )

protected

Definition at line 90 of file class.ilMailTemplateGUI.php.

        {
                require_once 'Services/UIComponent/Button/classes/class.ilLinkButton.php';
                require_once 'Services/Mail/classes/class.ilMailTemplateTableGUI.php';
 
                $contexts = ilMailTemplateService::getTemplateContexts();
                if(count($contexts) <= 1)
                {
                        ilUtil::sendFailure($this->lng->txt('mail_template_no_context_available'));
                }
                else
                {
                        $create_tpl_button = ilLinkButton::getInstance();
                        $create_tpl_button->setCaption('mail_new_template');
                        $create_tpl_button->setUrl($this->ctrl->getLinkTarget($this, 'showInsertTemplateForm'));
                        $this->toolbar->addButtonInstance($create_tpl_button);
                }
 
                $tbl = new ilMailTemplateTableGUI($this, 'showTemplates');
                $tbl->setData($this->provider->getTableData());
 
                $this->tpl->setContent($tbl->getHTML());
        }

References $tbl, ilLinkButton\getInstance(), ilMailTemplateService\getTemplateContexts(), and ilUtil\sendFailure().

Referenced by confirmDeleteTemplate(), deleteTemplate(), showEditTemplateForm(), and updateTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

updateTemplate()

ilMailTemplateGUI::updateTemplate ( )

protected

Definition at line 176 of file class.ilMailTemplateGUI.php.

        {
                if(!isset($_POST['tpl_id']) || !strlen($_POST['tpl_id']))
                {
                        ilUtil::sendFailure($this->lng->txt('mail_template_missing_id'));
                        $this->showTemplates();
                        return;
                }
 
                $template = $this->provider->getTemplateById((int)$_POST['tpl_id']);
                if(!($template instanceof ilMailTemplate))
                {
                        ilUtil::sendFailure($this->lng->txt('mail_template_missing_id'));
                        $this->showTemplates();
                        return;
                }
 
                $form = $this->getTemplateForm();
                if(!$form->checkInput())
                {
                        $form->setValuesByPost();
                        $this->showEditTemplateForm($form);
                        return;
                }
 
                $generic_context = new ilMailTemplateGenericContext();
                if($form->getInput('context') == $generic_context->getId())
                {
                        $form->getItemByPostVar('context')->setAlert($this->lng->txt('mail_template_no_valid_context'));
                        $form->setValuesByPost();
                        $this->showEditTemplateForm($form);
                        return;
                }
 
                try
                {
                        $context = ilMailTemplateService::getTemplateContextById($form->getInput('context'));
                        $template->setTitle($form->getInput('title'));
                        $template->setContext($context->getId());
                        $template->setLang($form->getInput('lang'));
                        $template->setSubject($form->getInput('m_subject'));
                        $template->setMessage($form->getInput('m_message'));
                        $template->update();
 
                        ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
                        $this->ctrl->redirect($this, 'showTemplates');
                }
                catch(Exception $e)
                {
                        $form->getItemByPostVar('context')->setAlert($this->lng->txt('mail_template_no_valid_context'));
                        ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
                }
 
                $form->setValuesByPost();
                $this->showEditTemplateForm($form);
        }

References $_POST, $form, ilMailTemplateService\getTemplateContextById(), getTemplateForm(), ilUtil\sendFailure(), ilUtil\sendSuccess(), showEditTemplateForm(), and showTemplates().

Here is the call graph for this function:

Field Documentation

$ctrl

ilMailTemplateGUI::$ctrl

protected

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

$form

ilMailTemplateGUI::$form

protected

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

Referenced by getTemplateForm(), insertTemplate(), populateFormWithTemplate(), showEditTemplateForm(), showInsertTemplateForm(), and updateTemplate().

$lng

ilMailTemplateGUI::$lng

protected

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

$toolbar

ilMailTemplateGUI::$toolbar

protected

Definition at line 41 of file class.ilMailTemplateGUI.php.

$tpl

ilMailTemplateGUI::$tpl

protected

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

---

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

• Services/Mail/classes/class.ilMailTemplateGUI.php