ilMediaPoolPageGUI Class Reference

Class ilMediaPoolPage GUI class. More...

Inheritance diagram for ilMediaPoolPageGUI:

Collaboration diagram for ilMediaPoolPageGUI:

Public Member Functions
	__construct ($a_id=0, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="")
	Constructor. More...
	executeCommand ()
	execute command More...
	setMediaPoolPage ($a_media_pool_page)
	Set Media Pool Page Object. More...
	getMediaPoolPage ()
	Get Media Pool Page Object. More...
	preview ()
	View media pool page. More...
	showPage ($a_no_title=false)
	Show page. More...
	getTabs ($a_activate="")
	getRawContent ()
	Get raw content. More...
	setTemplate ($tpl)
	Set template. More...
Public Member Functions inherited from ilPageObjectGUI
	__construct ( $a_parent_type, $a_id, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="")
	Constructor. More...
	afterConstructor ()
	After constructor. More...
	setParentType ($a_val)
	Set parent type. More...
	getParentType ()
	Get parent type. More...
	setId ($a_val)
	Set ID. More...
	getId ()
	Get ID. More...
	setOldNr ($a_val)
	Set old nr (historic page) More...
	getOldNr ()
	Get old nr (historic page) More...
	setLanguage ($a_val)
	Set language. More...
	getLanguage ()
	Get language. More...
	setEnablePCType ($a_pc_type, $a_val)
	Set enable pc type. More...
	getEnablePCType ($a_pc_type)
	Get enable pc type. More...
	setPageConfig ($a_val)
	Set page config object. More...
	getPageConfig ()
	Get page config object. More...
	setPageObject (ilPageObject $a_pg_obj)
	Set Page Object. More...
	getPageObject ()
	Get Page Object. More...
	setOutputMode ($a_mode=self::PRESENTATION)
	Set Output Mode. More...
	getOutputMode ()
	setTemplateOutput ($a_output=true)
	outputToTemplate ()
	setPresentationTitle ($a_title="")
	getPresentationTitle ()
	setHeader ($a_title="")
	getHeader ()
	setLinkParams ($l_params="")
	getLinkParams ()
	setLinkFrame ($l_frame="")
	getLinkFrame ()
	setPageLinker ($page_linker)
	getLinkXML ()
	setQuestionXML ($question_xml)
	setQuestionHTML ($question_html)
	getQuestionXML ()
	getQuestionHTML ()
	setTemplateTargetVar ($a_variable)
	getTemplateTargetVar ()
	setTemplateOutputVar ($a_value)
	getTemplateOutputVar ()
	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...
	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...
	setLocator (&$a_locator)
	setTabs ($a_tabs)
	setPageBackTitle ($a_title)
	setFileDownloadLink ($a_download_link)
	Set file download link. More...
	getFileDownloadLink ()
	Get file download link. More...
	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...
	getFullscreenLink ()
	Get fullscreen link. More...
	setIntLinkReturn ($a_return)
	enableChangeComments ($a_enabled)
	isEnabledChangeComments ()
	enableNotes ($a_enabled, $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory ($offdir)
	set offline directory to offdir More...
	getOfflineDirectory ()
	get offline directory More...
	setViewPageLink ($a_link, $a_target="")
	set link for "view page" button More...
	getViewPageLink ()
	get view page link More...
	getViewPageTarget ()
	get view page target frame More...
	getViewPageText ()
	get view page text More...
	setActivationListener (&$a_obj, $a_meth)
	setEnabledNews ($a_enabled, $a_news_obj_id=0, $a_news_obj_type=0)
	Set enabled news. More...
	getEnabledNews ()
	Get enabled news. More...
	setTabHook ($a_object, $a_function)
	Set tab hook. More...
	setEditPreview ($a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	getEditPreview ()
	Get Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	setEnabledTabs ($a_enabledtabs)
	Set Output tabs. More...
	getEnabledTabs ()
	Get Output tabs. More...
	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus. More...
	getEnabledPageFocus ()
	Get Enable page focus. More...
	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater. More...
	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML. More...
	getPrependingHtml ()
	Get Prepending HTML. More...
	setEnableEditing ($a_enableediting)
	Set Enable Editing. More...
	getEnableEditing ()
	Get Enable Editing. More...
	setRawPageContent ($a_rawpagecontent)
	Set Get raw page content only. More...
	getRawPageContent ()
	Get Get raw page content only. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	setCompareMode ($a_val)
	Set compare mode. More...
	getCompareMode ()
	Get compare mode. More...
	setAbstractOnly ($a_val)
	Set abstract only. More...
	getAbstractOnly ()
	Get abstract only. More...
	setRenderPageContainer ($a_val)
	Set render page container. More...
	getRenderPageContainer ()
	Get render page container. More...
	getDisabledText ()
	Get disabled text. More...
	activateMetaDataEditor ( $a_rep_obj, $a_type, $a_sub_obj_id, $a_observer_obj=null, $a_observer_func="")
	Activate meda data editor. More...
	determineFileDownloadLink ()
	Determine file download link. More...
	determineFullscreenLink ()
	Determine fullscreen link. More...
	determineSourcecodeDownloadScript ()
	Determine source code download script. More...
	getComponentPluginsXML ()
	Put information about activated plugins into XML. More...
	executeCommand ()
	execute command More...
	setQEditTabs ($a_active)
	Set question editing tabs. More...
	onFeedbackEditingForwarding ()
	On feedback editing forwarding. More...
	deactivatePage ()
	activatePage ()
	showPage ()
	display content of page More...
	replaceCurlyBrackets ($output)
	Replace curly brackets. More...
	addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
	Add actions menu. More...
	addMultiLangActionsAndInfo ($a_list, $a_tpl)
	Add multi-language actions to menu. More...
	setEditMode ()
	Set edit mode. More...
	setDefaultLinkXml ()
	Set standard link xml. More...
	setLinkXml ($xml)
	Set linkXML. More...
	getProfileBackUrl ()
	Get profile back url. More...
	setProfileBackUrl ($url)
	Get profile back url. More...
	downloadFile ()
	Download file of file lists. More...
	displayMediaFullscreen ()
	Show media in fullscreen mode. More...
	displayMedia ($a_fullscreen=false)
	Display media. More...
	download_paragraph ()
	download source code paragraph More...
	insertPageToc ($a_output)
	Insert page toc. More...
	insertResources ($a_output)
	Insert resources. More...
	insertAdvTrigger ($a_output)
	Insert adv content trigger. More...
	postOutputProcessing ($a_output)
	Finalizing output processing. More...
	previewHistory ()
	Preview history. More...
	preview ()
	preview More...
	edit ()
	edit ("view" before) More...
	insertJSAtPlaceholder ()
	InsertJS at placeholder. More...
	initCaptchaForm ()
	Init captcha form. More...
	presentation ($a_mode=self::PRESENTATION)
	getHTML ()
	showMediaFullscreen ($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 ()
	Set screen id component. More...
	getTabs ($a_activate="")
	adds tabs to tab gui object More...
	compareVersion ()
	Compares two revisions of the page. More...
	replaceDiffTags ($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 ($a_content_object=null, $a_enable_private_notes=true, $a_enable_public_notes=false, $a_enable_notes_deletion=false, $a_callback=null)
	Get html for public and/or private notes. More...
	processAnswer ()
	Process answer. More...
	initialOpenedContent ()
	Initially opened content. More...
	initOpenedContentForm ()
	Init form for initially opened content. More...
	saveInitialOpenedContent ()
	Save initial opened content. More...
	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...
	getPagePermaLink ()
	Get page perma link. More...

Static Public Member Functions
static	getGUIForTitle ($a_media_pool_id, $a_title, $a_old_nr=0)
	Get media pool page gui for id and title. More...
Static Public Member Functions inherited from ilPageObjectGUI
static	getTinyMenu ( $a_par_type, $a_int_links=false, $a_wiki_links=false, $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)
	Get Tiny Menu. More...

Protected Attributes
	$tabs
Protected Attributes inherited from ilPageObjectGUI
	$profile_back_url = ""
	$tpl
	$lng
	$ctrl
	$tabs_gui
	$access
	$plugin_admin
	$log
	$user
	$help
	$output_mode
	$parent_type = ""
	$tool_context
	$ui
	$page_linker

Additional Inherited Members
Data Fields inherited from ilPageObjectGUI
const	PRESENTATION = "presentation"
const	EDIT = "edit"
const	PREVIEW = "preview"
const	OFFLINE = "offline"
const	PRINTING = "print"
	$obj
	$presentation_title
	$target_script
	$return_location
	$target_var
	$template_output_var
	$output2template
	$link_params
	$sourcecode_download_script
	$change_comments
	$question_html
	$activation = false
	$activated = true
	$editpreview = false
	$use_meta_data = false
	$link_xml_set = false
	$enableediting = true
	$rawpagecontent = false
	$enabledcontentincludes = false
	$compare_mode = false
	$page_config = null
	$tabs_enabled = true
	$render_page_container = false
	$pl_start = "{{{{{"
	$pl_end = "}}}}}"
Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...
	getActivationCaptions ()
	Get captions for activation action menu entries. More...
	getBlockingInfoMessage ()
	Get block info message. More...
	isPageContainerToBeRendered ()
	addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
	Add resources to template. More...

Detailed Description

Class ilMediaPoolPage GUI class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilMediaPoolPageGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector ilMediaPoolPageGUI: ilPublicUserProfileGUI

Definition at line 19 of file class.ilMediaPoolPageGUI.php.

Constructor & Destructor Documentation

__construct()

ilMediaPoolPageGUI::__construct	(		$a_id = 0,
			$a_old_nr = 0,
			$a_prevent_get_id = false,
			$a_lang = ""
	)

Constructor.

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

References $DIC, ilPageObjectGUI\$tpl, ILIAS\GlobalScreen\Provider\__construct(), ilObjStyleSheet\getEffectiveContentStyleId(), ilPageObjectGUI\setEditPreview(), and ilPageObjectGUI\setStyleId().

    {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        $this->access = $DIC->access();
        $this->lng = $DIC->language();
        $tpl = $DIC["tpl"];
        
        parent::__construct("mep", $a_id, $a_old_nr, $a_prevent_get_id, $a_lang);

        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $this->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(0));

        $this->setEditPreview(true);
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilMediaPoolPageGUI::executeCommand

(

)

execute command

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

References ilPageObjectGUI\$ctrl, $ilCtrl, and $tabs.

    {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                return parent::executeCommand();
        }
    }

getGUIForTitle()

static ilMediaPoolPageGUI::getGUIForTitle (   $a_media_pool_id,   $a_title,   $a_old_nr = 0  )

static

Get media pool page gui for id and title.

Definition at line 88 of file class.ilMediaPoolPageGUI.php.

References $DIC, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        include_once("./Modules/MediaPool/classes/class.ilMediaPoolPage.php");
        $id = ilMediaPoolPage::getPageIdForTitle($a_media_pool_id, $a_title);
        $page_gui = new ilMediaPoolPageGUI($id, $a_old_nr);
        
        return $page_gui;
    }

getMediaPoolPage()

ilMediaPoolPageGUI::getMediaPoolPage

(

)

Get Media Pool Page Object.

Returns

object Media Pool Page Object

Definition at line 80 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\getPageObject().

Referenced by showPage().

    {
        return $this->getPageObject();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRawContent()

ilMediaPoolPageGUI::getRawContent

(

)

Get raw content.

Parameters

Definition at line 162 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\setRawPageContent(), and ilPageObjectGUI\showPage().

    {
        $this->setRawPageContent(true);
        $this->setLinkXML("");
        return $this->showPage(true);
    }

Here is the call graph for this function:

getTabs()

ilMediaPoolPageGUI::getTabs

(

$a_activate = ""

)

Definition at line 148 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\$ctrl, $ilCtrl, and $tabs.

    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;

        parent::getTabs($a_activate);
    }

preview()

ilMediaPoolPageGUI::preview

(

)

View media pool page.

Definition at line 104 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\$access, ilPageObjectGUI\$ctrl, $ilCtrl, and ilPageObjectGUI\$lng.

    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        $lng = $this->lng;
        
        return parent::preview();
    }

setMediaPoolPage()

ilMediaPoolPageGUI::setMediaPoolPage

(

$a_media_pool_page

)

Set Media Pool Page Object.

Parameters

object

$a_media_pool_page

Media Pool Page Object

Definition at line 70 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\setPageObject().

    {
        $this->setPageObject($a_media_pool_page);
    }

Here is the call graph for this function:

setTemplate()

ilMediaPoolPageGUI::setTemplate

(

$tpl

)

Set template.

Parameters

ilTemplate

Definition at line 173 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\$tpl.

    {
        $this->tpl = $tpl;
    }

showPage()

ilMediaPoolPageGUI::showPage

(

$a_no_title = false

)

Show page.

Definition at line 116 of file class.ilMediaPoolPageGUI.php.

References ilPageObjectGUI\$ctrl, $ilCtrl, ilPageObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), ilPageObjectGUI\getId(), getMediaPoolPage(), ilPageObjectGUI\getRawPageContent(), ilMediaPoolItem\lookupTitle(), ilPageObjectGUI\setPresentationTitle(), and ilPageObjectGUI\setTemplateOutput().

    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;

        // get raw page content is used for including into other pages
        if (!$this->getRawPageContent()) {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            $tpl->setCurrentBlock("ContentStyle");
            $tpl->setVariable(
                "LOCATION_CONTENT_STYLESHEET",
                ilObjStyleSheet::getContentStylePath(0)
            );
            $tpl->parseCurrentBlock();

            /*            $tpl->setCurrentBlock("SyntaxStyle");
                        $tpl->setVariable(
                            "LOCATION_SYNTAX_STYLESHEET",
                            ilObjStyleSheet::getSyntaxStylePath()
                        );
                        $tpl->parseCurrentBlock();*/
        }

        $this->setTemplateOutput(false);
        if (!$a_no_title) {
            $this->setPresentationTitle(ilMediaPoolItem::lookupTitle($this->getMediaPoolPage()->getId()));
        }
        $output = parent::showPage();
        
        return $output;
    }

Here is the call graph for this function:

Field Documentation

$tabs

ilMediaPoolPageGUI::$tabs

protected

Definition at line 24 of file class.ilMediaPoolPageGUI.php.

Referenced by executeCommand(), and getTabs().

---

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

• Modules/MediaPool/classes/class.ilMediaPoolPageGUI.php