Skip to content

Commit b7852d3

Browse files
committed
Adds missing installation page and updates introduction
Signed-off-by: Frank Brückner <[email protected]>
1 parent 83b3a09 commit b7852d3

File tree

3 files changed

+33
-14
lines changed

3 files changed

+33
-14
lines changed

docs/book/v1/installation.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
show_file_content: true
3+
---
4+
5+
<!-- markdownlint-disable MD001 MD041 -->
6+
## Cache Implementation Required
7+
<!-- markdownlint-enable -->
8+
9+
To use this component, a PSR-6 `CacheItemPoolInterface` implementation is required.
10+
[laminas-cache](https://docs.laminas.dev/laminas-cache/) provides the PSR-6 implementations, install it and choose one of the cache adapters.
11+
12+
### Install laminas-cache and a Cache Adapter
13+
14+
Install laminas-cache via [Composer](https://getcomposer.org/):
15+
16+
```bash
17+
$ composer require laminas/laminas-cache
18+
```
19+
20+
laminas-cache is shipped without a specific cache adapter to allow free choice of storage backends and their dependencies.
21+
For example, install the [laminas-cache `Filesystem` adapter](https://docs.laminas.dev/laminas-cache/v3/storage/adapter/#filesystem-adapter):
22+
23+
```bash
24+
$ composer require laminas/laminas-cache-storage-adapter-filesystem
25+
```
26+
27+
### Read More in the laminas-cache Documentation
28+
29+
- [PSR-6](https://docs.laminas.dev/laminas-cache/v3/psr6/)
30+
- [Cache Adapters](https://docs.laminas.dev/laminas-cache/v3/storage/adapter/)

docs/book/v1/intro.md

-14
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,6 @@ pool in which to store and retrieve sessions. PSR-6 was chosen over the simpler
88
[PSR-16](https://www.php-fig.org/psr/psr-16/) as it specifically provides
99
functionality around _expiry_, which allows us to expire sessions.
1010

11-
## Installation
12-
13-
Install mezzio-session-cache via [Composer](https://getcomposer.org/):
14-
15-
```bash
16-
$ composer require mezzio/mezzio-session-cache
17-
```
18-
19-
You will also need to install a package that provides a PSR-6
20-
`CacheItemPoolInterface` implementation. You can [search for PSR-6 providers on
21-
Packagist](https://packagist.org/providers/psr/cache-implementation). We have
22-
had excellent luck with the various implementations provided by the [PHP-Cache
23-
project](http://www.php-cache.com/en/latest/).
24-
2511
## Usage
2612

2713
Generally, you will only provide configuration for this service, including

mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ site_dir: docs/html
33
nav:
44
- Home: index.md
55
- Introduction: v1/intro.md
6+
- Installation: v1/installation.md
67
- Configuration: v1/config.md
78
- "Manual Usage": v1/manual.md
89
site_name: mezzio-session-cache
910
site_description: 'PSR-6 session persistence adapter for mezzio-session.'
1011
repo_url: 'https://github.com/mezzio/mezzio-session-cache'
1112
extra:
1213
project: Mezzio
14+
installation:
15+
config_provider_class: 'Mezzio\Session\Cache\ConfigProvider'

0 commit comments

Comments
 (0)