ilDclDetailedViewDefinitionGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDclDetailedViewDefinitionGUI:

Collaboration diagram for ilDclDetailedViewDefinitionGUI:

Public Member Functions
	__construct (int $tableview_id)
	executeCommand ()
	execute command More...
	showPage ()
	display content of page More...
	confirmDelete ()
	cancelDelete ()
	deleteView ()
	postOutputProcessing (string $a_output)
	Finalizing output processing. More...
Public Member Functions inherited from ilPageObjectGUI
	__construct (string $a_parent_type, int $a_id, int $a_old_nr=0, bool $a_prevent_get_id=false, string $a_lang="", string $concrete_lang="")
	setTemplate (ilGlobalTemplateInterface $main_tpl)
	afterConstructor ()
	setAdvMdRecordObject (int $a_adv_ref_id, string $a_adv_type, string $a_adv_subtype="-")
	Set object, that defines the adv md records being used. More...
	getAdvMdRecordObject ()
	Get adv md record type. More...
	setParentType (string $a_val)
	getParentType ()
	setId (int $a_val)
	getId ()
	setOldNr (int $a_val)
	Set old nr (historic page) More...
	getOldNr ()
	setLanguage (string $a_val)
	getLanguage ()
	setEnablePCType (string $a_pc_type, bool $a_val)
	getEnablePCType (string $a_pc_type)
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setPageObject (ilPageObject $a_pg_obj)
	getPageObject ()
	setOutputMode (string $a_mode=self::PRESENTATION)
	getOutputMode ()
	setTemplateOutput (bool $a_output=true)
	outputToTemplate ()
	setPresentationTitle (string $a_title="")
	getPresentationTitle ()
	setHeader (string $a_title="")
	getHeader ()
	setLinkParams (string $l_params="")
	getLinkParams ()
	setLinkFrame (string $l_frame="")
	getLinkFrame ()
	setPageLinker (\ILIAS\COPage\PageLinker $page_linker)
	getLinkXML ()
	setQuestionHTML (array $question_html)
	getQuestionHTML ()
	setTemplateTargetVar (string $a_variable)
	getTemplateTargetVar ()
	getTemplateOutputVar ()
	setSourcecodeDownloadScript (string $script_name)
	getSourcecodeDownloadScript ()
	setTabs (ilTabsGUI $a_tabs)
	setPageBackTitle (string $a_title)
	setFileDownloadLink (string $a_download_link)
	getFileDownloadLink ()
	setFullscreenLink (string $a_fullscreen_link)
	getFullscreenLink ()
	setIntLinkReturn (string $a_return)
	enableChangeComments (bool $a_enabled)
	isEnabledChangeComments ()
	enableNotes (bool $a_enabled, int $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory (string $offdir)
	getOfflineDirectory ()
	setViewPageLink (string $a_link, string $a_target="")
	set link for "view page" button More...
	getViewPageLink ()
	getViewPageTarget ()
	getViewPageText ()
	setActivationListener (object $a_obj, string $a_meth)
	setEnabledNews (bool $a_enabled, int $a_news_obj_id=0, string $a_news_obj_type="")
	getEnabledNews ()
	setTabHook (object $a_object, string $a_function)
	setEditPreview (bool $a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	getEditPreview ()
	setEnabledTabs (bool $a_enabledtabs)
	getEnabledTabs ()
	setEnabledPageFocus (bool $a_enabledpagefocus)
	setOpenPlaceHolder (string $a_val)
	getOpenPlaceHolder ()
	getEnabledPageFocus ()
	setPrependingHtml (string $a_prependinghtml)
	getPrependingHtml ()
	setEnableEditing (bool $a_enableediting)
	getEnableEditing ()
	setRawPageContent (bool $a_rawpagecontent)
	Set Get raw page content only. More...
	getRawPageContent ()
	setStyleId (int $a_styleid)
	getStyleId ()
	setCompareMode (bool $a_val)
	getCompareMode ()
	setAbstractOnly (bool $a_val, string $pcid="")
	Get only abstract (first text paragraph) More...
	getAbstractOnly ()
	setRenderPageContainer (bool $a_val)
	getRenderPageContainer ()
	getDisabledText ()
	getEnabledHref ()
	setEnabledHref (bool $enable)
	activateMetaDataEditor (ilObject $a_rep_obj, string $a_type, int $a_sub_obj_id, object $a_observer_obj=null, string $a_observer_func="")
	Activate meda data editor. More...
	determineFileDownloadLink ()
	determineFullscreenLink ()
	determineSourcecodeDownloadScript ()
	getComponentPluginsXML ()
	Put information about activated plugins into XML. More...
	executeCommand ()
	execute command More...
	setQEditTabs (string $a_active)
	Set question editing tabs. More...
	onFeedbackEditingForwarding ()
	deactivatePage ()
	activatePage ()
	showPage ()
	display content of page More...
	replaceCurlyBrackets (string $output)
	getActivationCaptions ()
	Get captions for activation action menu entries. More...
	setEditMode ()
	Set edit mode. More...
	setDefaultLinkXml ()
	setLinkXml (string $xml)
	getProfileBackUrl ()
	setProfileBackUrl (string $url)
	downloadFile ()
	displayMediaFullscreen ()
	displayMedia (bool $a_fullscreen=false)
	download_paragraph ()
	download source code paragraph More...
	insertPageToc (string $a_output)
	insertResources (string $a_output)
	insertAdvTrigger (string $a_output)
	Insert adv content trigger. More...
	postOutputProcessing (string $a_output)
	Finalizing output processing. More...
	previewHistory ()
	Preview history. More...
	preview ()
	edit ()
	getBlockingInfoMessage ()
	insertJSAtPlaceholder ()
	presentation (string $a_mode=self::PRESENTATION)
	getHTML ()
	showMediaFullscreen (int $a_style_id=0)
	show fullscreen view of media object More...
	displayValidationError ($a_error)
	display validation error More...
	history ()
	Get history table as HTML. More...
	rollbackConfirmation ()
	Rollback confirmation. More...
	rollback ()
	Rollback to a previous version. More...
	setScreenIdComponent ()
	getTabs (string $a_activate="")
	compareVersion ()
	Compares two revisions of the page. More...
	replaceDiffTags (string $a_html)
	editActivation ()
	Edit activation (only, if scheduled page activation is activated in administration) More...
	initActivationForm ()
	Init activation form. More...
	getActivationFormValues ()
	Get values for activation form. More...
	saveActivation ()
	Save Activation. More...
	getNotesHTML (object $a_content_object=null, bool $a_enable_private_notes=true, bool $a_enable_public_notes=false, bool $a_enable_notes_deletion=false, callable $a_callback=null, bool $export=false)
	Get html for public and/or private notes. More...
	processAnswer ()
	Process answer. More...
	initialOpenedContent ()
	Initially opened content. More...
	initOpenedContentForm ()
	saveInitialOpenedContent ()
	switchToLanguage ()
	Switch to language. More...
	confirmPageTranslationCreation ()
	Confirm page translation creation. More...
	editMasterLanguage ()
	Edit master language. More...
	createPageTranslation ()
	Create page translation. More...
	releasePageLock ()
	Release page lock. More...
	finishEditing ()
	getPagePermaLink ()
	getAdditionalPageActions ()
	Get additional page actions. More...

Protected Member Functions
	activate ()
	deactivate ()
Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...
	showEditToolbar ()
	Show edit toolbar. More...
	setEditorToolContext ()
	Set editor tool context. More...
	initEditing ()
	showEditLockInfo ()
	setBackToEditTabs ()
	isPageContainerToBeRendered ()
	addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
	Add resources to template. More...

Protected Attributes
int	$tableview_id
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
Protected Attributes inherited from ilPageObjectGUI
int	$requested_ref_id
int	$requested_pg_id
string	$requested_file_id
string	$requested_transl
int	$requested_old_nr
EditGUIRequest	$request
EditSessionRepository	$edit_repo
string	$exp_target_script = ""
string	$exp_id = ""
string	$exp_frame = ""
string	$act_meth = ""
object	$act_obj
int	$notes_parent_id = 0
ilPropertyFormGUI	$form
int	$styleid = 0
bool	$enabledpagefocus
string	$link_xml
int	$old_nr = 0
int	$id
string	$language
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilAccessHandler	$access
ilLogger	$log
ilObjUser	$user
ilHelpGUI	$help
string	$output_mode = ""
string	$parent_type = ""
string	$file_download_link = ''
string	$fullscreen_link = ''
string	$link_frame = ''
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
ILIAS DI UIServices	$ui
ILIAS COPage PageLinker	$page_linker
string	$abstract_pcid = ""
ilToolbarGUI	$toolbar
string	$open_place_holder = ""
int	$requested_user_id = 0
int	$requested_q_id = 0
int	$requested_history_mode = 0
bool	$enabled_news = false
int	$news_obj_id = 0
string	$news_obj_type = ""
array	$tab_hook = null
string	$view_page_link = ""
string	$view_page_target = ""
string	$offline_directory = ""
bool	$notes_enabled = false
string	$prependinghtml = ""
string	$header = ""
string	$int_link_return = ""
bool	$enabled_href = true
int	$adv_ref_id = null
string	$adv_type = null
string	$adv_subtype = null
string	$concrete_lang = ""
string	$profile_back_url = ""
ilComponentFactory	$component_factory

Additional Inherited Members
Static Public Member Functions inherited from ilPageObjectGUI
static	getTinyMenu (string $a_par_type, bool $a_int_links=false, bool $a_wiki_links=false, bool $a_keywords=false, $a_style_id=0, $a_paragraph_styles=true, $a_save_return=true, $a_anchors=false, $a_save_new=true, $a_user_links=false, \ILIAS\COPage\Editor\Server\UIWrapper $ui_wrapper=null)
	Get Tiny Menu. More...
Data Fields inherited from ilPageObjectGUI
const	PRESENTATION = "presentation"
const	EDIT = "edit"
const	PREVIEW = "preview"
const	OFFLINE = "offline"
const	PRINTING = "print"
string	$page_back_title = ""
ilPageObject	$obj
string	$presentation_title = ""
string	$target_script = ""
string	$return_location = ""
string	$target_var = ""
string	$template_output_var = ""
bool	$output2template = false
string	$link_params = ""
string	$sourcecode_download_script = ""
bool	$change_comments = false
bool	$activation = false
bool	$activated = true
bool	$editpreview = false
bool	$use_meta_data = false
ilObject	$meta_data_rep_obj = null
int	$meta_data_sub_obj_id = 0
string	$meta_data_type = ""
object	$meta_data_observer_obj = null
string	$meta_data_observer_func = ""
bool	$link_xml_set = false
bool	$enableediting = true
bool	$rawpagecontent = false
bool	$enabledcontentincludes = false
bool	$compare_mode = false
ilPageConfig	$page_config = null
bool	$tabs_enabled = true
bool	$render_page_container = false
string	$pl_start = "{{{{{"
string	$pl_end = "}}}}}"

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning @ilCtrl_Calls ilDclDetailedViewDefinitionGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector @ilCtrl_Calls ilDclDetailedViewDefinitionGUI: ilPublicUserProfileGUI, ilPageObjectGUI

Definition at line 23 of file class.ilDclDetailedViewDefinitionGUI.php.

Constructor & Destructor Documentation

__construct()

ilDclDetailedViewDefinitionGUI::__construct

(

int

$tableview_id

)

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

    {
        global $DIC;
 
        $this->tableview_id = $tableview_id;
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        // we always need a page object - create on demand
        if (!ilPageObject::_exists('dclf', $tableview_id)) {
            $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
 
            $viewdef = new ilDclDetailedViewDefinition();
            $viewdef->setId($tableview_id);
            $viewdef->setParentId(ilObject2::_lookupObjectId($ref_id));
            $viewdef->setActive(false);
            $viewdef->create(false);
        }
 
        parent::__construct("dclf", $tableview_id);
 
        // content style (using system defaults)
        $this->tpl->setCurrentBlock("SyntaxStyle");
        $this->tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", ilObjStyleSheet::getSyntaxStylePath());
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->setCurrentBlock("ContentStyle");
        $this->tpl->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->parseCurrentBlock();
    }

References $DIC, $ref_id, $tableview_id, ILIAS\GlobalScreen\Provider\__construct(), ilPageObject\_exists(), ilObject\_lookupObjectId(), ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

activate()

ilDclDetailedViewDefinitionGUI::activate ( )

protected

Definition at line 120 of file class.ilDclDetailedViewDefinitionGUI.php.

                                 : void
    {
        $page = $this->getPageObject();
        $page->setActive(true);
        $page->update();
        $this->ctrl->redirect($this, 'edit');
    }

References ILIAS\Repository\ctrl(), and ilPageObjectGUI\getPageObject().

Here is the call graph for this function:

cancelDelete()

ilDclDetailedViewDefinitionGUI::cancelDelete

(

)

Definition at line 150 of file class.ilDclDetailedViewDefinitionGUI.php.

                                  : void
    {
        $this->ctrl->redirect($this, "edit");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

confirmDelete()

ilDclDetailedViewDefinitionGUI::confirmDelete

(

)

Definition at line 136 of file class.ilDclDetailedViewDefinitionGUI.php.

                                   : void
    {
        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this));
        $conf->setHeaderText($this->lng->txt('dcl_confirm_delete_detailed_view_title'));
 
        $conf->addItem('tableview', $this->tableview_id, $this->lng->txt('dcl_confirm_delete_detailed_view_text'));
 
        $conf->setConfirm($this->lng->txt('delete'), 'deleteView');
        $conf->setCancel($this->lng->txt('cancel'), 'cancelDelete');
 
        $this->tpl->setContent($conf->getHTML());
    }

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

Here is the call graph for this function:

deactivate()

ilDclDetailedViewDefinitionGUI::deactivate ( )

protected

Definition at line 128 of file class.ilDclDetailedViewDefinitionGUI.php.

                                   : void
    {
        $page = $this->getPageObject();
        $page->setActive(false);
        $page->update();
        $this->ctrl->redirect($this, 'edit');
    }

References ILIAS\Repository\ctrl(), and ilPageObjectGUI\getPageObject().

Here is the call graph for this function:

deleteView()

ilDclDetailedViewDefinitionGUI::deleteView

(

)

Definition at line 155 of file class.ilDclDetailedViewDefinitionGUI.php.

                                : void
    {
        if ($this->tableview_id && ilDclDetailedViewDefinition::exists($this->tableview_id)) {
            $pageObject = new ilDclDetailedViewDefinition($this->tableview_id);
            $pageObject->delete();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("dcl_empty_detailed_view_success"), true);
        $this->ctrl->redirectByClass(self::class, "edit");
    }

References ILIAS\Repository\ctrl(), ilDclDetailedViewDefinition\exists(), and ILIAS\Repository\lng().

Here is the call graph for this function:

executeCommand()

ilDclDetailedViewDefinitionGUI::executeCommand

(

)

execute command

Reimplemented from ilPageObjectGUI.

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

                                    : string
    {
        global $DIC;
        $ilLocator = $DIC['ilLocator'];
 
        $next_class = $this->ctrl->getNextClass($this);
 
        $viewdef = $this->getPageObject();
        if ($viewdef) {
            $this->ctrl->setParameter($this, "dclv", $viewdef->getId());
            $title = $this->lng->txt("dcl_view_viewdefinition");
        }
 
        switch ($next_class) {
            case "ilpageobjectgui":
                throw new ilCOPageException("Deprecated. ilDclDetailedViewDefinitionGUI gui forwarding to ilpageobject");
            default:
                if ($viewdef) {
                    $this->setPresentationTitle($title);
                    $ilLocator->addItem($title, $this->ctrl->getLinkTarget($this, "preview"));
                }
 
                return parent::executeCommand();
        }
    }

References $DIC, ILIAS\Repository\ctrl(), ilPageObjectGUI\getPageObject(), ILIAS\Repository\lng(), and ilPageObjectGUI\setPresentationTitle().

Here is the call graph for this function:

postOutputProcessing()

ilDclDetailedViewDefinitionGUI::postOutputProcessing

(

string

$a_output

)

Finalizing output processing.

Reimplemented from ilPageObjectGUI.

Definition at line 169 of file class.ilDclDetailedViewDefinitionGUI.php.

                                                          : string
    {
        // You can use this to parse placeholders and the like before outputting
 
        if ($this->getOutputMode() == ilPageObjectGUI::PREVIEW) {
            //page preview is not being used inside DataCollections - if you are here, something's probably wrong
 
            //
            //                  // :TODO: find a suitable presentation for matched placeholders
            //                  $allp = ilDataCollectionRecordViewViewdefinition::getAvailablePlaceholders($this->table_id, true);
            //                  foreach ($allp as $id => $item) {
            //                          $parsed_item = new ilTextInputGUI("", "fields[" . $item->getId() . "]");
            //                          $parsed_item = $parsed_item->getToolbarHTML();
            //
            //                          $a_output = str_replace($id, $item->getTitle() . ": " . $parsed_item, $a_output);
            //                  }
        } // editor
        else {
            if ($this->getOutputMode() == ilPageObjectGUI::EDIT) {
                $allp = $this->getPageObject()->getAvailablePlaceholders();
 
                // :TODO: find a suitable markup for matched placeholders
                foreach ($allp as $item) {
                    $a_output = str_replace($item, "<span style=\"color:green\">" . $item . "</span>", $a_output);
                }
            }
        }
 
        return $a_output;
    }

References ilPageObjectGUI\EDIT, ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), and ilPageObjectGUI\PREVIEW.

Here is the call graph for this function:

showPage()

ilDclDetailedViewDefinitionGUI::showPage

(

)

display content of page

Reimplemented from ilPageObjectGUI.

Definition at line 89 of file class.ilDclDetailedViewDefinitionGUI.php.

                              : string
    {
        if ($this->getOutputMode() == ilPageObjectGUI::EDIT) {
            $delete_button = ilLinkButton::getInstance();
            $delete_button->setCaption('dcl_empty_detailed_view');
            $delete_button->setUrl($this->ctrl->getLinkTarget($this, 'confirmDelete'));
            $this->toolbar->addButtonInstance($delete_button);
 
            $activation_button = ilLinkButton::getInstance();
            if ($this->getPageObject()->getActive()) {
                $activation_button->setCaption('dcl_deactivate_view');
                $activation_button->setUrl($this->ctrl->getLinkTarget($this, 'deactivate'));
            } else {
                $activation_button->setCaption('dcl_activate_view');
                $activation_button->setUrl($this->ctrl->getLinkTarget($this, 'activate'));
            }
 
            $this->toolbar->addButtonInstance($activation_button);
 
            $legend = $this->getPageObject()->getAvailablePlaceholders();
            if (sizeof($legend)) {
                $this->setPrependingHtml(
                    "<span class=\"small\">" . $this->lng->txt("dcl_legend_placeholders") . ": " . implode(" ", $legend)
                    . "</span>"
                );
            }
        }
 
        return parent::showPage();
    }

References ILIAS\Repository\ctrl(), ilPageObjectGUI\EDIT, ilLinkButton\getInstance(), ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), ILIAS\Repository\lng(), ilPageObjectGUI\setPrependingHtml(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Field Documentation

$http

ILIAS HTTP Services ilDclDetailedViewDefinitionGUI::$http

protected

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

$refinery

ILIAS Refinery Factory ilDclDetailedViewDefinitionGUI::$refinery

protected

Definition at line 27 of file class.ilDclDetailedViewDefinitionGUI.php.

$tableview_id

int ilDclDetailedViewDefinitionGUI::$tableview_id

protected

Definition at line 25 of file class.ilDclDetailedViewDefinitionGUI.php.

Referenced by __construct().

---

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

• Modules/DataCollection/classes/DetailedView/class.ilDclDetailedViewDefinitionGUI.php