norberttech / static-content-generator-bundle
Generate static html pages from your symfony application
Installs: 1 173
Dependents: 0
Suggesters: 0
Security: 0
Stars: 33
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: ~8.1 || ~8.2 || ~8.3
- ext-json: *
- norberttech/symfony-process-executor: ^2.0.4
- symfony/browser-kit: ^5.4|^6.4|^7.0
- symfony/dependency-injection: ^5.4|^6.4|^7.0
- symfony/http-kernel: ^5.4|^6.4|^7.0
Requires (Dev)
- doctrine/annotations: ^1.11.1 || ^2.0.0
- nikic/php-parser: ^4.18
- symfony/dotenv: ^5.4|^6.4|^7.0
- symfony/framework-bundle: ^5.4|^6.4|^7.0
- symfony/maker-bundle: ^1.36.4
- symfony/stopwatch: ^5.4|^6.4|^7.0
- symfony/twig-pack: ^1.0
- symfony/web-profiler-bundle: ^5.4|^6.4|^7.0
- symfony/yaml: ^5.4|^6.4|^7.0
This package is auto-updated.
Last update: 2024-11-10 22:14:49 UTC
README
Generate static html pages from all Symfony routes available in your system.
Installation
composer require norberttech/static-content-generator-bundle
Configuration
<?php // bundles.php return [ NorbertTech\StaticContentGeneratorBundle\StaticContentGeneratorBundle::class => ['all' => true], ];
# static_content_generator.yaml static_content_generator: output_directory: "%kernel.project_dir%/output"
Usage
Transform all routes into static html pages.
bin/console static-content-generator:generate:routes
Options:
--parallel=4
- generate static content in parallel using 4 sub processes at once--clean
- clean output path before start--filter-route
- generate content only for given routes--filter-route-prefix
- generate content for routes with given prefix--exclude-route
- generate content for all routes except given--exclude-route-prefix
- generate content for all routes except those with given prefix
Copy all assets from public
directory into output directory
bin/console static-content-generator:copy:assets
Parametrized Routes
In order to dump parametrized routes you need to register service that implements SourceProvider
interface
which will return all possible combinations of parameters for given route you would like to dump.
Don't forget that this services must have static_content_generator.source_provider
tag.
# service.yaml services: FixtureProject\Source\ParametrizedSourceProvider: tags: ['static_content_generator.source_provider']
Controller:
<?php declare(strict_types=1); namespace FixtureProject\Controller; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Routing\Annotation\Route; class StaticRoutesController extends AbstractController { /** * @Route("/parametrized/{param1}/{param2}", name="parametrized_route") */ public function withParameters(string $param1, string $param2) : Response { return $this->render('parametrized.html.twig', ['param1' => $param1, 'param2' => $param2]); } }
Provider:
<?php declare(strict_types=1); namespace FixtureProject\Source; use NorbertTech\StaticContentGeneratorBundle\Content\Source; use NorbertTech\StaticContentGeneratorBundle\Content\SourceProvider; final class ParametrizedSourceProvider implements SourceProvider { public function all() : array { return [ new Source('parametrized_route', ['param1' => 'first-param', 'param2' => 'second-param']), ]; } }
This will generate /output/parametrized/first-param/second-param/index.hmtml
Testing
php -S localhost:8000 -t output