Put your upload form here.
266 | 267 | 268 | ``` 269 | 270 | ... served as: 271 | ```html 272 | 273 | 274 |Put your upload form here.
282 | 283 | 284 | 285 | 286 | 287 | ``` 288 | 289 | ## Vendor Classes 290 | 291 | This library includes two abstract class stubs to ease working with third-party assets. 292 | `VendorPublisher` is a wrapper for the framework's [Publisher Library](https://codeigniter.com/user_guide/libraries/publisher.html) 293 | primed for use with `Assets`, and `VendorBundle` is a specialized version of this library's 294 | `Bundle` primed to handle assets published via `VendorPublisher`. Together these two classes 295 | can take a lot of the work out of managing assets you include from external sources. 296 | 297 | Let's revisit the example above... Instead of copies the files into **public/assets/** ourselves 298 | (and re-copying every time there is an update) let's create a `VendorPublisher` to do that 299 | for us. In **app/Publishers/BootstrapPublisher.php**: 300 | ```php 301 | Note: Since these are external dependencies be sure to exclude them from your repo with your **.gitignore** file. 320 | 321 | Now lets use these assets. We can create a new `VendorBundle` and use the new `addPath()` 322 | method to access the same files we just published from Composer's vendor directory. 323 | In **app/Bundles/BootstrapBundle.php**: 324 | ```php 325 | addPath('bootstrap/bootstrap.min.css') 337 | ->addPath('bootstrap/bootstrap.bundle.min.js'); 338 | } 339 | } 340 | ``` 341 | 342 | Now add the new bundle to our **app/Config/Assets.php** routes: 343 | ```php 344 | public $routes = [ 345 | '*' => [\App\Bundles\BootstrapBundle::class], 346 | ]; 347 | ``` 348 | 349 | And we have hands-free Bootstrap updates from now on! 350 | 351 | ## Testing 352 | 353 | This library includes some PHPUnit extension classes in **src/Test/** to assist with testing 354 | Assets and Bundles. These are used to test the files from this library but are also available 355 | for your own libraries and projects to use. Simply extend the appropriate test case and add 356 | a data provider method with your class name and criteria to meet. See the test files in 357 | **tests/** for examples. 358 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | The development team and community take all security issues seriously. **Please do not make public any uncovered flaws.** 4 | 5 | ## Reporting a Vulnerability 6 | 7 | Thank you for improving the security of our code! Any assistance in removing security flaws will be acknowledged. 8 | 9 | **Please report security flaws by emailing the development team directly: support@tattersoftware.com**. 10 | 11 | The lead maintainer will acknowledge your email within 48 hours, and will send a more detailed response within 48 hours indicating 12 | the next steps in handling your report. After the initial reply to your report, the security team will endeavor to keep you informed of the 13 | progress towards a fix and full announcement, and may ask for additional information or guidance. 14 | 15 | ## Disclosure Policy 16 | 17 | When the security team receives a security bug report, they will assign it to a primary handler. 18 | This person will coordinate the fix and release process, involving the following steps: 19 | 20 | - Confirm the problem and determine the affected versions. 21 | - Audit code to find any potential similar problems. 22 | - Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible. 23 | 24 | ## Comments on this Policy 25 | 26 | If you have suggestions on how this process could be improved please submit a Pull Request. 27 | -------------------------------------------------------------------------------- /UPGRADING.md: -------------------------------------------------------------------------------- 1 | # Upgrade Guide 2 | 3 | ## Version 2 to 3 4 | *** 5 | 6 | > Note: This is a complete refactor! Please be sure to read the docs carefully before upgrading. 7 | 8 | * Minimum PHP version has been bumped to `7.4` to match the upcoming framework changes 9 | * All properties that can be typed have been 10 | * The services no longer exist; remove all references to `Services::Assets` and `Services::manifests` to avoid exceptions 11 | * This library no longer publishes Assets; convert Manifests to the framework's new [Publisher format](https://codeigniter.com/user_guide/libraries/publisher.html) 12 | * Many of the example Manifests now have an official Publisher equivalent at [Tatter\Frontend](https://github.com/tattersoftware/codeigniter4-frontend) 13 | * The `DirectoryHandler` (mapping public directories to routes) has no equivalent in `v3` so be sure to create explicit bundles and routes for any you were using 14 | * The view files have been removed and replaced by `AssetsFilter` to handle tag injection directly; read the docs on setting up the filter 15 | 16 | For an example of converting a `v2` JSON manifest to a `v3` framework Publisher compare these files: 17 | 18 | * https://github.com/tattersoftware/codeigniter4-assets/blob/267220d437786e0ddb9d7681745f5942d95c543b/manifests/FontAwesome.json 19 | * https://github.com/tattersoftware/codeigniter4-frontend/blob/ae61773f279333c3a606498364977a8cec45d303/src/Publishers/FontAwesomePublisher.php 20 | -------------------------------------------------------------------------------- /composer-unused.php: -------------------------------------------------------------------------------- 1 | addNamedFilter(NamedFilter::fromString('symfony/config')) 13 | // ->addPatternFilter(PatternFilter::fromString('/symfony-.*/')) 14 | ->setAdditionalFilesFor('codeigniter4/framework', [ 15 | ...Glob::glob(__DIR__ . '/vendor/codeigniter4/framework/system/Helpers/*.php'), 16 | ]); 17 | }; 18 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tatter/assets", 3 | "type": "library", 4 | "description": "Asset publishing and loading for CodeIgniter 4", 5 | "keywords": [ 6 | "codeigniter", 7 | "codeigniter4", 8 | "assets", 9 | "loader", 10 | "css", 11 | "javascript" 12 | ], 13 | "homepage": "https://github.com/tattersoftware/codeigniter4-assets", 14 | "license": "MIT", 15 | "authors": [ 16 | { 17 | "name": "Matthew Gatner", 18 | "email": "mgatner@tattersoftware.com", 19 | "homepage": "https://tattersoftware.com", 20 | "role": "Developer" 21 | } 22 | ], 23 | "require": { 24 | "php": "^7.4 || ^8.0" 25 | }, 26 | "require-dev": { 27 | "codeigniter4/framework": "^4.1", 28 | "tatter/tools": "^2.0" 29 | }, 30 | "config": { 31 | "allow-plugins": { 32 | "phpstan/extension-installer": true 33 | } 34 | }, 35 | "autoload": { 36 | "psr-4": { 37 | "Tatter\\Assets\\": "src" 38 | }, 39 | "exclude-from-classmap": [ 40 | "**/Database/Migrations/**" 41 | ] 42 | }, 43 | "autoload-dev": { 44 | "psr-4": { 45 | "Tests\\Support\\": "tests/_support" 46 | } 47 | }, 48 | "minimum-stability": "dev", 49 | "prefer-stable": true, 50 | "scripts": { 51 | "analyze": "phpstan analyze", 52 | "ci": [ 53 | "Composer\\Config::disableProcessTimeout", 54 | "@deduplicate", 55 | "@analyze", 56 | "@test", 57 | "@inspect", 58 | "rector process", 59 | "@style" 60 | ], 61 | "deduplicate": "phpcpd app/ src/", 62 | "inspect": "deptrac analyze --cache-file=build/deptrac.cache", 63 | "mutate": "infection --threads=2 --skip-initial-tests --coverage=build/phpunit", 64 | "retool": "retool", 65 | "style": "php-cs-fixer fix --verbose --ansi --using-cache=no", 66 | "test": "phpunit" 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /deptrac.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | paths: 3 | - ./src/ 4 | - ./vendor/codeigniter4/framework/system/ 5 | exclude_files: 6 | - '#.*test.*#i' 7 | layers: 8 | - name: Model 9 | collectors: 10 | - type: bool 11 | must: 12 | - type: className 13 | regex: .*[A-Za-z]+Model$ 14 | must_not: 15 | - type: directory 16 | regex: vendor/.* 17 | - name: Vendor Model 18 | collectors: 19 | - type: bool 20 | must: 21 | - type: className 22 | regex: .*[A-Za-z]+Model$ 23 | - type: directory 24 | regex: vendor/.* 25 | - name: Controller 26 | collectors: 27 | - type: bool 28 | must: 29 | - type: className 30 | regex: .*\/Controllers\/.* 31 | must_not: 32 | - type: directory 33 | regex: vendor/.* 34 | - name: Vendor Controller 35 | collectors: 36 | - type: bool 37 | must: 38 | - type: className 39 | regex: .*\/Controllers\/.* 40 | - type: directory 41 | regex: vendor/.* 42 | - name: Config 43 | collectors: 44 | - type: bool 45 | must: 46 | - type: directory 47 | regex: src/Config/.* 48 | must_not: 49 | - type: className 50 | regex: .*Services 51 | - type: directory 52 | regex: vendor/.* 53 | - name: Vendor Config 54 | collectors: 55 | - type: bool 56 | must: 57 | - type: directory 58 | regex: vendor/.*/Config/.* 59 | must_not: 60 | - type: className 61 | regex: .*Services 62 | - name: Entity 63 | collectors: 64 | - type: bool 65 | must: 66 | - type: directory 67 | regex: src/Entities/.* 68 | must_not: 69 | - type: directory 70 | regex: vendor/.* 71 | - name: Vendor Entity 72 | collectors: 73 | - type: bool 74 | must: 75 | - type: directory 76 | regex: vendor/.*/Entities/.* 77 | - name: View 78 | collectors: 79 | - type: bool 80 | must: 81 | - type: directory 82 | regex: src/Views/.* 83 | must_not: 84 | - type: directory 85 | regex: vendor/.* 86 | - name: Vendor View 87 | collectors: 88 | - type: bool 89 | must: 90 | - type: directory 91 | regex: vendor/.*/Views/.* 92 | - name: Service 93 | collectors: 94 | - type: className 95 | regex: .*Services.* 96 | ruleset: 97 | Entity: 98 | - Config 99 | - Model 100 | - Service 101 | - Vendor Config 102 | - Vendor Entity 103 | - Vendor Model 104 | Config: 105 | - Service 106 | - Vendor Config 107 | Model: 108 | - Config 109 | - Entity 110 | - Service 111 | - Vendor Config 112 | - Vendor Entity 113 | - Vendor Model 114 | Service: 115 | - Config 116 | - Vendor Config 117 | 118 | # Ignore anything in the Vendor layers 119 | Vendor Model: 120 | - Config 121 | - Service 122 | - Vendor Config 123 | - Vendor Controller 124 | - Vendor Entity 125 | - Vendor Model 126 | - Vendor View 127 | Vendor Controller: 128 | - Service 129 | - Vendor Config 130 | - Vendor Controller 131 | - Vendor Entity 132 | - Vendor Model 133 | - Vendor View 134 | Vendor Config: 135 | - Config 136 | - Service 137 | - Vendor Config 138 | - Vendor Controller 139 | - Vendor Entity 140 | - Vendor Model 141 | - Vendor View 142 | Vendor Entity: 143 | - Service 144 | - Vendor Config 145 | - Vendor Controller 146 | - Vendor Entity 147 | - Vendor Model 148 | - Vendor View 149 | Vendor View: 150 | - Service 151 | - Vendor Config 152 | - Vendor Controller 153 | - Vendor Entity 154 | - Vendor Model 155 | - Vendor View 156 | skip_violations: 157 | -------------------------------------------------------------------------------- /infection.json.dist: -------------------------------------------------------------------------------- 1 | { 2 | "source": { 3 | "directories": [ 4 | "src/" 5 | ], 6 | "excludes": [ 7 | "Config", 8 | "Database/Migrations", 9 | "Views" 10 | ] 11 | }, 12 | "logs": { 13 | "text": "build/infection.log" 14 | }, 15 | "mutators": { 16 | "@default": true 17 | }, 18 | "bootstrap": "vendor/codeigniter4/framework/system/Test/bootstrap.php" 19 | } 20 | -------------------------------------------------------------------------------- /manifests/Bootstrap.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "twbs/bootstrap/dist", 3 | "destination": "vendor/bootstrap", 4 | "resources": [ 5 | { 6 | "source": "css" 7 | }, 8 | { 9 | "source": "js" 10 | } 11 | ] 12 | } 13 | -------------------------------------------------------------------------------- /manifests/ChartJS.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "nnnick/chartjs/dist", 3 | "destination": "vendor/chartjs", 4 | "resources": [ 5 | { 6 | "source": ".", 7 | "recursive": true 8 | } 9 | ] 10 | } 11 | -------------------------------------------------------------------------------- /manifests/DataTables.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "peekleon/datatables-all", 3 | "destination": "vendor/datatables", 4 | "resources": [ 5 | { 6 | "source": "media", 7 | "recursive": true 8 | }, 9 | { 10 | "source": "extensions/Buttons/css", 11 | "destination": "css", 12 | "filter": "#\\.css$#" 13 | }, 14 | { 15 | "source": "extensions/Buttons/js", 16 | "destination": "js", 17 | "filter": "#\\.js$#" 18 | } 19 | ] 20 | } 21 | -------------------------------------------------------------------------------- /manifests/Dropzone.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "enyo/dropzone/dist", 3 | "destination": "vendor/dropzone", 4 | "resources": [ 5 | { 6 | "source": ".", 7 | "recursive": true, 8 | "flatten": true 9 | } 10 | ] 11 | } 12 | -------------------------------------------------------------------------------- /manifests/Featherlight.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "bower-asset/featherlight/release", 3 | "destination": "vendor/featherlight", 4 | "resources": [ 5 | { 6 | "source": "." 7 | } 8 | ] 9 | } 10 | -------------------------------------------------------------------------------- /manifests/FontAwesome.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "fortawesome/font-awesome", 3 | "destination": "vendor/font-awesome", 4 | "resources": [ 5 | { 6 | "source": "css", 7 | "destination": "css" 8 | }, 9 | { 10 | "source": "webfonts", 11 | "destination": "webfonts" 12 | } 13 | ] 14 | } 15 | -------------------------------------------------------------------------------- /manifests/SBAdmin2.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "bower-asset/sbadmin2", 3 | "destination": "vendor/sbadmin2", 4 | "resources": [ 5 | { 6 | "source": "css" 7 | }, 8 | { 9 | "source": "js", 10 | "filter": "#\\.js$#" 11 | }, 12 | { 13 | "source": "vendor/jquery-easing", 14 | "filter": "#\\.js$#" 15 | } 16 | ] 17 | } 18 | -------------------------------------------------------------------------------- /manifests/SortableJS.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "npm-asset/sortablejs", 3 | "destination": "vendor/sortablejs", 4 | "resources": [ 5 | { 6 | "source": ".", 7 | "filter": "#\\.js$#" 8 | } 9 | ] 10 | } 11 | -------------------------------------------------------------------------------- /manifests/TinyMCE.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "tinymce/tinymce", 3 | "destination": "vendor/tinymce", 4 | "resources": [ 5 | { 6 | "source": ".", 7 | "filter": "#\\.js$#" 8 | }, 9 | { 10 | "source": "plugins", 11 | "destination": "plugins", 12 | "recursive": true 13 | }, 14 | { 15 | "source": "skins", 16 | "destination": "skins", 17 | "recursive": true 18 | }, 19 | { 20 | "source": "themes", 21 | "destination": "themes", 22 | "recursive": true 23 | } 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /manifests/jQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": "components/jquery", 3 | "destination": "vendor/jquery", 4 | "resources": [ 5 | { 6 | "source": ".", 7 | "filter": "#^jquery.+#" 8 | } 9 | ] 10 | } 11 | -------------------------------------------------------------------------------- /rector.php: -------------------------------------------------------------------------------- 1 | sets([ 41 | SetList::DEAD_CODE, 42 | LevelSetList::UP_TO_PHP_74, 43 | PHPUnitSetList::PHPUNIT_CODE_QUALITY, 44 | PHPUnitSetList::PHPUNIT_90, 45 | ]); 46 | 47 | $rectorConfig->parallel(); 48 | 49 | // The paths to refactor (can also be supplied with CLI arguments) 50 | $rectorConfig->paths([ 51 | __DIR__ . '/src/', 52 | __DIR__ . '/tests/', 53 | ]); 54 | 55 | // Include Composer's autoload - required for global execution, remove if running locally 56 | $rectorConfig->autoloadPaths([ 57 | __DIR__ . '/vendor/autoload.php', 58 | ]); 59 | 60 | // Do you need to include constants, class aliases, or a custom autoloader? 61 | $rectorConfig->bootstrapFiles([ 62 | realpath(getcwd()) . '/vendor/codeigniter4/framework/system/Test/bootstrap.php', 63 | ]); 64 | 65 | if (is_file(__DIR__ . '/phpstan.neon.dist')) { 66 | $rectorConfig->phpstanConfig(__DIR__ . '/phpstan.neon.dist'); 67 | } 68 | 69 | // Set the target version for refactoring 70 | $rectorConfig->phpVersion(PhpVersion::PHP_74); 71 | 72 | // Auto-import fully qualified class names 73 | $rectorConfig->importNames(); 74 | 75 | // Are there files or rules you need to skip? 76 | $rectorConfig->skip([ 77 | __DIR__ . '/src/Views', 78 | 79 | JsonThrowOnErrorRector::class, 80 | StringifyStrNeedlesRector::class, 81 | YieldDataProviderRector::class, 82 | 83 | // Note: requires php 8 84 | RemoveUnusedPromotedPropertyRector::class, 85 | AnnotationWithValueToAttributeRector::class, 86 | 87 | // May load view files directly when detecting classes 88 | StringClassNameToClassConstantRector::class, 89 | ]); 90 | 91 | // auto import fully qualified class names 92 | $rectorConfig->importNames(); 93 | 94 | $rectorConfig->rule(SimplifyUselessVariableRector::class); 95 | $rectorConfig->rule(RemoveAlwaysElseRector::class); 96 | $rectorConfig->rule(CountArrayToEmptyArrayComparisonRector::class); 97 | $rectorConfig->rule(ChangeNestedForeachIfsToEarlyContinueRector::class); 98 | $rectorConfig->rule(ChangeIfElseValueAssignToEarlyReturnRector::class); 99 | $rectorConfig->rule(SimplifyStrposLowerRector::class); 100 | $rectorConfig->rule(CombineIfRector::class); 101 | $rectorConfig->rule(SimplifyIfReturnBoolRector::class); 102 | $rectorConfig->rule(InlineIfToExplicitIfRector::class); 103 | $rectorConfig->rule(PreparedValueToEarlyReturnRector::class); 104 | $rectorConfig->rule(ShortenElseIfRector::class); 105 | $rectorConfig->rule(SimplifyIfElseToTernaryRector::class); 106 | $rectorConfig->rule(UnusedForeachValueToArrayKeysRector::class); 107 | $rectorConfig->rule(ChangeArrayPushToArrayAssignRector::class); 108 | $rectorConfig->rule(UnnecessaryTernaryExpressionRector::class); 109 | $rectorConfig->rule(SimplifyRegexPatternRector::class); 110 | $rectorConfig->rule(FuncGetArgsToVariadicParamRector::class); 111 | $rectorConfig->rule(MakeInheritedMethodVisibilitySameAsParentRector::class); 112 | $rectorConfig->rule(SimplifyEmptyArrayCheckRector::class); 113 | $rectorConfig 114 | ->ruleWithConfiguration(TypedPropertyFromAssignsRector::class, [ 115 | /** 116 | * The INLINE_PUBLIC value is default to false to avoid BC break, if you use for libraries and want to preserve BC break, you don't need to configure it, as it included in LevelSetList::UP_TO_PHP_74 117 | * Set to true for projects that allow BC break 118 | */ 119 | TypedPropertyFromAssignsRector::INLINE_PUBLIC => false, 120 | ]); 121 | $rectorConfig->rule(StringClassNameToClassConstantRector::class); 122 | $rectorConfig->rule(PrivatizeFinalClassPropertyRector::class); 123 | $rectorConfig->rule(CompleteDynamicPropertiesRector::class); 124 | }; 125 | -------------------------------------------------------------------------------- /roave-bc-check.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | ignoreErrors: 3 | - '#\[BC\] SKIPPED: .+ could not be found in the located source#' 4 | -------------------------------------------------------------------------------- /src/Asset.php: -------------------------------------------------------------------------------- 1 | uri = rtrim(self::$config->uri, '/\\') . '/'; 58 | self::$config->directory = rtrim(self::$config->directory, '/\\') . DIRECTORY_SEPARATOR; 59 | self::$config->vendor = rtrim(self::$config->vendor, '/\\') . DIRECTORY_SEPARATOR; 60 | } 61 | 62 | return self::$config; 63 | } 64 | 65 | /** 66 | * Changes the configuration. Should only be used during testing. 67 | * 68 | * @internal 69 | */ 70 | public static function useConfig(?AssetsConfig $config) 71 | { 72 | self::$config = $config; 73 | 74 | // If a new config was supplied then use it with Factories, otherwise reset to the "vanilla" version 75 | Factories::injectMock('config', 'Assets', $config ?? new AssetsConfig()); 76 | } 77 | 78 | // -------------------------------------------------------------------- 79 | // Named Constructors 80 | // -------------------------------------------------------------------- 81 | 82 | /** 83 | * Creates a new Asset from a local file. 84 | * 85 | * @param string $path File path relative to the configured directory 86 | */ 87 | public static function createFromPath(string $path): self 88 | { 89 | $config = self::config(); 90 | $path = ltrim($path, '/\\'); 91 | $file = new File($config->directory . $path, true); 92 | 93 | // Build the URI 94 | $uri = $config->uri . $path; 95 | 96 | // Append a timestamp if requested 97 | if ($config->useTimestamps) { 98 | $uri .= '?v=' . $file->getMTime(); 99 | } 100 | 101 | return self::createFromUri($uri); 102 | } 103 | 104 | /** 105 | * Creates a new Asset from a remote file. 106 | * Note that the framework's link_tag() does not support integrity and crossorigin 107 | * fields, so most CDN assets should be created directly. 108 | * 109 | * @param string|null $type One of: 'css', 'js', 'img'; or null to detect from extension 110 | */ 111 | public static function createFromUri(string $uri, ?string $type = null): self 112 | { 113 | helper(['html']); 114 | 115 | if ($type === null) { 116 | $extension = pathinfo(strtok($uri, '?'), PATHINFO_EXTENSION); // Query safe 117 | 118 | // Check for one of the numerous image extension 119 | $type = in_array($extension, self::IMAGE_EXTENSIONS, true) ? 'img' : $extension; 120 | } 121 | 122 | if ($type === 'css') { 123 | return new self(link_tag($uri)); 124 | } 125 | if ($type === 'js') { 126 | return new self(script_tag($uri), false); 127 | } 128 | if ($type === 'img') { 129 | $alt = ucfirst(pathinfo($uri, PATHINFO_FILENAME)); // Query safe 130 | 131 | return new self(img($uri, false, ['alt' => $alt]), false); 132 | } 133 | 134 | throw AssetsException::forUnsupportedType($type); 135 | } 136 | 137 | // -------------------------------------------------------------------- 138 | // Class Methods 139 | // -------------------------------------------------------------------- 140 | 141 | public function __construct(string $tag, bool $head = true) 142 | { 143 | $this->tag = $tag; 144 | $this->head = $head; 145 | } 146 | 147 | public function __toString(): string 148 | { 149 | return $this->tag; 150 | } 151 | 152 | public function isHead(): bool 153 | { 154 | return $this->head; 155 | } 156 | } 157 | -------------------------------------------------------------------------------- /src/Bundle.php: -------------------------------------------------------------------------------- 1 | or . 14 | */ 15 | abstract class Bundle 16 | { 17 | // -------------------------------------------------------------------- 18 | // Initial Assets 19 | // -------------------------------------------------------------------- 20 | 21 | /** 22 | * The Assets. 23 | * 24 | * @var Asset[] 25 | */ 26 | protected array $assets = []; 27 | 28 | /** 29 | * Bundle classes to merge with this Bundle. 30 | * 31 | * @var string[] 32 | */ 33 | protected array $bundles = []; 34 | 35 | /** 36 | * Paths to include in this Bundle. 37 | * 38 | * @var string[] 39 | */ 40 | protected array $paths = []; 41 | 42 | /** 43 | * URIs to include in this Bundle. 44 | * 45 | * @var string[] 46 | */ 47 | protected array $uris = []; 48 | 49 | /** 50 | * Strings to include in this Bundle. 51 | * 52 | * @var string[] 53 | */ 54 | protected array $strings = []; 55 | 56 | // -------------------------------------------------------------------- 57 | // Asset Handling 58 | // -------------------------------------------------------------------- 59 | 60 | /** 61 | * Processes the properties into Assets and calls define(). 62 | */ 63 | final public function __construct() 64 | { 65 | // Put child Bundles first so they are more likely to be overwritten 66 | foreach ($this->bundles as $bundle) { 67 | $this->merge(new $bundle()); 68 | } 69 | 70 | // Create Assets out of the remaining preoperties 71 | foreach ($this->uris as $uri) { 72 | $this->assets[] = Asset::createFromUri($uri); 73 | } 74 | 75 | foreach ($this->paths as $uri) { 76 | $this->assets[] = Asset::createFromPath($uri); 77 | } 78 | 79 | foreach ($this->strings as $string) { 80 | $this->assets[] = new Asset($string); 81 | } 82 | 83 | $this->define(); 84 | } 85 | 86 | /** 87 | * Applies any initial inputs after the constructor. 88 | * This method is a stub to be implemented by child classes. 89 | */ 90 | protected function define(): void 91 | { 92 | } 93 | 94 | /** 95 | * Appends an Asset to the list. 96 | * 97 | * @return $this 98 | */ 99 | final public function add(Asset $asset) 100 | { 101 | $this->assets[] = $asset; 102 | 103 | return $this; 104 | } 105 | 106 | /** 107 | * Merges Assets from another Bundle. 108 | * 109 | * @return $this 110 | */ 111 | final public function merge(Bundle $bundle) 112 | { 113 | foreach ($bundle->getAssets() as $asset) { 114 | $this->add($asset); 115 | } 116 | 117 | return $this; 118 | } 119 | 120 | /** 121 | * Optimizes and returns the list of Assets. 122 | * 123 | * @return Asset[] 124 | */ 125 | final public function getAssets(): array 126 | { 127 | $this->assets = array_values(array_unique($this->assets)); // array_unique works on stringables 128 | 129 | return $this->assets; 130 | } 131 | 132 | // -------------------------------------------------------------------- 133 | // Display Methods 134 | // -------------------------------------------------------------------- 135 | 136 | /** 137 | * Concatenates Assets for the tag. 138 | */ 139 | final public function head(): string 140 | { 141 | return $this->toString(true); 142 | } 143 | 144 | /** 145 | * Concatenates Assets for the tag. 146 | */ 147 | final public function body(): string 148 | { 149 | return $this->toString(false); 150 | } 151 | 152 | /** 153 | * Concatenates all Assets. Probably never very useful. 154 | */ 155 | final public function __toString(): string 156 | { 157 | return $this->toString(); 158 | } 159 | 160 | /** 161 | * Concatenates Assets for the tag. 162 | * 163 | * @param bool|null $head Whether to filter on head/body tag; null returns both 164 | */ 165 | private function toString(?bool $head = null): string 166 | { 167 | $lines = []; 168 | 169 | foreach ($this->getAssets() as $asset) { 170 | if ($head === null || $head === $asset->isHead()) { 171 | $lines[] = (string) $asset; 172 | } 173 | } 174 | 175 | return implode(PHP_EOL, $lines); 176 | } 177 | 178 | // -------------------------------------------------------------------- 179 | // Caching 180 | // -------------------------------------------------------------------- 181 | 182 | /** 183 | * Prepares the bundle for caching. 184 | * 185 | * @return Asset[] 186 | */ 187 | public function __serialize(): array 188 | { 189 | return $this->getAssets(); 190 | } 191 | 192 | /** 193 | * Restores the bundle from cached version. 194 | * 195 | * @param Asset[] $data 196 | */ 197 | public function __unserialize(array $data): void 198 | { 199 | foreach ($data as $asset) { 200 | $this->add($asset); 201 | } 202 | } 203 | } 204 | -------------------------------------------------------------------------------- /src/Config/Assets.php: -------------------------------------------------------------------------------- 1 | [ 59 | * 'https://pagecdn.io/lib/cleave/1.6.0/cleave.min.js', 60 | * \App\Bundles\Bootstrap::class, 61 | * ], 62 | * 'admin/*' => [ 63 | * \Tatter\Frontend\Bundles\AdminLTE::class, 64 | * 'admin/login.js', 65 | * ], 66 | * ]; 67 | * 68 | * @var array