PageComponent "Status Information" for PageEditor in PRGs. More...

Inheritance diagram for ilPCPRGStatusInfo:

Collaboration diagram for ilPCPRGStatusInfo:

Public Member Functions
	init ()
	Init object. More...

	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)

	setPage (ilPageObject $a_val)

	getPage ()

	init ()
	Init object. More...

	getType ()

	getDomNode ()

	getDomDoc ()

	setDomNode (DOMNode $node)

	getChildNode ()

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	getOnloadCode (string $a_mode)

	setHierId (string $a_hier_id)

	getHierId ()

	lookupHierId ()

	readHierId ()

	setPcId (string $a_pcid)

	getPCId ()

	setFileDownloadLink (string $a_download_link)

	getFileDownloadLink ()

	setProfileBackUrl (string $url)

	getProfileBackUrl ()

	setFullscreenLink (string $a_fullscreen_link)

	getFullscreenLink ()

	setSourcecodeDownloadScript (string $script_name)

	getSourcecodeDownloadScript ()

	readPCId ()

	writePCId (string $a_pc_id)

	setEnabled (string $value)
	Set Enabled value for page content component. More...

	enable ()

	disable ()

	isEnabled ()

	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...

	getNewPageContentNode ()

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

	getModel ()
	Get model as needed for the front-end editor. More...

Data Fields
const	PCTYPE = 'prgstatusinfo'

const	PCELEMENT = 'PRGStatusInfo'

const	PLACEHOLDER = '[[[PRG_STATUS_INFO]]]'

const	PROVIDING_TYPES = ['prg']

Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

Protected Member Functions
	supportsType (int $parent_obj_id)

	replaceWithRendered (int $obj_id, $html)

	getTemplate ()

Protected Member Functions inherited from ilPageContent
	getPageManager ()

	setType (string $a_type)
	Set Type. More...

	hasNode ()

	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Protected Attributes
ilLanguage	$lng

Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc

ILIAS COPage InternalDomainService	$domain

string	$pcid

string	$type = ""

ilPageObject	$pg_obj

string	$file_download_link = ''

string	$fullscreen_link = ''

string	$sourcecode_download_script = ''

ilLogger	$log

string	$profile_back_url = ""

ILIAS COPage Dom DomUtil	$dom_util

PageManagerInterface	$page_manager = null

ObjectAdapterInterface	$object = null

Additional Inherited Members
Static Public Member Functions inherited from ilPageContent
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...

static	getLangVars ()
	Get lang vars needed for editing. More...

static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...

static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...

static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...

static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...

static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Detailed Description

PageComponent "Status Information" for PageEditor in PRGs.

Definition at line 25 of file class.ilPCPRGStatusInfo.php.

Member Function Documentation

◆ create()

ilPCPRGStatusInfo::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = `""`
	)

Definition at line 40 of file class.ilPCPRGStatusInfo.php.

     : void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->cache_node = $this->dom_doc->createElement(self::PCELEMENT);
        $this->cache_node = $this->node->appendChild($this->cache_node);
    }

◆ getTemplate()

ilPCPRGStatusInfo::getTemplate ( )

protected

Definition at line 107 of file class.ilPCPRGStatusInfo.php.

                                    : string
    {
        $template = new ilTemplate("tpl.statusinfo_poeditor_element.html", true, true, 'components/ILIAS/StudyProgramme');
        $icon = "./assets/images/standard/icon_prg.svg";
 
        $template->setVariable("ICON", $icon);
        $template->setVariable("ICON_TEXT", $this->lng->txt("study_programme_icon"));
        $template->setVariable("LABEL", $this->lng->txt("pc_prg_statusinfo_label"));
 
        return $template->get();
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ init()

ilPCPRGStatusInfo::init ( )

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

Definition at line 33 of file class.ilPCPRGStatusInfo.php.

                          : void
    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->setType(self::PCTYPE);
    }

References $DIC, ILIAS\Repository\lng(), and ilPageContent\setType().

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCPRGStatusInfo::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = `false`
	)

Modify page content after xsl.

Reimplemented from ilPageContent.

Definition at line 54 of file class.ilPCPRGStatusInfo.php.

     : string {
        $parent_obj_id = $this->getPage()->getParentId();
        $end = 0;
        $start = strpos($a_output, "[[[PRG_STATUS_INFO");
 
        if (is_int($start)) {
            $end = strpos($a_output, "]]]", $start);
        }
 
        if ($a_mode === 'edit') {
            while ($end > 0) {
                if ($this->supportsType($parent_obj_id)) {
                    $html = $this->getTemplate();
 
                    $a_output = substr($a_output, 0, $start) .
                        $html .
                        substr($a_output, $end + 3);
 
                    $start = strpos($a_output, "[[[PRG_STATUS_INFO", $start + 3);
                    $end = 0;
                    if (is_int($start)) {
                        $end = strpos($a_output, "]]]", $start);
                    }
                }
            }
            return $a_output;
        }
 
        $parent_obj_id = (int) $this->getPage()->getParentId();
        if ($this->supportsType($parent_obj_id)) {
            $a_output = $this->replaceWithRendered($parent_obj_id, $a_output);
        }
        return $a_output;
    }

◆ replaceWithRendered()

ilPCPRGStatusInfo::replaceWithRendered	(	int	$obj_id,
			$html
	)

protected

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

                                                              : string
    {
        $dic = ilStudyProgrammeDIC::dic();
        $builder = $dic['pc.statusinfo'];
        $rendered = $builder->getStatusInfoFor($obj_id);
        return str_replace(self::PLACEHOLDER, $rendered, $html);
    }

References $dic, and ilStudyProgrammeDIC\dic().

Here is the call graph for this function:

◆ supportsType()

ilPCPRGStatusInfo::supportsType ( int $parent_obj_id )

protected

Definition at line 93 of file class.ilPCPRGStatusInfo.php.

                                                       : bool
    {
        $parent_obj_type = \ilObject::_lookupType($parent_obj_id);
        return in_array($parent_obj_type, self::PROVIDING_TYPES);
    }