ilMDEditorGUI Class Reference

Collaboration diagram for ilMDEditorGUI:

Public Member Functions
	__construct (int $obj_id, int $sub_id, string $type)
	executeCommand ()
	debug ()
	listSection ()
	listQuickEdit ()
	updateQuickEdit ()
	addObserver (object $a_class, string $a_method, string $a_element)
	callListeners (string $a_element)

Data Fields
const string	SET_FOR_TREE = 'md_set_for_tree'
const string	PATH_FOR_TREE = 'md_path_for_tree'
string	$type

Protected Member Functions
	renderDigest (SetInterface $set, Digest $digest, ?RequestForFormInterface $request=null)
	fullEditorCreate ()
	fullEditorUpdate ()
	fullEditorEdit (bool $create)
	fullEditorDelete ()
	fullEditor ()
	renderFullEditor (SetInterface $set, PathInterface $base_path, FullEditor $full_editor, ?RequestForFormInterface $request=null)
	setTabsForFullEditor ()
	addButtonToFullEditor ()
	checkAccess ()

Protected Attributes
FullEditorInitiator	$full_editor_initiator
DigestInitiator	$digest_initiator
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
Renderer	$ui_renderer
PresenterInterface	$presenter
RepositoryInterface	$repository
RequestParserInterface	$request_parser
ObserverHandler	$observer_handler
ilAccessHandler	$access
ilToolbarGUI	$toolbar
GlobalScreen	$global_screen
ilTabsGUI	$tabs
UIFactory	$ui_factory
XMLWriter	$xml_writer
int	$obj_id
int	$sub_id

Detailed Description

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 45 of file class.ilMDEditorGUI.php.

Constructor & Destructor Documentation

__construct()

ilMDEditorGUI::__construct	(	int	$obj_id,
		int	$sub_id,
		string	$type
	)

Definition at line 71 of file class.ilMDEditorGUI.php.

References $DIC, $obj_id, $sub_id, $type, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\UI\examples\Deck\repository(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $services = new InternalServices($DIC);
        $this->full_editor_initiator = new FullEditorInitiator($services);
        $this->digest_initiator = new DigestInitiator($services);

        $this->ctrl = $services->dic()->ctrl();
        $this->tpl = $services->dic()->ui()->mainTemplate();
        $this->ui_renderer = $services->dic()->ui()->renderer();
        $this->presenter = $services->editor()->presenter();
        $this->request_parser = $services->editor()->requestParser();
        $this->repository = $services->repository()->repository();
        $this->observer_handler = $services->editor()->observerHandler();
        $this->access = $services->dic()->access();
        $this->toolbar = $services->dic()->toolbar();
        $this->global_screen = $services->dic()->globalScreen();
        $this->tabs = $services->dic()->tabs();
        $this->ui_factory = $services->dic()->ui()->factory();
        $this->xml_writer = $services->xml()->standardWriter();

        $this->obj_id = $obj_id;
        $this->sub_id = $sub_id === 0 ? $obj_id : $sub_id;
        $this->type = $type;
    }

Here is the call graph for this function:

Member Function Documentation

addButtonToFullEditor()

ilMDEditorGUI::addButtonToFullEditor ( )

protected

Definition at line 387 of file class.ilMDEditorGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\toolbar().

Referenced by debug(), and renderDigest().

                                              : void
    {
        $editor = $this->ui_factory->button()->standard(
            $this->presenter->utilities()->txt('meta_button_to_full_editor_label'),
            $this->ctrl->getLinkTarget($this, 'fullEditor')
        );
        $this->toolbar->addComponent($editor);
        if (DEVMODE) {
            $debug = $this->ui_factory->button()->standard(
                'Debug',
                $this->ctrl->getLinkTarget($this, 'debug')
            );
            $this->toolbar->addComponent($debug);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addObserver()

ilMDEditorGUI::addObserver	(	object	$a_class,
		string	$a_method,
		string	$a_element
	)

Definition at line 429 of file class.ilMDEditorGUI.php.

Referenced by ilObjContentPageGUI\setTabs().

                                                                                     : void
    {
        $this->observer_handler->addObserver($a_class, $a_method, $a_element);
    }

Here is the caller graph for this function:

callListeners()

ilMDEditorGUI::callListeners

(

string

$a_element

)

Definition at line 434 of file class.ilMDEditorGUI.php.

Referenced by updateQuickEdit().

                                                    : void
    {
        $this->observer_handler->callObservers($a_element);
    }

Here is the caller graph for this function:

checkAccess()

ilMDEditorGUI::checkAccess ( )

protected

Definition at line 403 of file class.ilMDEditorGUI.php.

References $ref_id, ilObject\_getAllReferences(), and ILIAS\Repository\access().

Referenced by fullEditorDelete(), fullEditorEdit(), and updateQuickEdit().

                                    : void
    {
        // if there is no fixed parent (e.g. mob), then skip
        if ($this->obj_id === 0) {
            return;
        }
        $ref_ids = ilObject::_getAllReferences($this->obj_id);
        // if there are no references (e.g. in workspace), then skip
        if (empty($ref_ids)) {
            return;
        }
        foreach ($ref_ids as $ref_id) {
            if ($this->access->checkAccess(
                'write',
                '',
                $ref_id,
                '',
                $this->obj_id
            )) {
                return;
            }
        }
        throw new ilPermissionException($this->presenter->utilities()->txt('permission_denied'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

debug()

ilMDEditorGUI::debug

(

)

Definition at line 113 of file class.ilMDEditorGUI.php.

References addButtonToFullEditor(), and ILIAS\UI\examples\Deck\repository().

                           : bool
    {
        $xml = $this->xml_writer->write($this->repository->getMD($this->obj_id, $this->sub_id, $this->type));
        $dom = new DOMDocument('1.0');
        $dom->formatOutput = true;
        $dom->preserveWhiteSpace = false;
        $dom->loadXML($xml->asXML());

        $this->addButtonToFullEditor();
        $this->tpl->setContent('<pre>' . htmlentities($dom->saveXML()) . '</pre>');
        return true;
    }

Here is the call graph for this function:

executeCommand()

ilMDEditorGUI::executeCommand

(

)

Definition at line 98 of file class.ilMDEditorGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);

        $cmd = $this->ctrl->getCmd();
        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = "listQuickEdit";
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

fullEditor()

ilMDEditorGUI::fullEditor ( )

protected

Definition at line 308 of file class.ilMDEditorGUI.php.

References renderFullEditor(), ILIAS\UI\examples\Deck\repository(), and setTabsForFullEditor().

                                   : void
    {
        $this->setTabsForFullEditor();

        // get the paths from the http request
        $base_path = $this->request_parser->fetchBasePath();

        // get and prepare the MD
        $set = $this->repository->getMD(
            $this->obj_id,
            $this->sub_id,
            $this->type
        );
        $editor = $this->full_editor_initiator->init();
        $set = $editor->manipulateMD()->prepare($set, $base_path);

        // add content for element
        $this->renderFullEditor($set, $base_path, $editor);
    }

Here is the call graph for this function:

fullEditorCreate()

ilMDEditorGUI::fullEditorCreate ( )

protected

Definition at line 202 of file class.ilMDEditorGUI.php.

References fullEditorEdit().

                                         : void
    {
        $this->fullEditorEdit(true);
    }

Here is the call graph for this function:

fullEditorDelete()

ilMDEditorGUI::fullEditorDelete ( )

protected

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

References checkAccess(), ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

                                         : void
    {
        $this->checkAccess();

        // get the paths from the http request
        $base_path = $this->request_parser->fetchBasePath();
        $delete_path = $this->request_parser->fetchActionPath();

        // get the MD
        $set = $this->repository->getMD(
            $this->obj_id,
            $this->sub_id,
            $this->type
        );
        $editor = $this->full_editor_initiator->init();

        // delete
        $base_path = $editor->manipulateMD()->deleteAndTrimBasePath(
            $set,
            $base_path,
            $delete_path
        );

        // call listeners
        $this->observer_handler->callObserversByPath($delete_path);

        // redirect back to the full editor
        $this->tpl->setOnScreenMessage(
            'success',
            $this->presenter->utilities()->txt('meta_delete_element_success'),
            true
        );
        $this->ctrl->setParameter(
            $this,
            Parameter::BASE_PATH->value,
            urlencode($base_path->toString())
        );
        $this->ctrl->redirect($this, 'fullEditor');
    }

Here is the call graph for this function:

fullEditorEdit()

ilMDEditorGUI::fullEditorEdit ( bool  $create )

protected

Definition at line 212 of file class.ilMDEditorGUI.php.

References checkAccess(), ILIAS\Repository\ctrl(), renderFullEditor(), and ILIAS\UI\examples\Deck\repository().

Referenced by fullEditorCreate(), and fullEditorUpdate().

                                                   : void
    {
        $this->checkAccess();

        // get the paths from the http request
        $base_path = $this->request_parser->fetchBasePath();
        $action_path = $this->request_parser->fetchActionPath();

        // get and prepare the MD
        $set = $this->repository->getMD(
            $this->obj_id,
            $this->sub_id,
            $this->type
        );
        $editor = $this->full_editor_initiator->init();
        $set = $editor->manipulateMD()->prepare($set, $base_path);

        // update or create
        $request = $this->request_parser->fetchRequestForForm(true);
        $success = $editor->manipulateMD()->createOrUpdate(
            $set,
            $base_path,
            $action_path,
            $request
        );
        if (!$success) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->presenter->utilities()->txt('msg_form_save_error'),
                true
            );
            $this->renderFullEditor($set, $base_path, $editor, $request);
            return;
        }

        // call listeners
        $this->observer_handler->callObserversByPath($action_path);

        // redirect back to the full editor
        $this->tpl->setOnScreenMessage(
            'success',
            $this->presenter->utilities()->txt(
                $create ?
                    'meta_add_element_success' :
                    'meta_edit_element_success'
            ),
            true
        );
        $this->ctrl->setParameter(
            $this,
            Parameter::BASE_PATH->value,
            urlencode($base_path->toString())
        );
        $this->ctrl->redirect($this, 'fullEditor');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fullEditorUpdate()

ilMDEditorGUI::fullEditorUpdate ( )

protected

Definition at line 207 of file class.ilMDEditorGUI.php.

References fullEditorEdit().

                                         : void
    {
        $this->fullEditorEdit(false);
    }

Here is the call graph for this function:

listQuickEdit()

ilMDEditorGUI::listQuickEdit

(

)

Definition at line 131 of file class.ilMDEditorGUI.php.

References renderDigest(), and ILIAS\UI\examples\Deck\repository().

Referenced by listSection().

                                   : void
    {
        $digest = $this->digest_initiator->init();
        $set = $this->repository->getMD(
            $this->obj_id,
            $this->sub_id,
            $this->type
        );

        $this->renderDigest($set, $digest);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listSection()

ilMDEditorGUI::listSection

(

)

Definition at line 126 of file class.ilMDEditorGUI.php.

References listQuickEdit().

                                 : void
    {
        $this->listQuickEdit();
    }

Here is the call graph for this function:

renderDigest()

ilMDEditorGUI::renderDigest ( SetInterface  $set, Digest  $digest, ?RequestForFormInterface  $request = null  )

protected

Definition at line 179 of file class.ilMDEditorGUI.php.

References addButtonToFullEditor(), ILIAS\MetaData\Editor\Digest\Digest\getContent(), and ILIAS\MetaData\Editor\Digest\MODAL.

Referenced by listQuickEdit(), and updateQuickEdit().

     : void {
        $content = $digest->getContent($set, $request);
        $template_content = [];
        foreach ($content as $type => $entity) {
            switch ($type) {
                case DigestContentType::FORM:
                case DigestContentType::MODAL:
                    $template_content[] = $entity;
                    break;

                case DigestContentType::JS_SOURCE:
                    $this->tpl->addJavaScript($entity);
                    break;
            }
        }
        $this->addButtonToFullEditor();
        $this->tpl->setContent($this->ui_renderer->render($template_content));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderFullEditor()

ilMDEditorGUI::renderFullEditor ( SetInterface  $set, PathInterface  $base_path, FullEditor  $full_editor, ?RequestForFormInterface  $request = null  )

protected

Definition at line 328 of file class.ilMDEditorGUI.php.

References ILIAS\MetaData\Editor\Full\FullEditor\getContent(), ILIAS\MetaData\Editor\Digest\MODAL, and ILIAS\Repository\toolbar().

Referenced by fullEditor(), and fullEditorEdit().

     : void {
        // add slate with tree
        $this->global_screen->tool()->context()->current()->addAdditionalData(
            self::SET_FOR_TREE,
            $set
        );
        $this->global_screen->tool()->context()->current()->addAdditionalData(
            self::PATH_FOR_TREE,
            $base_path
        );

        // render toolbar, modals and main content
        $content = $full_editor->getContent($set, $base_path, $request);
        $template_content = [];
        foreach ($content as $type => $entity) {
            switch ($type) {
                case FullContentType::MAIN:
                    if ($entity instanceof Table) {
                        $entity = $this->ui_factory->legacy()->content(
                            $entity->getHTML()
                        );
                    }
                    $template_content[] = $entity;
                    break;

                case FullContentType::MODAL:
                    if ($modal = $entity->getModal()) {
                        $template_content[] = $modal;
                    }
                    break;

                case FullContentType::TOOLBAR:
                    $this->toolbar->addComponent($entity);
                    break;
            }
        }
        $this->tpl->setContent($this->ui_renderer->render($template_content));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabsForFullEditor()

ilMDEditorGUI::setTabsForFullEditor ( )

protected

Definition at line 372 of file class.ilMDEditorGUI.php.

References ILIAS\Repository\ctrl(), null, and ILIAS\Repository\tabs().

Referenced by fullEditor().

                                             : void
    {
        $this->tabs->clearSubTabs();
        foreach ($this->tabs->target as $tab) {
            if (($tab['id'] ?? null) !== $this->tabs->getActiveTab()) {
                $this->tabs->removeTab($tab['id']);
            }
        }
        $this->tabs->removeNonTabbedLinks();
        $this->tabs->setBackTarget(
            $this->presenter->utilities()->txt('back'),
            $this->ctrl->getLinkTarget($this, 'listQuickEdit')
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateQuickEdit()

ilMDEditorGUI::updateQuickEdit

(

)

Definition at line 143 of file class.ilMDEditorGUI.php.

References callListeners(), checkAccess(), ILIAS\Repository\ctrl(), renderDigest(), and ILIAS\UI\examples\Deck\repository().

                                     : void
    {
        $this->checkAccess();

        $digest = $this->digest_initiator->init();
        $set = $this->repository->getMD(
            $this->obj_id,
            $this->sub_id,
            $this->type
        );

        $request = $this->request_parser->fetchRequestForForm(false);
        if (!$digest->updateMD($set, $request)) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->presenter->utilities()->txt('msg_form_save_error'),
                true
            );
            $this->renderDigest($set, $digest, $request);
            return;
        }

        $this->callListeners('General');
        $this->callListeners('Rights');
        $this->callListeners('Educational');
        $this->callListeners('Lifecycle');

        // Redirect here to read new title and description
        $this->tpl->setOnScreenMessage(
            'success',
            $this->presenter->utilities()->txt("saved_successfully"),
            true
        );
        $this->ctrl->redirect($this, 'listQuickEdit');
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilMDEditorGUI::$access

protected

Definition at line 60 of file class.ilMDEditorGUI.php.

$ctrl

ilCtrl ilMDEditorGUI::$ctrl

protected

Definition at line 53 of file class.ilMDEditorGUI.php.

$digest_initiator

DigestInitiator ilMDEditorGUI::$digest_initiator

protected

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

$full_editor_initiator

FullEditorInitiator ilMDEditorGUI::$full_editor_initiator

protected

Definition at line 50 of file class.ilMDEditorGUI.php.

$global_screen

GlobalScreen ilMDEditorGUI::$global_screen

protected

Definition at line 62 of file class.ilMDEditorGUI.php.

$obj_id

int ilMDEditorGUI::$obj_id

protected

Definition at line 67 of file class.ilMDEditorGUI.php.

Referenced by __construct().

$observer_handler

ObserverHandler ilMDEditorGUI::$observer_handler

protected

Definition at line 59 of file class.ilMDEditorGUI.php.

$presenter

PresenterInterface ilMDEditorGUI::$presenter

protected

Definition at line 56 of file class.ilMDEditorGUI.php.

$repository

RepositoryInterface ilMDEditorGUI::$repository

protected

Definition at line 57 of file class.ilMDEditorGUI.php.

$request_parser

RequestParserInterface ilMDEditorGUI::$request_parser

protected

Definition at line 58 of file class.ilMDEditorGUI.php.

$sub_id

int ilMDEditorGUI::$sub_id

protected

Definition at line 68 of file class.ilMDEditorGUI.php.

Referenced by __construct().

$tabs

ilTabsGUI ilMDEditorGUI::$tabs

protected

Definition at line 63 of file class.ilMDEditorGUI.php.

$toolbar

ilToolbarGUI ilMDEditorGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilMDEditorGUI::$tpl

protected

Definition at line 54 of file class.ilMDEditorGUI.php.

$type

string ilMDEditorGUI::$type

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

Referenced by __construct().

$ui_factory

UIFactory ilMDEditorGUI::$ui_factory

protected

Definition at line 64 of file class.ilMDEditorGUI.php.

$ui_renderer

Renderer ilMDEditorGUI::$ui_renderer

protected

Definition at line 55 of file class.ilMDEditorGUI.php.

$xml_writer

XMLWriter ilMDEditorGUI::$xml_writer

protected

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

PATH_FOR_TREE

const string ilMDEditorGUI::PATH_FOR_TREE = 'md_path_for_tree'

Definition at line 48 of file class.ilMDEditorGUI.php.

Referenced by ILIAS\MetaData\Editor\Tree\MDEditorToolProvider\getToolsForContextStack().

SET_FOR_TREE

const string ilMDEditorGUI::SET_FOR_TREE = 'md_set_for_tree'

Definition at line 47 of file class.ilMDEditorGUI.php.

Referenced by ILIAS\MetaData\Editor\Tree\MDEditorToolProvider\getToolsForContextStack().

---

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

• components/ILIAS/MetaData/classes/Editor/class.ilMDEditorGUI.php