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

Documenting module creation part 1 - identifiable object form and grid hooks usage #281

Merged
merged 20 commits into from Jun 25, 2019

Conversation

@tomas862
Copy link
Member

commented Jun 5, 2019

This docmentation follows the process of creating sample module which can be found here:

https://github.com/friends-of-prestashop/demo-cqrs-hooks-usage-module

It explains in detail about how to use hooks but does not explain very detailed why the CQRS pattern was used within module. Not sure if its needed to be done on this page or rather create another page o maybe even we don't need that since its quite optional.

@tomas862

This comment has been minimized.

Copy link
Member Author

commented Jun 5, 2019

@matks early review for this one would be great - already completed the part which demonstrates how to extend list hooks.

@kpodemski

This comment has been minimized.

Copy link
Contributor

commented Jun 5, 2019

Hey @tomas862 little off-topic, have you solved issues with translations in your example module?

@tomas862

This comment has been minimized.

Copy link
Member Author

commented Jun 5, 2019

Hey @kpodemski
I think not yet but it should be shipped to 1.7.6 - @matks whats the status of it? 🤔

@matks

This comment has been minimized.

Copy link
Contributor

commented Jun 14, 2019

Hey @tomas862 little off-topic, have you solved issues with translations in your example module?

Sorry for late answer, and the issue is: yes ! 🎉
You can see Pablo's answer on this one: PrestaShop/PrestaShop#13942
And the module has been updated accordingly friends-of-presta/demo-cqrs-hooks-usage-module@e039cf8

tomas862 and others added some commits Jun 17, 2019

Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
added topic for "Adding new form field to customer form create and ed…
…it form" and added docs how to extend identifiable object form builder

@tomas862 tomas862 changed the title [WIP] Documenting module creation part 1 - identifiable object form and grid hooks usage Documenting module creation part 1 - identifiable object form and grid hooks usage Jun 21, 2019

@tomas862 tomas862 marked this pull request as ready for review Jun 21, 2019

@tomas862

This comment has been minimized.

Copy link
Member Author

commented Jun 21, 2019

@matks I think this part 1 is done. Please review when you can :)

I tried to be as specific as possible and to cover only hooks usage. I imagine we will add "Read more" section somewhere where we will able to explain every other bit like:

  1. using CQRS within the module ( this would be a great opportunity to demonstrate how to migrate from Object model to Symfony entities without the harm if you used CQRS pattern in module) . Wdyt?
  2. What to do if list does not have required javascript ( like toggle extension) - a.k.a adding javascript from the module to the grid for instance.
  3. Validation for module - includes throwing exception and validating form fields.
  4. ...
@matks

This comment has been minimized.

Copy link
Contributor

commented Jun 24, 2019

@tomas862 review done ✔️

tomas862 and others added some commits Jun 25, 2019

Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>

tomas862 and others added some commits Jun 25, 2019

Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
Update src/content/1.7/modules/sample_modules/grid-and-identifiable-o…
…bject-form-hooks-usage.md

Co-Authored-By: Mathieu Ferment <mathieu.ferment@prestashop.com>
@tomas862

This comment has been minimized.

Copy link
Member Author

commented Jun 25, 2019

@matks thank you! I love this new github feature that I was able to merge your suggestions :D anyway, I think this PR is ready :)

@matks

matks approved these changes Jun 25, 2019

@matks

This comment has been minimized.

Copy link
Contributor

commented Jun 25, 2019

Everything is LGTM

Not sure if its needed to be done on this page or rather create another page o maybe even we don't need that since its quite optional.

Indeed we dont expect module developers to use CQRS so this is optional 😉

@matks matks merged commit f661e34 into PrestaShop:master Jun 25, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.