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.
&	executeCommand ()
	execute command
	setMediaPoolPage ($a_media_pool_page)
	Set Media Pool Page Object.
	getMediaPoolPage ()
	Get Media Pool Page Object.
	preview ()
	View media pool page.
	showPage ($a_no_title=false)
	Show page.
	getTabs ($a_activate="")
	adds tabs to tab gui object
	getRawContent ()
	Get raw content.
Public Member Functions inherited from ilPageObjectGUI
	ilPageObjectGUI ($a_parent_type, $a_id, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="")
	Constructor.
	afterConstructor ()
	After constructor.
	setParentType ($a_val)
	Set parent type.
	getParentType ()
	Get parent type.
	setId ($a_val)
	Set ID.
	getId ()
	Get ID.
	setOldNr ($a_val)
	Set old nr (historic page)
	getOldNr ()
	Get old nr (historic page)
	setLanguage ($a_val)
	Set language.
	getLanguage ()
	Get language.
	setEnablePCType ($a_pc_type, $a_val)
	Set enable pc type.
	getEnablePCType ($a_pc_type)
	Get enable pc type.
	setPageConfig ($a_val)
	Set page config object.
	getPageConfig ()
	Get page config object.
	setBibId ($a_id)
	Set Bib Id.
	getBibId ()
	Get Bib Id.
	setPageObject ($a_pg_obj)
	Set Page Object.
	getPageObject ()
	Get Page Object.
	setOutputMode ($a_mode=IL_PAGE_PRESENTATION)
	Set Output Mode.
	getOutputMode ()
	setTemplateOutput ($a_output=true)
	outputToTemplate ()
	setPresentationTitle ($a_title="")
	getPresentationTitle ()
	setHeader ($a_title="")
	getHeader ()
	setLinkParams ($l_params="")
	getLinkParams ()
	setLinkFrame ($l_frame="")
	getLinkFrame ()
	setLinkXML ($link_xml)
	getLinkXML ()
	setQuestionXML ($question_xml)
	setQuestionHTML ($question_html)
	getQuestionXML ()
	getQuestionHTML ()
	setTemplateTargetVar ($a_variable)
	getTemplateTargetVar ()
	setTemplateOutputVar ($a_value)
	getTemplateOutputVar ()
	setSourcecodeDownloadScript ($script_name)
	getSourcecodeDownloadScript ()
	enableCitation ($a_enabled)
	isEnabledCitation ()
	setLocator (&$a_locator)
	setTabs ($a_tabs)
	setPageBackTitle ($a_title)
	setFileDownloadLink ($a_download_link)
	getFileDownloadLink ()
	setFullscreenLink ($a_fullscreen_link)
	getFullscreenLink ()
	setIntLinkReturn ($a_return)
	enableChangeComments ($a_enabled)
	isEnabledChangeComments ()
	enableNotes ($a_enabled, $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory ($offdir)
	set offline directory to offdir
	getOfflineDirectory ()
	get offline directory
	setViewPageLink ($a_link, $a_target="")
	set link for "view page" button
	getViewPageLink ()
	get view page link
	getViewPageTarget ()
	get view page target frame
	setActivationListener (&$a_obj, $a_meth)
	setEnabledNews ($a_enabled, $a_news_obj_id=0, $a_news_obj_type=0)
	Set enabled news.
	getEnabledNews ()
	Get enabled news.
	setTabHook ($a_object, $a_function)
	Set tab hook.
	setEditPreview ($a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit.
	getEditPreview ()
	Get Display first Edit tab, then Preview tab, instead of Page and Edit.
	setEnabledTabs ($a_enabledtabs)
	Set Output tabs.
	getEnabledTabs ()
	Get Output tabs.
	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus.
	getEnabledPageFocus ()
	Get Enable page focus.
	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater.
	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML.
	getPrependingHtml ()
	Get Prepending HTML.
	setEnableEditing ($a_enableediting)
	Set Enable Editing.
	getEnableEditing ()
	Get Enable Editing.
	setRawPageContent ($a_rawpagecontent)
	Set Get raw page content only.
	getRawPageContent ()
	Get Get raw page content only.
	setStyleId ($a_styleid)
	Set Style Id.
	getStyleId ()
	Get Style Id.
	setCompareMode ($a_val)
	Set compare mode.
	getCompareMode ()
	Get compare mode.
	setAbstractOnly ($a_val)
	Set abstract only.
	getAbstractOnly ()
	Get abstract only.
	setRenderPageContainer ($a_val)
	Set render page container.
	getRenderPageContainer ()
	Get render page container.
	activateMetaDataEditor ($a_rep_obj_id, $a_sub_obj_id, $a_type, $a_observer_obj=NULL, $a_observer_func="")
	Activate meda data editor.
	determineFileDownloadLink ()
	Determine file download link.
	determineFullscreenLink ()
	Determine fullscreen link.
	determineSourcecodeDownloadScript ()
	Determine source code download script.
	getComponentPluginsXML ()
	Put information about activated plugins into XML.
	setQEditTabs ($a_active)
	Set question editing tabs.
	onFeedbackEditingForwarding ()
	On feedback editing forwarding.
	deactivatePage ()
	activatePage ()
	showPage ()
	replaceCurlyBrackets ($output)
	Replace curly brackets.
	addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
	Add actions menu.
	addMultiLangActionsAndInfo ($a_list, $a_tpl)
	Add multi-language actions to menu.
	setEditMode ()
	Set edit mode.
	setDefaultLinkXml ()
	Set standard link xml.
	downloadFile ()
	Download file of file lists.
	displayMediaFullscreen ()
	Show media in fullscreen mode.
	displayMedia ($a_fullscreen=false)
	Display media.
	download_paragraph ()
	download source code paragraph
	insertContentIncludes ($a_html)
	Insert content includes.
	insertPageToc ($a_output)
	Insert page toc.
	insertResources ($a_output)
	Insert resources.
	insertAdvTrigger ($a_output)
	Insert adv content trigger.
	postOutputProcessing ($a_output)
	Finalizing output processing.
	insertHelp ($a_tpl)
	Insert help texts.
	edit ()
	edit ("view" before)
	insertJSAtPlaceholder ()
	InsertJS at placeholder.
	presentation ($a_mode=IL_PAGE_PRESENTATION)
	getHTML ()
	showMediaFullscreen ($a_style_id=0)
	show fullscreen view of media object
	displayValidationError ($a_error)
	display validation error
	history ()
	Get history table as HTML.
	rollbackConfirmation ()
	Rollback confirmation.
	rollback ()
	Rollback to a previous version.
	setScreenIdComponent ()
	Set screen id component.
	compareVersion ()
	Compares two revisions of the page.
	replaceDiffTags ($a_html)
	editActivation ()
	Edit activation (only, if scheduled page activation is activated in administration)
	initActivationForm ()
	Init activation form.
	getActivationFormValues ()
	Get values for activation form.
	saveActivation ()
	Save Activation.
	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.
	getQuestionJsOfPage ($a_no_interaction=false)
	Get question js.
	initSelfAssessmentRendering ($a_force_no_form=false)
	Init question handling.
	processAnswer ()
	Process answer.
	selfAssessmentRendering ($a_output)
	Self assessment question rendering.
	initialOpenedContent ()
	Initially opened content.
	initOpenedContentForm ()
	Init form for initially opened content.
	saveInitialOpenedContent ()
	Save initial opened content.
	switchToLanguage ()
	Switch to language.
	confirmPageTranslationCreation ()
	Confirm page translation creation.
	editMasterLanguage ()
	Edit master language.
	createPageTranslation ()
	Create page translation.
	releasePageLock ()
	Release page lock.

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.
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)
	Get Tiny Menu.
static	addPreparationJavascript ($a_tpl, $a_lang)
	Add standard texts.
static	getJSTextInitCode ($a_lang)
	Get js txt init code.

Additional Inherited Members
Data Fields inherited from ilPageObjectGUI
	$tpl
	$lng
	$ctrl
	$obj
	$output_mode
	$presentation_title
	$target_script
	$return_location
	$target_var
	$template_output_var
	$output2template
	$link_params
	$bib_id
	$citation
	$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.
	getActivationCaptions ()
	Get captions for activation action menu entries.
Protected Attributes inherited from ilPageObjectGUI
	$parent_type = ""

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

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

Constructor.

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

References ilPageObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

        {
                global $tpl;
                
                parent::__construct("mep", $a_id, $a_old_nr, $a_prevent_get_id, $a_lang);
                
                // content style
                include_once("./Services/Style/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();
                
        }

Here is the call graph for this function:

Member Function Documentation

& ilMediaPoolPageGUI::executeCommand

(

)

execute command

Reimplemented from ilPageObjectGUI.

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

References $cmd, and $ilCtrl.

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

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

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 84 of file class.ilMediaPoolPageGUI.php.

        {
                global $ilDB;
                
                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;
        }

ilMediaPoolPageGUI::getMediaPoolPage

(

)

Get Media Pool Page Object.

Returns

object Media Pool Page Object

Definition at line 76 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:

ilMediaPoolPageGUI::getRawContent

(

)

Get raw content.

Parameters

@return

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

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

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

Here is the call graph for this function:

ilMediaPoolPageGUI::getTabs

(

$a_activate = ""

)

adds tabs to tab gui object

Parameters

object

$tabs_gui

ilTabsGUI object

Reimplemented from ilPageObjectGUI.

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

References $ilCtrl.

        {
                global $ilTabs, $ilCtrl;

                parent::getTabs($a_activate);           
        }

ilMediaPoolPageGUI::preview

(

)

View media pool page.

Reimplemented from ilPageObjectGUI.

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

References $ilCtrl, and ilPageObjectGUI\$lng.

        {
                global $ilCtrl, $ilAccess, $lng;
                
                return parent::preview();
        }

ilMediaPoolPageGUI::setMediaPoolPage

(

$a_media_pool_page

)

Set Media Pool Page Object.

Parameters

object

$a_media_pool_page

Media Pool Page Object

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

References ilPageObjectGUI\setPageObject().

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

Here is the call graph for this function:

ilMediaPoolPageGUI::showPage

(

$a_no_title = false

)

Show page.

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

References $ilCtrl, ilPageObjectGUI\$tpl, ilPageObjectGUI\getId(), getMediaPoolPage(), ilMediaPoolItem\lookupTitle(), ilPageObjectGUI\setPresentationTitle(), ilPageObjectGUI\setTemplateOutput(), and ilPageObjectGUI\showPage().

        {
                global $tpl, $ilCtrl;
                
                $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:

---

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

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