ilPCLauncher Class Reference

LSO Startbutton for PageEditor. More...

Inheritance diagram for ilPCLauncher:

Collaboration diagram for ilPCLauncher:

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 = 'lsolauncher'
const	PCELEMENT = 'Launcher'
const	PLACEHOLDER = '[[[LAUNCHER]]]'
const	PROVIDING_TYPES = ['lso']
Data Fields inherited from ilPageContent
string	$hier_id = ""
DOMNode	$dom_node = null
string	$page_lang = ""

Protected Member Functions
	supportsLauncher (int $parent_obj_id)
	replaceWithRenderedButtons (int $obj_id, $html)
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=[])

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

Detailed Description

LSO Startbutton for PageEditor.

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

Member Function Documentation

create()

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

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

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

init()

ilPCLauncher::init

(

)

Init object.

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

Reimplemented from ilPageContent.

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

                          : void
    {
        $this->setType(self::PCTYPE);
    }

References ilPageContent\setType().

Here is the call graph for this function:

modifyPageContentPostXsl()

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

Modify page content after xsl.

Reimplemented from ilPageContent.

Definition at line 50 of file class.ilPCLauncher.php.

     : string {
        if ($a_mode == 'edit') {
            return $a_output;
        }
 
        $parent_obj_id = (int) $this->getPage()->getParentId();
        if ($this->supportsLauncher($parent_obj_id)) {
            $a_output = $this->replaceWithRenderedButtons($parent_obj_id, $a_output);
        }
 
        return $a_output;
    }

replaceWithRenderedButtons()

ilPCLauncher::replaceWithRenderedButtons ( int  $obj_id,   $html  )

protected

Definition at line 73 of file class.ilPCLauncher.php.

                                                                     : string
    {
        $lso = \ilObjectFactory::getInstanceByObjId($obj_id);
        $rendered_buttons = $lso->getCurrentUserLaunchButtons();
        return str_replace(self::PLACEHOLDER, $rendered_buttons, $html);
    }

References ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

supportsLauncher()

ilPCLauncher::supportsLauncher ( int  $parent_obj_id )

protected

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

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

References ilObject\_lookupType().

Here is the call graph for this function:

Field Documentation

PCELEMENT

const ilPCLauncher::PCELEMENT = 'Launcher'

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

Referenced by ilLearningSequencePageObjectGUI\getPageConfig(), and ilObjLearningSequenceLearnerGUI\view().

PCTYPE

const ilPCLauncher::PCTYPE = 'lsolauncher'

Definition at line 26 of file class.ilPCLauncher.php.

PLACEHOLDER

const ilPCLauncher::PLACEHOLDER = '[[[LAUNCHER]]]'

Definition at line 28 of file class.ilPCLauncher.php.

PROVIDING_TYPES

const ilPCLauncher::PROVIDING_TYPES = ['lso']

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

---

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

• components/ILIAS/LearningSequence/classes/PageEditor/class.ilPCLauncher.php