Deprecate PatternOptions storage option
#98
Conversation
| $this->options = $options; | ||
| return $this; | ||
| } | ||
|
|
||
| /** |
There was a problem hiding this comment.
These are part of the PatternInterface
| /** | ||
| * Set pattern options | ||
| * | ||
| * @param PatternOptions $options |
There was a problem hiding this comment.
These are part of the PatternInterface
| */ | ||
| protected $storage; | ||
|
|
||
| public function __construct(?StorageInterface $storage = null, ?PatternOptions $options = null) |
There was a problem hiding this comment.
Will be changed to required arguments in v3.0
boesing
force-pushed
the
qa/pattern-options-storage-option
branch
2 times, most recently
from
77969fa
to
680478b
Compare
|
@froschdesign I am not 100% sure but there are markdown issues with the tables. In the documentation HTML, it looks correct but using pipes within backticks while in a table column leads to display problems in non-HTML markdown editors. So this is actually problematic: Option | Data Type | Default Value | Description
------ | --------- | ------------- | -----------
`storage` | `string | array | Laminas\Cache\Storage\StorageInterface` | none | Adapter used for reading and writing cached data.https://gist.github.com/boesing/c37618ee975af0accbec2a6ce07cb458 It seems that this should be used instead (but leads to markdownlint issues due to the Option | Data Type | Default Value | Description
------ | --------- | ------------- | -----------
`storage` | <code>string | array | Laminas\Cache\Storage\StorageInterface</code> | none | Adapter used for reading and writing cached data.https://gist.github.com/boesing/44e1ad9d9dd424d01b6e6393d50a4387 |
|
We had the same problem in laminas-navigation: https://github.com/laminas/laminas-navigation/blob/2.12.x/docs/book/pages.md#common-page-options Add a backslash:
|
boesing
force-pushed
the
qa/pattern-options-storage-option
branch
from
44a64ae
to
742cf7c
Compare
docs/book/pattern/callback-cache.md
Outdated
| 'cache_output' => true, | ||
| ]); | ||
| /** @var StorageInterface $storage */ | ||
| $storage = null; // Can be any instance of StorageInterface |
There was a problem hiding this comment.
The pattern section contains an introduction page, it would be good if a standard storage adapter for the documentation of the cache patterns is defined there. This can be done in blockquote and can then be linked.
For laminas-i18n I used the filesystem adapter: https://docs.laminas.dev/laminas-i18n/translator/caching/
There was a problem hiding this comment.
Hm, I've tried something but not sure if thats what you had in mind. Feel free to review.
boesing
force-pushed
the
qa/pattern-options-storage-option
branch
2 times, most recently
from
8cebdfa
to
fd840ba
Compare
boesing
force-pushed
the
qa/pattern-options-storage-option
branch
from
fd840ba
to
266144b
Compare
|
@froschdesign If you have some time, I'd love to get feedback on my attempt to provide a |
|
@boesing |
boesing
force-pushed
the
qa/pattern-options-storage-option
branch
from
6ea067b
to
1a9caf6
Compare
Since v2.10, the storage adapter have their own package. In v3.0 these, adapters have to register themselves to the `AdapterPluginManager` when the plugin manager is being instantiated and thus, this component wont be aware of which adapters are available without using a `PSR-11` container. This commit aims to provide a proper dependency injection layer to all cache patterns while deprecating the old `storage` option for `PatternOptions`. Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
…ck start section Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
…ipts Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
- replaced dead links from example with github release notes - imported laminas-feed `Reader` class Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
|
@froschdesign I'll merge this for now. We can optimize documentation in dedicated branches. I'd rather go moving forward with the release of v2 so we can finally kick out v3. |
Description
Since v2.10, the storage adapter have their own package. In v3.0 these, adapters have to register themselves to the
AdapterPluginManagerwhen the plugin manager is being instantiated and thus, this component wont be aware of which adapters are available without using aPSR-11container.This commit aims to provide a proper dependency injection layer to all cache patterns while deprecating the old
storageoption forPatternOptions.Closes #97