-
Notifications
You must be signed in to change notification settings - Fork 63
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
Add docu for new update event #340
base: main
Are you sure you want to change the base?
Conversation
PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here. PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here. PR Code Suggestions ✨Explore these optional code suggestions:
|
Could you also add a line into the List of Plugin Events index page? It's in building-extensions/plugins/plugin-events/index.md Thanks |
Co-authored-by: Robbie Jackson <[email protected]>
Like this d57b584? |
Yes, that's right for the index page. On the Installer Events page you need to close the first section of php code as the second event is included within the code block - see http://pr-340.manual.joomlacode.org/docs/next/building-extensions/plugins/plugin-events/installer/#onInstallerBeforeUpdateSiteDownload Also in the text "before a package of an extension is downloaded" - I wasn't sure if this referred specifically to a Joomla package (ie group of extensions packaged together into a Joomla package) or just to a zipped-up file of a Joomla extension (not necessarily a Joomla package). Some text to make that clear would be very helpful. |
@robbiejackson please check 90cf229 |
I wondered why the links from the List of Plugin Events index page weren't working properly, then found from https://docusaurus.io/docs/next/markdown-features/toc#heading-ids that docusaurus generates the anchors in lower case if you don't specify explicitly the heading id. With those fixed, I think this PR is good to go once the code is merged into Joomla 5.3. The relevant bits need to be duplicated to the 4.4 and 5.2 versioned docs, which you can either do yourself, or I'm happy to do on your behalf - just let me know. |
Co-authored-by: Robbie Jackson <[email protected]>
Co-authored-by: Robbie Jackson <[email protected]>
Thank you for your help on this. And sure go for your suggested changes in 4.4 and 5.2. |
Installer Events | ||
============== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Installer Events | |
============== | |
Installer Events | |
================ | |
|
||
### Event Arguments | ||
|
||
The event class \Joomla\CMS\Event\Installer\BeforePackageDownloadEvent has the following arguments: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The event class \Joomla\CMS\Event\Installer\BeforePackageDownloadEvent has the following arguments: | |
The event class `\Joomla\CMS\Event\Installer\BeforePackageDownloadEvent` has the following arguments: | |
|
||
### Event Arguments | ||
|
||
The event class \Joomla\CMS\Event\Installer\BeforeUpdateSiteDownloadEvent has the following arguments: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The event class \Joomla\CMS\Event\Installer\BeforeUpdateSiteDownloadEvent has the following arguments: | |
The event class `\Joomla\CMS\Event\Installer\BeforeUpdateSiteDownloadEvent` has the following arguments: | |
#### New before download update site event | ||
A new event is available where an installer plugin can hook in before an update site url is fetched. Similar to what we have for package download of an extension. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#### New before download update site event | |
A new event is available where an installer plugin can hook in before an update site url is fetched. Similar to what we have for package download of an extension. | |
#### New before download update site event | |
A new event is available where an installer plugin can hook in before an update site url is fetched. Similar to what we have for package download of an extension. |
Installer Events | ||
============== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Installer Events | |
============== | |
Installer Events | |
================ | |
|
||
### Event Arguments | ||
|
||
The event class \Joomla\CMS\Event\Installer\BeforePackageDownloadEvent has the following arguments: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The event class \Joomla\CMS\Event\Installer\BeforePackageDownloadEvent has the following arguments: | |
The event class `\Joomla\CMS\Event\Installer\BeforePackageDownloadEvent` has the following arguments: | |
Installer Events | ||
============== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Installer Events | |
============== | |
Installer Events | |
================ | |
|
||
### Event Arguments | ||
|
||
The event class \Joomla\CMS\Event\Installer\BeforePackageDownloadEvent has the following arguments: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The event class \Joomla\CMS\Event\Installer\BeforePackageDownloadEvent has the following arguments: | |
The event class `\Joomla\CMS\Event\Installer\BeforePackageDownloadEvent` has the following arguments: | |
User description
Docs for joomla/joomla-cms#44516
PR Type
documentation
Description
onInstallerBeforePackageDownload
andonInstallerBeforeUpdateSiteDownload
.Changes walkthrough 📝
installer.md
Document new installer plugin events and examples
docs/building-extensions/plugins/plugin-events/installer.md
onInstallerBeforePackageDownload
event.onInstallerBeforeUpdateSiteDownload
event.new-features.md
Add documentation for new before download update site event
migrations/52-53/new-features.md