Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/settermjd/laminas-static-pages
Render static pages with ease in Mezzio applications
https://github.com/settermjd/laminas-static-pages
html laminas mezzio php73 psr-15
Last synced: 4 months ago
JSON representation
Render static pages with ease in Mezzio applications
- Host: GitHub
- URL: https://github.com/settermjd/laminas-static-pages
- Owner: settermjd
- License: mit
- Created: 2019-09-18T07:04:23.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T16:09:56.000Z (over 1 year ago)
- Last Synced: 2024-09-29T19:42:53.979Z (4 months ago)
- Topics: html, laminas, mezzio, php73, psr-15
- Language: PHP
- Homepage:
- Size: 278 KB
- Stars: 5
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Laminas Static Pages Module
An, almost, painless way to render static pages in [Mezzio](https://docs.mezzio.dev/mezzio/) applications.
**Note:** This module **does not** support laminas-mvc applications.
The intent of this package is to avoid the necessity to create handlers and handler factories just to render static content.
It was motivated by various projects that I've worked on, where that seemed to be the case, at least at the time.
That approach never made sense to me, so that's that motivated me to scratch my own itch.
## Getting Started
To install the package, run `composer require settermjd/laminas-static-pages`.
If you want to automate the enabling of the module when running `composer require/install/update`, then your project needs to use [laminas/laminas-component-installer].
If it does, when the package is installed you'll be asked if you want to enable its ConfigProvider.
Answer with `Y` and the package will be ready to use.
If you don't use `laminas-component-installer`, or for some reason or other can't, then ensure that `\StaticPages\ConfigProvider::class,` is in the `ConfigAggregator` list in `config/config.php`, as in the example below.
```php
$aggregator = new ConfigAggregator([
\StaticPages\ConfigProvider::class,
]);
```
With the package installed, you now need to do two further steps:
1. Configure the template path
2. Create routes
3. Create template files
### Configure The Template Path
To configure the template path, ensure that in your template paths list, there's one with the key `static-pages`, as in the example below.
```php
public function getTemplates() : array
{
return [
'paths' => [
'static-pages' => [__DIR__ . '/../templates/static-pages'],
],
];
}
```
### Create Routes
To create a route for a static page, in your routing table, add one or more named routes where:
1. The route’s handler is `StaticPagesHandler::class`
2. The name follows the convention: `static.`.
Let's assume that we are adding a route for a privacy page and that the template file which will be rendered is `privacy.phtml`.
In that case we'd add the following to `config/routes.php`:
```php
$app->get('/privacy', StaticPagesHandler::class, 'static.privacy');
```
### Create Template Files
The file can contain whatever you like, it doesn't matter.
### That’s It
All being well, this should be all that you need to rapidly serve static content files in your [Mezzio](https://docs.mezzio.dev/mezzio/) applications.
[laminas/laminas-component-installer]: https://github.com/laminas/laminas-component-installer
## Support
- [Issues](https://github.com/settermjd/laminas-static-pages/issues)