ilWorkflowEngineDefinitionsGUI Class Reference

Class ilWorkflowEngineDefinitionsGUI. More...

Collaboration diagram for ilWorkflowEngineDefinitionsGUI:

Public Member Functions
	__construct (ilObjWorkflowEngineGUI $parent_gui, \ILIAS\DI\Container $dic=null)
	ilWorkflowEngineDefinitionsGUI constructor. More...
	handle ($command)
	Handle the command given. More...
	showDefinitionsTable ()
	applyFilter ()
	resetFilter ()
	showUploadForm ()
	initToolbar ()
	stopListening ()
	deleteDefinition ()
	confirmDeleteDefinition ()

Protected Member Functions
	processUploadFormCancellation ()

Protected Attributes
	$parent_gui
	$dic

Private Member Functions
	ensureProcessIdInRequest ()
	getProcessIdFromRequest ()

Detailed Description

Class ilWorkflowEngineDefinitionsGUI.

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

/

Definition at line 13 of file class.ilWorkflowEngineDefinitionsGUI.php.

Constructor & Destructor Documentation

__construct()

ilWorkflowEngineDefinitionsGUI::__construct	(	ilObjWorkflowEngineGUI	$parent_gui,
		\ILIAS\DI\Container	$dic = null
	)

ilWorkflowEngineDefinitionsGUI constructor.

Parameters

ilObjWorkflowEngineGUI	$parent_gui

Definition at line 29 of file class.ilWorkflowEngineDefinitionsGUI.php.

References $dic, $GLOBALS, and $parent_gui.

    {
        $this->parent_gui = $parent_gui;

        if ($dic === null) {
            $dic = $GLOBALS['DIC'];
        }
        $this->dic = $dic;
    }

Member Function Documentation

applyFilter()

ilWorkflowEngineDefinitionsGUI::applyFilter

(

)

Returns

string HTML

Definition at line 109 of file class.ilWorkflowEngineDefinitionsGUI.php.

References showDefinitionsTable().

Referenced by handle().

    {
        require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsTableGUI.php';
        $table_gui = new ilWorkflowEngineDefinitionsTableGUI($this->parent_gui, 'definitions.view');
        $table_gui->writeFilterToSession();
        $table_gui->resetOffset();

        return $this->showDefinitionsTable();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteDefinition()

ilWorkflowEngineDefinitionsGUI::confirmDeleteDefinition

(

)

Returns

string

Definition at line 485 of file class.ilWorkflowEngineDefinitionsGUI.php.

References ensureProcessIdInRequest(), ilWorkflowDefinitionRepository\getById(), getProcessIdFromRequest(), and ilObjWorkflowEngine\getRepositoryDir().

Referenced by handle().

    {
        $this->ensureProcessIdInRequest();

        $processId = $this->getProcessIdFromRequest();

        require_once 'Services/WorkflowEngine/classes/administration/class.ilWorkflowDefinitionRepository.php';
        $repository = new ilWorkflowDefinitionRepository(
            $this->dic->database(),
            $this->dic->filesystem(),
            ilObjWorkflowEngine::getRepositoryDir(true)
        );
        $processDefinition = $repository->getById($processId);

        require_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirmation = new ilConfirmationGUI();
        $confirmation->addItem('process_id[]', $processDefinition['id'], $processDefinition['title']);
        $this->parent_gui->ilCtrl->setParameter($this->parent_gui, 'process_id', $processDefinition['id']);
        $confirmation->setFormAction($this->parent_gui->ilCtrl->getFormAction($this->parent_gui, 'definitions.view'));
        $confirmation->setHeaderText($this->parent_gui->lng->txt('wfe_sure_to_delete_process_def'));
        $confirmation->setConfirm($this->parent_gui->lng->txt('confirm'), 'definitions.delete');
        $confirmation->setCancel($this->parent_gui->lng->txt('cancel'), 'definitions.view');

        return $confirmation->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteDefinition()

ilWorkflowEngineDefinitionsGUI::deleteDefinition

(

)

Returns

void

Definition at line 458 of file class.ilWorkflowEngineDefinitionsGUI.php.

References ensureProcessIdInRequest(), getProcessIdFromRequest(), ilObjWorkflowEngine\getRepositoryDir(), ilUtil\redirect(), and ilUtil\sendSuccess().

Referenced by handle().

    {
        $this->ensureProcessIdInRequest();

        $processId = $this->getProcessIdFromRequest();

        $pathToProcessPhpFile   = ilObjWorkflowEngine::getRepositoryDir() . '/' . $processId . '.php';
        $pathToProcessBpmn2File = ilObjWorkflowEngine::getRepositoryDir() . '/' . $processId . '.bpmn2';

        if (file_exists($pathToProcessPhpFile)) {
            unlink($pathToProcessPhpFile);
        }
        if (file_exists($pathToProcessBpmn2File)) {
            unlink($pathToProcessBpmn2File);
        }

        ilUtil::sendSuccess($this->parent_gui->lng->txt('definition_deleted'), true);
        ilUtil::redirect(
            html_entity_decode(
                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureProcessIdInRequest()

ilWorkflowEngineDefinitionsGUI::ensureProcessIdInRequest ( )

private

Definition at line 437 of file class.ilWorkflowEngineDefinitionsGUI.php.

References ilUtil\sendInfo().

Referenced by confirmDeleteDefinition(), and deleteDefinition().

    {
        if (!isset($this->dic->http()->request()->getQueryParams()['process_id'])) {
            ilUtil::sendInfo($this->parent_gui->lng->txt('wfe_request_missing_process_id'));
            $this->parent_gui->ilCtrl->redirect($this->parent_gui, 'definitions.view');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProcessIdFromRequest()

ilWorkflowEngineDefinitionsGUI::getProcessIdFromRequest ( )

private

Returns

string

Definition at line 448 of file class.ilWorkflowEngineDefinitionsGUI.php.

Referenced by confirmDeleteDefinition(), and deleteDefinition().

    {
        $processId = str_replace(['\\', '/'], '', stripslashes($this->dic->http()->request()->getQueryParams()['process_id']));

        return basename($processId);
    }

Here is the caller graph for this function:

handle()

ilWorkflowEngineDefinitionsGUI::handle

(

$command

)

Handle the command given.

Parameters

string

$command

Returns

string HTML

Definition at line 46 of file class.ilWorkflowEngineDefinitionsGUI.php.

References applyFilter(), confirmDeleteDefinition(), deleteDefinition(), resetFilter(), showDefinitionsTable(), showUploadForm(), and stopListening().

    {
        switch (strtolower($command)) {
            case 'uploadform':
                return $this->showUploadForm();
                break;

            case 'upload':
                return $this->handleUploadSubmit();
                break;

            case 'applyfilter':
                return $this->applyFilter();
                break;

            case 'resetfilter':
                return $this->resetFilter();
                break;

            case 'start':
                return $this->startProcess();
                break;

            case 'delete':
                return $this->deleteDefinition();
                break;

            case 'confirmdelete':
                return $this->confirmDeleteDefinition();
                break;

            case 'startlistening':
                return $this->startListening();
                break;

            case'stoplistening':
                return $this->stopListening();
                break;

            case 'view':
            default:
                return $this->showDefinitionsTable();
        }
    }

Here is the call graph for this function:

initToolbar()

ilWorkflowEngineDefinitionsGUI::initToolbar

(

)

Returns

void

Definition at line 255 of file class.ilWorkflowEngineDefinitionsGUI.php.

References ilLinkButton\getInstance().

Referenced by showDefinitionsTable().

    {
        require_once './Services/UIComponent/Button/classes/class.ilLinkButton.php';
        $upload_wizard_button = ilLinkButton::getInstance();
        $upload_wizard_button->setCaption($this->parent_gui->lng->txt('upload_process'), false);
        $upload_wizard_button->setUrl(
            $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.uploadform')
        );
        $this->parent_gui->ilToolbar->addButtonInstance($upload_wizard_button);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

processUploadFormCancellation()

ilWorkflowEngineDefinitionsGUI::processUploadFormCancellation ( )

protected

Returns

void

Definition at line 269 of file class.ilWorkflowEngineDefinitionsGUI.php.

References $_GET, $_POST, $action, $form, array, ilObjWorkflowEngine\getRepositoryDir(), ilUtil\redirect(), ilUtil\sendInfo(), and ilUtil\sendSuccess().

Referenced by showUploadForm().

    {
        if (isset($_POST['cmd']['cancel'])) {
            ilUtil::sendInfo($this->parent_gui->lng->txt('action_aborted'), true);
            ilUtil::redirect(
                html_entity_decode(
                        $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                    )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilter()

ilWorkflowEngineDefinitionsGUI::resetFilter

(

)

Returns

string HTML

Definition at line 122 of file class.ilWorkflowEngineDefinitionsGUI.php.

References showDefinitionsTable().

Referenced by handle().

    {
        require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsTableGUI.php';
        $table_gui = new ilWorkflowEngineDefinitionsTableGUI($this->parent_gui, 'definitions.view');
        $table_gui->resetOffset();
        $table_gui->resetFilter();

        return $this->showDefinitionsTable();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showDefinitionsTable()

ilWorkflowEngineDefinitionsGUI::showDefinitionsTable

(

)

Returns

string HTML

Definition at line 94 of file class.ilWorkflowEngineDefinitionsGUI.php.

References initToolbar().

Referenced by applyFilter(), handle(), and resetFilter().

    {
        $this->initToolbar();
        require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsTableGUI.php';
        $table_gui = new ilWorkflowEngineDefinitionsTableGUI($this->parent_gui, 'definitions.view');
        $table_gui->setFilterCommand("definitions.applyfilter");
        $table_gui->setResetCommand("definitions.resetFilter");
        $table_gui->setDisableFilterHiding(false);

        return $table_gui->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showUploadForm()

ilWorkflowEngineDefinitionsGUI::showUploadForm

(

)

Returns

string

Definition at line 135 of file class.ilWorkflowEngineDefinitionsGUI.php.

References $code, $file, $form, $parser, $version, ilObjWorkflowEngine\getRepositoryDir(), ilObjWorkflowEngine\getTempDir(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, processUploadFormCancellation(), ilUtil\redirect(), and ilUtil\sendSuccess().

Referenced by handle().

    {
        require_once './Services/WorkflowEngine/classes/administration/class.ilUploadDefinitionForm.php';
        $form_definition = new ilUploadDefinitionForm();
        $form = $form_definition->getForm(
            $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.upload')
        );

        return $form->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stopListening()

ilWorkflowEngineDefinitionsGUI::stopListening

(

)

Definition at line 346 of file class.ilWorkflowEngineDefinitionsGUI.php.

References $_GET, $_POST, $action, $form, array, ilObjWorkflowEngine\getRepositoryDir(), ilUtil\redirect(), ilUtil\sendInfo(), ilUtil\sendSuccess(), and ilUtil\stripSlashes().

Referenced by handle().

    {
        $process_id = ilUtil::stripSlashes($_GET['process_id']);

        require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
        ilWorkflowDbHelper::deleteStartEventData($process_id);

        ilUtil::sendSuccess($this->parent_gui->lng->txt('wfe_stopped_listening'), true);
        ilUtil::redirect(
            html_entity_decode(
                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$dic

ilWorkflowEngineDefinitionsGUI::$dic

protected

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

Referenced by __construct().

$parent_gui

ilWorkflowEngineDefinitionsGUI::$parent_gui

protected

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

Referenced by __construct().

---

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

• Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsGUI.php