Current File : /home/pacjaorg/wpt.pacja.org/km/libraries/src/HTML/Helpers/Jquery.php |
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2012 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\HTML\Helpers;
use Joomla\CMS\Factory;
use Joomla\CMS\HTML\HTMLHelper;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Utility class for jQuery JavaScript behaviors
*
* @since 3.0
*/
abstract class Jquery
{
/**
* Array containing information for loaded files
*
* @var array
* @since 3.0
*/
protected static $loaded = [];
/**
* Method to load the jQuery JavaScript framework into the document head
*
* If debugging mode is on an uncompressed version of jQuery is included for easier debugging.
*
* @param boolean $noConflict True to load jQuery in noConflict mode [optional]
* @param mixed $debug Is debugging mode on? [optional]
* @param boolean $migrate True to enable the jQuery Migrate plugin
*
* @return void
*
* @since 3.0
*
* @deprecated 4.0 will be removed in 6.0
* Use webasset manager instead
* Example:
* $wa = Factory::getApplication()->getDocument()->getWebAssetManager();
* $wa->useScript('jquery');
* $wa->useScript('jquery-noconflict');
* $wa->useScript('jquery-migrate');
*/
public static function framework($noConflict = true, $debug = null, $migrate = false)
{
$wa = Factory::getApplication()->getDocument()->getWebAssetManager();
$wa->useScript('jquery');
// Check if we are loading in noConflict
if ($noConflict) {
$wa->useScript('jquery-noconflict');
}
// Check if we are loading Migrate
if ($migrate) {
$wa->useScript('jquery-migrate');
}
}
/**
* Auto set CSRF token to ajaxSetup so all jQuery ajax call will contains CSRF token.
*
* @param string $name The CSRF meta tag name.
*
* @return void
*
* @throws \InvalidArgumentException
*
* @since 3.8.0
*/
public static function token($name = 'csrf.token')
{
// Only load once
if (!empty(static::$loaded[__METHOD__][$name])) {
return;
}
static::framework();
HTMLHelper::_('form.csrf', $name);
$doc = Factory::getDocument();
$doc->addScriptDeclaration(
<<<JS
;(function ($) {
$.ajaxSetup({
headers: {
'X-CSRF-Token': Joomla.getOptions('$name')
}
});
})(jQuery);
JS
);
static::$loaded[__METHOD__][$name] = true;
}
}