Mirrors/grav
1
0
Fork 0
mirror of https://github.com/getgrav/grav.git synced 2025-02-20 19:56:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactoring and generic link support

Browse Source
This commit is contained in:
Andy Miller 2022-01-09 15:51:00 -07:00
parent 756b088ada
commit 8767bfb9b0
No known key found for this signature in database
GPG Key ID: 9F2CF38AEBDB0AE0
5 changed files with 114 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
system/src/Grav/Common/Assets.php
View File

@ -30,12 +30,15 @@ class Assets extends PropertyObject
use TestingAssetsTrait;
use LegacyAssetsTrait;
const LINK = 'link';
const CSS = 'css';
const JS = 'js';
const JS_MODULE = 'js_module';
const LINK_COLLECTION = 'assets_link';
const CSS_COLLECTION = 'assets_css';
const JS_COLLECTION = 'assets_js';
const JS_MODULE_COLLECTION = 'assets_js_module';
const LINK_TYPE = Assets\Link::class;
const CSS_TYPE = Assets\Css::class;
const JS_TYPE = Assets\Js::class;
const JS_MODULE_TYPE = Assets\JsModule::class;
@ -232,7 +235,7 @@ class Assets extends PropertyObject
return $this;
}
if (($type === $this::CSS_TYPE || $type === $this::JS_TYPE || $type === $this::JS_MODULE_TYPE) && isset($this->collections[$asset])) {
if ($this->isValidType($type) && isset($this->collections[$asset])) {
$this->addType($collection, $type, $this->collections[$asset], $options);
return $this;
}
@ -241,18 +244,7 @@ class Assets extends PropertyObject
if (isset($options['pipeline'])) {
if ($options['pipeline'] === false) {
switch ($type) {
case $this::JS_TYPE:
case $this::INLINE_JS_TYPE:
$exclude_type = $this::JS;
break;
case $this::JS_MODULE_TYPE:
case $this::INLINE_JS_MODULE_TYPE:
$exclude_type = $this::JS_MODULE;
break;
default:
$exclude_type = $this::CSS;
}
$exclude_type = $this->getBaseType($type);
$excludes = strtolower($exclude_type . '_pipeline_before_excludes');
if ($this->{$excludes}) {
@ -292,6 +284,16 @@ class Assets extends PropertyObject
return $this;
}
/**
* Add a CSS asset or a collection of assets.
*
* @return $this
*/
public function addLink($asset)
{
return $this->addType($this::LINK_COLLECTION, $this::LINK_TYPE, $asset, $this->unifyLegacyArguments(func_get_args(), $this::LINK_TYPE));
}
/**
* Add a CSS asset or a collection of assets.
*
@ -442,7 +444,7 @@ class Assets extends PropertyObject
$after_assets = $this->filterAssets($group_assets, 'position', 'after', true);
// Pipeline
if ($this->{$pipeline_enabled}) {
if ($this->{$pipeline_enabled} ?? false) {
$options = array_merge($this->pipeline_options, ['timestamp' => $this->timestamp]);
$pipeline = new Pipeline($options);
@ -476,7 +478,9 @@ class Assets extends PropertyObject
*/
public function css($group = 'head', $attributes = [])
{
return $this->render('css', $group, $attributes);
$output = $this->render(self::LINK, $group, $attributes);
$output .= $this->render(self::CSS, $group, $attributes);
return $output;
}
/**
@ -488,7 +492,32 @@ class Assets extends PropertyObject
*/
public function js($group = 'head', $attributes = [])
{
return $this->render('js', $group, $attributes) . $this->render('js_module', $group, $attributes);
$output = $this->render(self::JS, $group, $attributes);
$output .= $this->render(self::JS_MODULE, $group, $attributes);
return $output;
}
protected function isValidType($type)
{
return in_array($type, [self::CSS_TYPE, self::JS_TYPE, self::JS_MODULE_TYPE]);
}
protected function getBaseType($type)
{
switch ($type) {
case $this::JS_TYPE:
case $this::INLINE_JS_TYPE:
$base_type = $this::JS;
break;
case $this::JS_MODULE_TYPE:
case $this::INLINE_JS_MODULE_TYPE:
$base_type = $this::JS_MODULE;
break;
default:
$base_type = $this::CSS;
}
return $base_type;
}
}

5
system/src/Grav/Common/Assets/BaseAsset.php
View File

@ -26,8 +26,9 @@ abstract class BaseAsset extends PropertyObject
{
use AssetUtilsTrait;
protected const CSS_ASSET = true;
protected const JS_ASSET = false;
protected const CSS_ASSET = 1;
protected const JS_ASSET = 2;
protected const JS_MODULE_ASSET = 3;
/** @var string|false */
protected $asset;

10
system/src/Grav/Common/Assets/InlineJsModule.php
View File

@ -15,7 +15,7 @@ use Grav\Common\Utils;
* Class InlineJs
* @package Grav\Common\Assets
*/
class InlineJsModule extends InlineJs
class InlineJsModule extends BaseAsset
{
/**
* InlineJs constructor.
@ -35,4 +35,12 @@ class InlineJsModule extends InlineJs
parent::__construct($merged_attributes, $key);
}
/**
* @return string
*/
public function render()
{
return '<script' . $this->renderAttributes(). ">\n" . trim($this->asset) . "\n</script>\n";
}
}

15
system/src/Grav/Common/Assets/JsModule.php
View File

@ -15,7 +15,7 @@ use Grav\Common\Utils;
* Class Js
* @package Grav\Common\Assets
*/
class JsModule extends Js
class JsModule extends BaseAsset
{
/**
* Js constructor.
@ -33,4 +33,17 @@ class JsModule extends Js
parent::__construct($merged_attributes, $key);
}
/**
* @return string
*/
public function render()
{
if (isset($this->attributes['loading']) && $this->attributes['loading'] === 'inline') {
$buffer = $this->gatherLinks([$this], self::JS_MODULE_ASSET);
return '<script' . $this->renderAttributes() . ">\n" . trim($buffer) . "\n</script>\n";
}
return '<script src="' . trim($this->asset) . $this->renderQueryString() . '"' . $this->renderAttributes() . $this->integrityHash($this->asset) . "></script>\n";
}
}

43
system/src/Grav/Common/Assets/Link.php Normal file
View File

@ -0,0 +1,43 @@
<?php
/**
* @package Grav\Common\Assets
*
* @copyright Copyright (c) 2015 - 2022 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
*/
namespace Grav\Common\Assets;
use Grav\Common\Utils;
/**
* Class Link
* @package Grav\Common\Assets
*/
class Link extends BaseAsset
{
/**
* Css constructor.
* @param array $elements
* @param string|null $key
*/
public function __construct(array $elements = [], ?string $key = null)
{
$base_options = [
'asset_type' => 'link',
];
$merged_attributes = Utils::arrayMergeRecursiveUnique($base_options, $elements);
parent::__construct($merged_attributes, $key);
}
/**
* @return string
*/
public function render()
{
return '<link href="' . trim($this->asset) . $this->renderQueryString() . '"' . $this->renderAttributes() . $this->integrityHash($this->asset) . ">\n";
}
}