ilPortfolioTemplatePageGUI 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 ilPortfolioTemplatePageGUI:

Collaboration diagram for ilPortfolioTemplatePageGUI:

Public Member Functions
	getParentType ()
	showPage ()
	getViewPageLink ()
	finishEditing ()
Public Member Functions inherited from ilPortfolioPageGUI
	__construct (int $a_portfolio_id, int $a_id=0, int $a_old_nr=0, bool $a_enable_comments=true)
	getParentType ()
	executeCommand ()
	showPage ()
	getTabs (string $a_activate="")
	setEmbedded (bool $a_value)
	Set embedded mode: will suppress tabs. More...
	setAdditional (array $a_additional)
	Set Additonal Information. More...
	getAdditional ()
	Get Additonal Information. More...
	getJsOnloadCode ()
	postOutputProcessing (string $a_output)
	getExportMaterial ()
	makePlaceHoldersClickable (string $a_html)
	getViewPageLink ()
	getViewPageText ()
	getPagePermaLink ()
	getCommentsHTMLExport ()
	finishEditing ()
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
	getPageContentUserId (int $a_user_id)
	renderPageElement (string $a_type, string $a_html)
	addPlaceholderInfo (string $a_html)
	renderBlogTemplate ()
	getCourseSortAction (ilCtrl $ctrl)
Protected Member Functions inherited from ilPortfolioPageGUI
	getPageContentUserId (int $a_user_id)
	renderPageElement (string $a_type, string $a_html)
	renderTeaser (string $a_type, string $a_title, string $a_options="")
	renderProfile (int $a_user_id, string $a_type, array $a_fields=null)
	renderVerification (int $a_user_id, string $a_type, int $a_id)
	dltstv ()
	dlexcv ()
	dlcrsv ()
	dlcmxv ()
	dlltiv ()
	dlscov ()
	dlcrta ()
	renderBlog (int $a_user_id, int $a_blog_id, array $a_posting_ids=null)
	renderBlogTeaser (int $a_user_id, int $a_blog_id, array $a_posting_ids=null)
	renderSkills (int $a_user_id, int $a_skills_id)
	renderSkillsTeaser (int $a_user_id, int $a_skills_id)
	renderConsultationHoursTeaser (int $a_user_id, string $a_mode, ?array $a_group_ids=null)
	renderConsultationHours (int $a_user_id, string $a_mode, ?array $a_group_ids=null)
	isMyCoursesActive ()
	renderMyCoursesTeaser (int $a_user_id, $a_default_sorting)
	renderMyCourses (int $a_user_id, string $a_default_sorting)
	getCourseSortAction (ilCtrl $ctrl)
	Get course sort action. More...
	getCoursesOfUser (int $a_user_id, bool $a_add_path=false)
	parseLOUserResults (int $a_course_obj_id, int $a_user_id)
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
bool	$may_write = false
Protected Attributes inherited from ilPortfolioPageGUI
bool	$enable_comments
int	$portfolio_id
ILIAS Portfolio StandardGUIRequest	$port_request
bool	$embedded = false
ilObjectDefinition	$obj_definition
ilTree	$tree
array	$js_onload_code = array()
array	$additional = array()
array	$export_material = array("js" => array(), "images" => array(), "files" => array())
int	$requested_ppage
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 ilPortfolioPageGUI
const	EMBEDDED_NO_OUTPUT = -99
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 = "}}}}}"
Static Protected Attributes inherited from ilPortfolioPageGUI
static int	$initialized = 0
static bool	$calender_initialized = false

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 Portfolio template page gui class

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilPortfolioTemplatePageGUI: ilPageEditorGUI, ilEditClipboardGUI, ilPublicUserProfileGUI ilPortfolioTemplatePageGUI: ilPageObjectGUI, ilMediaPoolTargetSelector ilPortfolioTemplatePageGUI: ilCalendarMonthGUI, ilConsultationHoursGUI

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

Member Function Documentation

addPlaceholderInfo()

ilPortfolioTemplatePageGUI::addPlaceholderInfo ( string  $a_html )

protected

Definition at line 74 of file class.ilPortfolioTemplatePageGUI.php.

References ILIAS\Repository\lng().

Referenced by renderPageElement().

                                                         : string
    {
        return '<fieldset style="border: 1px dashed red; padding: 3px; margin: 5px;">' .
                    '<legend style="color: red; font-style: italic;" class="small">' .
                        $this->lng->txt("prtf_template_editor_placeholder_info") .
                    '</legend>' .
                    trim($a_html) .
                '</fieldset>';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

finishEditing()

ilPortfolioTemplatePageGUI::finishEditing

(

)

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

References ILIAS\Repository\ctrl().

                                   : void
    {
        $this->ctrl->redirectByClass("ilObjPortfolioTemplateGUI", "view");
    }

Here is the call graph for this function:

getCourseSortAction()

ilPortfolioTemplatePageGUI::getCourseSortAction ( ilCtrl  $ctrl )

protected

Definition at line 99 of file class.ilPortfolioTemplatePageGUI.php.

References ilCtrl\getFormActionByClass().

                                                        : string
    {
        return $ctrl->getFormActionByClass("ilobjportfoliotemplategui", "preview");
    }

Here is the call graph for this function:

getPageContentUserId()

ilPortfolioTemplatePageGUI::getPageContentUserId ( int  $a_user_id )

protected

Definition at line 36 of file class.ilPortfolioTemplatePageGUI.php.

References $ilUser, and ilPageObjectGUI\$user.

                                                           : int
    {
        $ilUser = $this->user;

        // user
        if (!$this->may_write) {
            return $ilUser->getId();
        }
        // author
        return $a_user_id;
    }

getParentType()

ilPortfolioTemplatePageGUI::getParentType

(

)

Definition at line 31 of file class.ilPortfolioTemplatePageGUI.php.

                                   : string
    {
        return "prtt";
    }

getViewPageLink()

ilPortfolioTemplatePageGUI::getViewPageLink

(

)

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

References ilPageObjectGUI\$ctrl, $DIC, ilCtrl\getLinkTargetByClass(), and ilCtrl\setParameterByClass().

                                     : string
    {
        global $DIC;

        $ctrl = $DIC->ctrl();

        $ctrl->setParameterByClass("ilobjportfoliotemplategui", "user_page", $this->requested_ppage);
        return $ctrl->getLinkTargetByClass("ilobjportfoliotemplategui", "preview");
    }

Here is the call graph for this function:

renderBlogTemplate()

ilPortfolioTemplatePageGUI::renderBlogTemplate ( )

protected

Definition at line 84 of file class.ilPortfolioTemplatePageGUI.php.

References ILIAS\Repository\lng(), and ilPortfolioPageGUI\renderTeaser().

Referenced by showPage().

                                           : string
    {
        return $this->renderTeaser("blog_template", $this->lng->txt("obj_blog"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderPageElement()

ilPortfolioTemplatePageGUI::renderPageElement ( string  $a_type, string  $a_html  )

protected

Definition at line 67 of file class.ilPortfolioTemplatePageGUI.php.

References addPlaceholderInfo().

Referenced by showPage().

     : string {
        return parent::renderPageElement($a_type, $this->addPlaceholderInfo($a_html));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showPage()

ilPortfolioTemplatePageGUI::showPage

(

)

Definition at line 48 of file class.ilPortfolioTemplatePageGUI.php.

References ilPageObjectGUI\getPageObject(), ilObjStyleSheet\getPlaceHolderStylePath(), renderBlogTemplate(), renderPageElement(), and ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE.

                              : string
    {
        if (!$this->getPageObject()) {
            return "";
        }

        switch ($this->getPageObject()->getType()) {
            case ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE:
                return $this->renderPageElement("BlogTemplate", $this->renderBlogTemplate());

            default:

                // needed for placeholders
                $this->tpl->addCss(ilObjStyleSheet::getPlaceHolderStylePath());

                return parent::showPage();
        }
    }

Here is the call graph for this function:

Field Documentation

$may_write

bool ilPortfolioTemplatePageGUI::$may_write = false

protected

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

---

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

• Modules/Portfolio/Template/class.ilPortfolioTemplatePageGUI.php