ILIAS  release_4-4 Revision
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...
 
- Public Member Functions inherited from ilPageObjectGUI
 ilPageObjectGUI ($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...
 
 setBibId ($a_id)
 Set Bib Id. More...
 
 getBibId ()
 Get Bib Id. More...
 
 setPageObject ($a_pg_obj)
 Set Page Object. More...
 
 getPageObject ()
 Get Page Object. More...
 
 setOutputMode ($a_mode=IL_PAGE_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 ()
 
 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 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...
 
 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...
 
 activateMetaDataEditor ($a_rep_obj_id, $a_sub_obj_id, $a_type, $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 ()
 
 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...
 
 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...
 
 insertContentIncludes ($a_html)
 Insert content includes. 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...
 
 insertHelp ($a_tpl)
 Insert help texts. More...
 
 preview ()
 preview More...
 
 edit ()
 edit ("view" before) More...
 
 insertJSAtPlaceholder ()
 InsertJS at placeholder. More...
 
 presentation ($a_mode=IL_PAGE_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...
 
 getQuestionJsOfPage ($a_no_interaction=false)
 Get question js. More...
 
 initSelfAssessmentRendering ($a_force_no_form=false)
 Init question handling. More...
 
 processAnswer ()
 Process answer. More...
 
 selfAssessmentRendering ($a_output)
 Self assessment question rendering. 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...
 

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

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. More...
 
 getActivationCaptions ()
 Get captions for activation action menu entries. More...
 
- Protected Attributes inherited from ilPageObjectGUI
 $parent_type = ""
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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().

25  {
26  global $tpl;
27 
28  parent::__construct("mep", $a_id, $a_old_nr, $a_prevent_get_id, $a_lang);
29 
30  // content style
31  include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
32  $tpl->setCurrentBlock("ContentStyle");
33  $tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
35  $tpl->parseCurrentBlock();
36 
37  $tpl->setCurrentBlock("SyntaxStyle");
38  $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
40  $tpl->parseCurrentBlock();
41 
42  }
getSyntaxStylePath()
get syntax style path
getContentStylePath($a_style_id)
get content style path
+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

& ilMediaPoolPageGUI::executeCommand ( )

execute command

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

References $cmd, and $ilCtrl.

48  {
49  global $ilCtrl, $ilTabs;
50 
51  $next_class = $this->ctrl->getNextClass($this);
52  $cmd = $this->ctrl->getCmd();
53 
54  switch($next_class)
55  {
56  default:
57  return parent::executeCommand();
58  }
59  }
$cmd
Definition: sahs_server.php:35
global $ilCtrl
Definition: ilias.php:18

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

85  {
86  global $ilDB;
87 
88  include_once("./Modules/MediaPool/classes/class.ilMediaPoolPage.php");
89  $id = ilMediaPoolPage::getPageIdForTitle($a_media_pool_id, $a_title);
90  $page_gui = new ilMediaPoolPageGUI($id, $a_old_nr);
91 
92  return $page_gui;
93  }
Class ilMediaPoolPage GUI class.

◆ getMediaPoolPage()

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().

77  {
78  return $this->getPageObject();
79  }
getPageObject()
Get Page Object.
+ 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 135 of file class.ilMediaPoolPageGUI.php.

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

136  {
137  $this->setRawPageContent(true);
138  $this->setLinkXML("");
139  return $this->showPage(true);
140  }
setRawPageContent($a_rawpagecontent)
Set Get raw page content only.
+ Here is the call graph for this function:

◆ getTabs()

ilMediaPoolPageGUI::getTabs (   $a_activate = "")

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

References $ilCtrl.

123  {
124  global $ilTabs, $ilCtrl;
125 
126  parent::getTabs($a_activate);
127  }
global $ilCtrl
Definition: ilias.php:18

◆ preview()

ilMediaPoolPageGUI::preview ( )

View media pool page.

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

References $ilCtrl, and ilPageObjectGUI\$lng.

99  {
100  global $ilCtrl, $ilAccess, $lng;
101 
102  return parent::preview();
103  }
global $ilCtrl
Definition: ilias.php:18

◆ setMediaPoolPage()

ilMediaPoolPageGUI::setMediaPoolPage (   $a_media_pool_page)

Set Media Pool Page Object.

Parameters
object$a_media_pool_pageMedia Pool Page Object

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

References ilPageObjectGUI\setPageObject().

67  {
68  $this->setPageObject($a_media_pool_page);
69  }
setPageObject($a_pg_obj)
Set Page Object.
+ Here is the call graph for this function:

◆ showPage()

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(), and ilPageObjectGUI\setTemplateOutput().

109  {
110  global $tpl, $ilCtrl;
111 
112  $this->setTemplateOutput(false);
113  if (!$a_no_title)
114  {
116  }
117  $output = parent::showPage();
118 
119  return $output;
120  }
getMediaPoolPage()
Get Media Pool Page Object.
setTemplateOutput($a_output=true)
global $ilCtrl
Definition: ilias.php:18
setPresentationTitle($a_title="")
static lookupTitle($a_id)
Lookup title.
+ Here is the call graph for this function:

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