mirror of
https://github.com/YunoHost-Apps/webtrees_ynh.git
synced 2024-09-03 18:26:37 +02:00
139 lines
3.8 KiB
PHP
139 lines
3.8 KiB
PHP
<?php
|
||
/**
|
||
* webtrees: online genealogy
|
||
* Copyright (C) 2016 webtrees development team
|
||
* This program is free software: you can redistribute it and/or modify
|
||
* it under the terms of the GNU General Public License as published by
|
||
* the Free Software Foundation, either version 3 of the License, or
|
||
* (at your option) any later version.
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU General Public License for more details.
|
||
* You should have received a copy of the GNU General Public License
|
||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
*/
|
||
namespace Fisharebest\Webtrees\Controller;
|
||
|
||
use Fisharebest\Webtrees\Database;
|
||
|
||
/**
|
||
* Base controller for all other controllers
|
||
*/
|
||
class BaseController {
|
||
// The controller accumulates Javascript (inline and external), and renders it in the footer
|
||
const JS_PRIORITY_HIGH = 0;
|
||
const JS_PRIORITY_NORMAL = 1;
|
||
const JS_PRIORITY_LOW = 2;
|
||
|
||
/** @var string[][] Inline JavaScript to add to the page. */
|
||
private $inline_javascript = array(
|
||
self::JS_PRIORITY_HIGH => array(),
|
||
self::JS_PRIORITY_NORMAL => array(),
|
||
self::JS_PRIORITY_LOW => array(),
|
||
);
|
||
|
||
/** @var string[] Exteral JavaScript files to load. */
|
||
private $external_javascript = array();
|
||
|
||
/**
|
||
* Startup activity
|
||
*/
|
||
public function __construct() {
|
||
}
|
||
|
||
/**
|
||
* Make a list of external Javascript, so we can render them in the footer
|
||
*
|
||
* @param string $script_name
|
||
*
|
||
* @return $this
|
||
*/
|
||
public function addExternalJavascript($script_name) {
|
||
$this->external_javascript[$script_name] = true;
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Make a list of inline Javascript, so we can render them in the footer
|
||
* NOTE: there is no need to use "jQuery(document).ready(function(){...})", etc.
|
||
* as this Javascript won’t be inserted until the very end of the page.
|
||
*
|
||
* @param string $script
|
||
* @param int $priority
|
||
*
|
||
* @return $this
|
||
*/
|
||
public function addInlineJavascript($script, $priority = self::JS_PRIORITY_NORMAL) {
|
||
$tmp = &$this->inline_javascript[$priority];
|
||
$tmp[] = $script;
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* We've collected up Javascript fragments while rendering the page.
|
||
* Now display them in order.
|
||
*
|
||
* @return string
|
||
*/
|
||
public function getJavascript() {
|
||
$javascript1 = '';
|
||
$javascript2 = '';
|
||
$javascript3 = '';
|
||
|
||
// Inline (high priority) javascript
|
||
foreach ($this->inline_javascript[self::JS_PRIORITY_HIGH] as $script) {
|
||
$javascript1 .= $script;
|
||
}
|
||
|
||
// External javascript
|
||
foreach (array_keys($this->external_javascript) as $script_name) {
|
||
$javascript2 .= '<script src="' . $script_name . '"></script>';
|
||
}
|
||
|
||
// Inline (lower priority) javascript
|
||
if ($this->inline_javascript) {
|
||
foreach ($this->inline_javascript as $priority => $scripts) {
|
||
if ($priority !== self::JS_PRIORITY_HIGH) {
|
||
foreach ($scripts as $script) {
|
||
$javascript3 .= $script;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// We could, in theory, inject JS at any point in the page (not just the bottom) - prepare for next time
|
||
$this->inline_javascript = array(
|
||
self::JS_PRIORITY_HIGH => array(),
|
||
self::JS_PRIORITY_NORMAL => array(),
|
||
self::JS_PRIORITY_LOW => array(),
|
||
);
|
||
$this->external_javascript = array();
|
||
|
||
return '<script>' . $javascript1 . '</script>' . $javascript2 . '<script>' . $javascript3 . '</script>';
|
||
}
|
||
|
||
/**
|
||
* Print the page header, using the theme
|
||
*
|
||
* @return $this
|
||
*/
|
||
public function pageHeader() {
|
||
// We've displayed the header - display the footer automatically
|
||
register_shutdown_function(array($this, 'pageFooter'));
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Print the page footer, using the theme
|
||
*/
|
||
public function pageFooter() {
|
||
if (WT_DEBUG_SQL) {
|
||
echo Database::getQueryLog();
|
||
}
|
||
echo $this->getJavascript();
|
||
}
|
||
}
|