Skip to content

Add new plugin hooks documentation #170

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

Draft
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

cconard96
Copy link
Contributor

WIP adding documentation from glpi-project/glpi#19450 to enhance the plugin hook documenation. This is all to add the documentation for the missing hooks, improve the overall quality of the documentation, document the new Hooks and HookManager classes, and make it less likely that the hook documentation becomes out of date again.

cedric-anne and others added 25 commits May 2, 2023 08:09
* start documenting HL API

* remove x-default-contexts
* Array syntax is now enforced
* A word about criteria unicity
* Warning about raw queries
* Add more upgrade instructions for GLPI 11.0

* Apply suggestions from code review

Co-authored-by: Curtis Conard <[email protected]>

---------

Co-authored-by: Curtis Conard <[email protected]>
Added 'to be' where needed
…ript_module_anonymous_page, add_css_anonymous_page, add_header_tag_anonymous_page (glpi-project#160)

* add doc

* fix comment
* -B option doesn't exist anymore

* langage specified to avoid warning.

* fix path to glpi logo

---------

Co-authored-by: Sebastien Monterisi <[email protected]>
* Update sourcecode testing section

* Update linting section

* nfo about launching tests "as in ci" + note about phpunit

* Update source/sourcecode.rst

Co-authored-by: Johan Cwiklinski <[email protected]>

---------

Co-authored-by: Sebastien Monterisi <[email protected]>
Co-authored-by: Johan Cwiklinski <[email protected]>
* Fix tests documentation

* Update source/sourcecode.rst

---------

Co-authored-by: Cédric Anne <[email protected]>
* tutorial for developping a plugin

* update doc

* Fix syntax

* clean php snippets

* clean use

* clean use

* Few fixes

* Fix doc links

* Translate titles

* Rework main title

* Translation

* Dead ref

* Translate

* Remove metabase part

* Translate

* Fix internal links

* Apply suggestions from code review

Co-authored-by: Curtis Conard <[email protected]>

* Work on translations

* Maybe should not we use logDebug.

* Translation, minor fix

* Fix syntax

* Translate

* Translate

* Translate

* No direct querying

* End translation

* Typo

* Typos, misssed translations

* Apply suggestions from code review

Thanks Curtis!

Co-authored-by: Curtis Conard <[email protected]>

* Update source/plugins/tutorial.rst

Co-authored-by: Curtis Conard <[email protected]>

* A word about npm. Precision: composer and npm are not mandatory

* Apply suggestions from code review

Co-authored-by: Curtis Conard <[email protected]>

* Add download_url and a note on plugin submission URL

* Apply suggestions from code review

Co-authored-by: Alexandre Delaunay <[email protected]>

* Replace old links

---------

Co-authored-by: Johan Cwiklinski <[email protected]>
Co-authored-by: Curtis Conard <[email protected]>
@cconard96 cconard96 self-assigned this May 17, 2025
@cconard96 cconard96 added the WIP label May 17, 2025
Copy link
Member

@cedric-anne cedric-anne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hook names should probably be clarified. Developers may try to use the documented name as a string.
Maybe the FQCN should be added, like this: \Glpi\Plugins\Hooks::ADD_CSS_ANONYMOUS_PAGE.

Comment on lines +11 to +12
#####
ADD_CSS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a missing empty line here.

Comment on lines +16 to +18



Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are too many empty lines here.

@trasher
Copy link
Collaborator

trasher commented Jun 2, 2025

Diff is too huge, branch must be rebased

@cedric-anne cedric-anne mentioned this pull request Jun 2, 2025
@trasher trasher deleted the branch glpi-project:master June 2, 2025 13:14
@trasher trasher closed this Jun 2, 2025
@trasher trasher reopened this Jun 2, 2025
@trasher trasher changed the base branch from develop to master June 2, 2025 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.