Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Fix adapter name configuration key #179

Closed
wants to merge 1 commit into from
Closed

Documentation: Fix adapter name configuration key #179

wants to merge 1 commit into from

Conversation

internalsystemerror
Copy link
Member

@internalsystemerror internalsystemerror commented Nov 16, 2021

Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no

Description

In the quick start https://docs.laminas.dev/laminas-cache/v3/storage/adapter/#quick-start section of the docs, it suggests the normalized configuration array requires the adapter name passed as the value to the adapter key. Looking at the source

$adapterName = $configuration['name'];
suggests this should be name instead, which is what works currently when testing this.

This PR updates the documentation to reflect the correct key name.

Signed-off-by: Gary Lockett <gary@creativecow.uk>
@froschdesign froschdesign added Bug Something isn't working Documentation labels Nov 16, 2021
@froschdesign
Copy link
Member

@internalsystemerror

…it suggests the normalized configuration array…

This is not a suggestion, just the old documentation for version 2.

Please use 3.0.x branch for this pull request.

@internalsystemerror internalsystemerror changed the base branch from 3.1.x to 3.0.x November 16, 2021 21:25
@internalsystemerror
Copy link
Member Author

@froschdesign done

@boesing
Copy link
Member

boesing commented Nov 17, 2021

I stumbled over this yesterday as well. That change really wasn't that smart, I think I will allow adapter as well since this was the suggestion by the v2.12.0 release...
I probably failed there... Maybe I have to deprecate name afterwards

@boesing
Copy link
Member

boesing commented Nov 17, 2021

Just FYI: I am closing this, releasing v3.0.1 which adds documentation reference to the migration guide.
Afterwards, I will create a new PR for 3.1.0 which adds adapter to the configuration as an optional configuration array key (as thats what v2 supported) and deprecate name for the configuration.

This will ensure proper support for v2 migrations as well as usages of https://github.com/laminas/laminas-cache-storage-deprecated-factory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants