composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

N°3750 Allow to detect when ready scripts are done processing

Browse Source 
In iTop 3.0.0 there are sometimes lots of scripts launched after domReady, so we needed something to know when those scripts are done !
This commit is contained in:
Pierre Goiffon
2021-03-02 09:23:27 +01:00
parent 225c176f71
commit 77d4613bd8
4 changed files with 66 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
sources/application/WebPage/AjaxPage.php
View File

@@ -179,7 +179,7 @@ EOF
'aCssInline' => $this->a_styles,
'aJsFiles' => $this->a_linked_scripts,
'aJsInlineLive' => $this->a_scripts,
'aJsInlineOnDomReady' => $this->a_ready_scripts,
'aJsInlineOnDomReady' => $this->GetReadyScripts(),
'aJsInlineOnInit' => $this->a_init_scripts,
'bEscapeContent' => ($this->sContentType == 'text/html') && ($this->sContentDisposition == 'inline'),
// TODO 3.0.0: TEMP, used while developping, remove it.

14
sources/application/WebPage/NiceWebPage.php
View File

@@ -235,4 +235,18 @@ EOF
)
);
}
protected function GetReadyScriptsStartedTrigger(): ?string
{
return <<<JS
$("body").data("ready-scripts", "start");
JS;
}
protected function GetReadyScriptsFinishedTrigger(): ?string
{
return <<<JS
$("body").data("ready-scripts", "done");
JS;
}
}

51
sources/application/WebPage/WebPage.php
View File

@@ -59,7 +59,10 @@ class WebPage implements Page
protected $a_scripts;
/** @var array Scripts to be executed when the DOM is ready (typical JQuery use), right before "ready scripts" */
protected $a_init_scripts;
/** @var array Scripts to be executed when the DOM is ready, with a slight delay, after the "init scripts" */
/**
* @see GetReadyScripts getter that adds custom script at the end
* @var array Scripts to be executed when the DOM is ready, with a slight delay, after the "init scripts"
*/
protected $a_ready_scripts;
/** @var array Scripts linked (externals) to the page through URIs */
protected $a_linked_scripts;
@@ -518,11 +521,53 @@ class WebPage implements Page
}
}
/**
* @return array all the script added, plus a last one to know when ready scripts are done processing
* @since 3.0.0 N°3750 method creation
* @uses self::a_ready_scripts
* @uses self::GetReadyScriptsStartedTrigger
* @uses self::GetReadyScriptsFinishedTrigger
*/
protected function GetReadyScripts(): array
{
$aReadyScripts = $this->a_ready_scripts;
$sReadyStartedTriggerScript = $this->GetReadyScriptsStartedTrigger();
if (!empty($sReadyStartedTriggerScript)) {
array_unshift($aReadyScripts, $sReadyStartedTriggerScript);
}
$sReadyFinishedTriggerScript = $this->GetReadyScriptsFinishedTrigger();
if (!empty($sReadyFinishedTriggerScript)) {
$aReadyScripts[] = $sReadyFinishedTriggerScript;
}
return $aReadyScripts;
}
/**
* @return ?string script to execute before all ready scripts
* @since 3.0.0 N°3750 method creation
*/
protected function GetReadyScriptsStartedTrigger(): ?string
{
return null;
}
/**
* @return ?string script to execute after all ready scripts are done processing
* @since 3.0.0 N°3750 method creation
*/
protected function GetReadyScriptsFinishedTrigger(): ?string
{
return null;
}
/**
* Empty all base linked scripts for the page
*
* @uses \WebPage::$a_linked_scripts
* @return void
* @uses \WebPage::$a_linked_scripts
* @since 3.0.0
*/
protected function EmptyLinkedScripts(): void
@@ -1041,7 +1086,7 @@ class WebPage implements Page
'aCssInline' => $this->a_styles,
'aJsFiles' => $this->a_linked_scripts,
'aJsInlineLive' => $this->a_scripts,
'aJsInlineOnDomReady' => $this->a_ready_scripts,
'aJsInlineOnDomReady' => $this->GetReadyScripts(),
'aJsInlineOnInit' => $this->a_init_scripts,
// TODO 3.0.0: TEMP, used while developing, remove it.

7
sources/application/WebPage/iTopWebPage.php
View File

@@ -925,7 +925,7 @@ HTML;
'aCssInline' => $this->a_styles,
'aJsFiles' => $this->a_linked_scripts,
'aJsInlineOnInit' => $this->a_init_scripts,
'aJsInlineOnDomReady' => $this->a_ready_scripts,
'aJsInlineOnDomReady' => $this->GetReadyScripts(),
'aJsInlineLive' => $this->a_scripts,
// TODO 3.0.0: TEMP, used while developping, remove it.
'sSanitizedContent' => utils::FilterXSS($this->s_content),
@@ -1244,9 +1244,8 @@ EOF
*/
protected function OutputPrintable(): BlockPrintHeader
{
$oBlock= new BlockPrintHeader();
$oBlock = new BlockPrintHeader();
return $oBlock;
}
}