8000 Document the integration of the Lock component in the FrameworkBundle · Issue #9779 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Document the integration of the Lock component in the FrameworkBundle #9779

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

Closed
lyrixx opened this issue May 15, 2018 · 2 comments
Closed

Document the integration of the Lock component in the FrameworkBundle #9779

lyrixx opened this issue May 15, 2018 · 2 comments

Comments

@lyrixx
Copy link
Member
lyrixx commented May 15, 2018

I see there is an integration between the Lock component and the FrameworkBundle,
But I can find this documentation. I found this doc but it's only about the component alone.

It could be nice to get this doc ;)

Thanks

@javiereguiluz
Copy link
Member

In 4.2 there's a new option related to this for flock. See symfony/symfony#26923

@jderusse
Copy link
Member
jderusse commented Sep 8, 2018

When I write the original Lock documentation draft, I only write the Component part, because to be honest, I didn't find out where is the "FrameworkBundle" documentation.
We only documents options of framework's configuration (https://symfony.com/doc/3.4/reference/configuration/framework.html#lock) , and given lock's configuration contains only 1 option, this is not usefull at all.

At the time, we gave sample of configuration in the Full Default Configuration but this section as been removed

            # lock configuration
            lock:
                invoice: 'redis://localhost'
                report: semaphore
            # lock: ~
            # lock: 'flock'
            # lock: ['semaphore', 'redis://localhost']

I didn't want to invent a new thing, but at the time, I would have like to write something with:

  • a sample of configuration (the simplest way to configure the component)
  • a (or several) sample of advanced configurations
  • how to inject it in my services (list of public aliases, and serviceId and how to use theme)

Any idea where should we put theme?

To be honest, I have the same issue with cache component. I never use framework bundle to create cacheItemPool (I configure theme in the DIC), because I never figured out how to customize theme (defining a namespace, or don't use serialization in ArrayCache) or create advanced Pools (like ChainPool) ;-)

javiereguiluz added a commit that referenced this issue Sep 26, 2019
…rence (HypeMC)

This PR was submitted for the 4.2 branch but it was squashed and merged into the 4.3 branch instead (closes #11466).

Discussion
----------

Add flock:// option to framework lock configuration reference

Fixes #9779 & extends #11465 .

Documents the `flock://` option which was added with symfony/symfony#26923 .

**NOTE 1**: The xml configuration doesn't currently work, see symfony/symfony#31197
**NOTE 2**: This PR has all the changes that #11465 has plus some symfony 4.2 specific additions, so #11465 should probably be merged first.

Commits
-------

d9125fd Add flock:// option to framework lock configuration reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants
0