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)
	Constructor.
	initPageObject ($a_parent_type, $a_id, $a_old_nr)
&	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=0, $a_old_nr=0, $a_prevent_get_id=false)
	Constructor public.
	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 ()
	setOutputSubmode ($a_mode)
	getOutputSubmode ()
	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 ()
	setEnableKeywords ($a_val)
	Set enable keywords handling.
	getEnableKeywords ()
	Get enable keywords handling.
	setEnableAnchors ($a_val)
	Set enable anchors.
	getEnableAnchors ()
	Get enable anchors.
	setIntLinkHelpDefault ($a_type, $a_id)
	setIntLinkReturn ($a_return)
	enableChangeComments ($a_enabled)
	isEnabledChangeComments ()
	enableNotes ($a_enabled, $a_parent_id)
	isEnabledNotes ()
	enableContentIncludes ($a_enable)
	Enable content includes.
	isEnabledContentIncludes ()
	Are content includes enabled?
	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)
	setEnabledActivation ($a_act)
	getEnabledActivation ()
	setEnabledScheduledActivation ($a_act)
	getEnabledScheduledActivation ()
	setPageToc ($a_val)
	Set page toc.
	getPageToc ()
	Get page toc.
	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.
	setEnabledInternalLinks ($a_enabledinternallinks)
	Set Enable internal links.
	getEnabledInternalLinks ()
	Get Enable internal links.
	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.
	setPreventHTMLUnmasking ($a_preventhtmlunmasking)
	Set Prevent HTML Unmasking (true/false).
	getPreventHTMLUnmasking ()
	Get Prevent HTML Unmasking (true/false).
	setEnabledTabs ($a_enabledtabs)
	Set Output tabs.
	getEnabledTabs ()
	Get Output tabs.
	setEnabledRepositoryObjects ($a_enabledrepositoryobjects)
	Set Enable Repository Objects Content Component.
	getEnabledRepositoryObjects ()
	Get Enable Repository Objects Content Component.
	setEnabledLoginPage ($a_enablegloginpage)
	Set enable login page.
	getEnabledLoginPage ()
	Get enable login page.
	setEnabledMaps ($a_enabledmaps)
	Set Enable Maps Content Component.
	getEnabledMaps ()
	Get Enable Maps Content Component.
	setEnabledPCTabs ($a_enabledpctabs)
	Set Enable Tabs Content Component.
	getEnabledPCTabs ()
	Get Enable Tabs Content Component.
	setEnabledFileLists ($a_enabledfilelists)
	Set Enable File Lists Content Componente (Default is true).
	getEnabledFileLists ()
	Get Enable File Lists Content Componente (Default is true).
	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus.
	getEnabledPageFocus ()
	Get Enable page focus.
	getEnabledProfile ()
	Get Enable Profile Content Component.
	setEnabledProfile ($a_enableprofile)
	Set Enable Profile Content Component.
	getEnabledVerification ()
	Get Enable Verification Content Component.
	setEnabledVerification ($a_enableverification)
	Set Enable Verification Content Component.
	getEnabledBlog ()
	Get Enable Blog Content Component.
	setEnabledBlog ($a_enableblog)
	Set Enable Blog Content Component.
	getEnabledSkills ()
	Get Enable Skills Content Component.
	setEnabledSkills ($a_enableskills)
	Set Enable Skills Content Component.
	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater.
	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML.
	getPrependingHtml ()
	Get Prepending HTML.
	setEnabledWikiLinks ($a_enablewikilinks)
	Set Enable Wiki Links.
	getEnabledWikiLinks ()
	Get Enable Wiki Links.
	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.
	setLayoutMode ($a_layout_mode)
	Set Layout Mode.
	getLayoutMode ()
	Get Layout Mode enabled/disabled.
	setStyleId ($a_styleid)
	Set Style Id.
	getStyleId ()
	Get Style Id.
	setEnabledSelfAssessment ($a_enabledselfassessment, $a_scorm=true)
	Set Enable Self Assessment Questions.
	getEnabledSelfAssessment ()
	Get Enable Self Assessment Questions.
	getEnabledSelfAssessmentScorm ()
	Is self assessment used in SCORM mode?
	setCompareMode ($a_val)
	Set compare mode.
	getCompareMode ()
	Get compare mode.
	setAbstractOnly ($a_val)
	Set abstract only.
	getAbstractOnly ()
	Get abstract only.
	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.
	deactivatePage ()
	activatePage ()
	showPage ()
	replaceCurlyBrackets ($output)
	Replace curly brackets.
	addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
	Add actions 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
	insertMaps ($a_html)
	Insert Maps.
	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.
	initCaptchaForm ()
	Init captcha form.
	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.

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)
	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
	$ilias
	$tpl
	$lng
	$ctrl
	$obj
	$output_mode
	$output_submode
	$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
	$enabledinternallinks = false
	$editpreview = false
	$use_meta_data = false
	$enabledpctabs = false
	$link_xml_set = false
	$enableediting = true
	$rawpagecontent = false
	$layoutmode = false
	$enabledcontentincludes = false
	$compare_mode = false
	$page_config = null
	$enable_keywords = false
	$enable_anchors = false
	$tabs_enabled = true
	$pl_start = "{{{{{"
	$pl_end = "}}}}}"
	$pc_types
Protected Member Functions inherited from ilPageObjectGUI
	getActivationCaptions ()
	Get captions for activation action menu entries.

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: ilPageObjectGUI, 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
	)

Constructor.

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

References ilPageObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ilPageObjectGUI\setEnabledInternalLinks(), ilPageObjectGUI\setEnabledMaps(), ilPageObjectGUI\setEnabledWikiLinks(), and ilPageObjectGUI\setPreventHTMLUnmasking().

        {
                global $tpl;
                
                parent::__construct("mep", $a_id, $a_old_nr, $a_prevent_get_id);
                
                // 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();
                
                $this->setEnabledMaps(false);
                $this->setPreventHTMLUnmasking(false);
                $this->setEnabledInternalLinks(false);
                $this->setEnabledWikiLinks(false);

        }

Here is the call graph for this function:

Member Function Documentation

& ilMediaPoolPageGUI::executeCommand

(

)

execute command

Reimplemented from ilPageObjectGUI.

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

References $cmd, $ilCtrl, ilPageObjectGUI\getPageObject(), and ilPageObjectGUI\ilPageObjectGUI().

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

                switch($next_class)
                {                               
                        case "ilpageobjectgui":
                                $page_gui = new ilPageObjectGUI("wpg",
                                        $this->getPageObject()->getId(), $this->getPageObject()->old_nr);
                                return $ilCtrl->forwardCommand($page_gui);
                                
                        default:
                                return parent::executeCommand();
                }
        }

Here is the call graph for this function:

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 100 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 92 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 151 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 138 of file class.ilMediaPoolPageGUI.php.

References $ilCtrl.

        {
                global $ilTabs, $ilCtrl;

                parent::getTabs($a_activate);           
        }

ilMediaPoolPageGUI::initPageObject	(		$a_parent_type,
			$a_id,
			$a_old_nr
	)

Reimplemented from ilPageObjectGUI.

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

References ilPageObjectGUI\setPageObject().

        {
                $page = new ilMediaPoolPage($a_id, $a_old_nr);
                $this->setPageObject($page);
        }

Here is the call graph for this function:

ilMediaPoolPageGUI::preview

(

)

View media pool page.

Reimplemented from ilPageObjectGUI.

Definition at line 114 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 82 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 124 of file class.ilMediaPoolPageGUI.php.

References $ilCtrl, ilPageObjectGUI\$tpl, 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