MokoConsulting/MokoWaaS
1
1
Fork 0
Code Issues Pull Requests Actions 33 Packages Releases 1 Wiki Activity

plg_webservices_mokowaas: Update event handler for Joomla 6 API #48

New Issue
Closed
opened 2026-05-26 18:28:06 +00:00 by jmiller · 5 comments
jmiller commented 2026-05-26 18:28:06 +00:00
Owner
Copy Link
Copy Source

Summary

The plg_webservices_mokowaas plugin uses the Joomla 4/5 event handler signature, which is incompatible with Joomla 6's typed event system. This breaks the entire Joomla REST API on any site running this plugin on Joomla 6.

Error

Call to undefined method BeforeApiRouteEvent::createCRUDRoutes()

Root Cause

In plugins/webservices/mokowaas/src/Extension/MokoWaaSApi.php, the handler uses the old-style pass-by-reference signature:

public function onBeforeApiRoute(&$router): void

With SubscriberInterface, the first argument is the event object, not the router. So $router is actually a BeforeApiRouteEvent instance, and calling createCRUDRoutes() on it fails.

Fix

Update to use the Joomla 6 typed event API:

use Joomla\\CMS\\Event\\Application\\BeforeApiRouteEvent;

public function onBeforeApiRoute(BeforeApiRouteEvent $event): void
{
    $router = $event->getRouter();
    $router->createCRUDRoutes(...);
}

Current Status

  • Live server: Hotfixed directly on mokoconsulting.tech (2026-05-26)
  • Dev server: API template fixed, but plugin still has old signature
  • Source repo: Not yet updated — this issue tracks the proper fix

Additional Context

A second issue was also discovered and hotfixed: the api/templates/system/ directory was missing on both live and dev servers. Joomla 6.1's CMSApplication::isValidTemplate() requires api/templates/system/index.php to exist. This should be verified in the deployment/packaging process.

Acceptance Criteria

  • Update MokoWaaSApi.php to use BeforeApiRouteEvent typed parameter
  • Add BeforeApiRouteEvent import
  • Verify api/templates/system/index.php is included in package or deployment
  • Test REST API on dev site after deploying fix
  • Tag a patch release
## Summary The `plg_webservices_mokowaas` plugin uses the Joomla 4/5 event handler signature, which is incompatible with Joomla 6's typed event system. This breaks the entire Joomla REST API on any site running this plugin on Joomla 6. ## Error ``` Call to undefined method BeforeApiRouteEvent::createCRUDRoutes() ``` ## Root Cause In `plugins/webservices/mokowaas/src/Extension/MokoWaaSApi.php`, the handler uses the old-style pass-by-reference signature: ```php public function onBeforeApiRoute(&$router): void ``` With `SubscriberInterface`, the first argument is the **event object**, not the router. So `$router` is actually a `BeforeApiRouteEvent` instance, and calling `createCRUDRoutes()` on it fails. ## Fix Update to use the Joomla 6 typed event API: ```php use Joomla\\CMS\\Event\\Application\\BeforeApiRouteEvent; public function onBeforeApiRoute(BeforeApiRouteEvent $event): void { $router = $event->getRouter(); $router->createCRUDRoutes(...); } ``` ## Current Status - **Live server**: Hotfixed directly on `mokoconsulting.tech` (2026-05-26) - **Dev server**: API template fixed, but plugin still has old signature - **Source repo**: Not yet updated — this issue tracks the proper fix ## Additional Context A second issue was also discovered and hotfixed: the `api/templates/system/` directory was missing on both live and dev servers. Joomla 6.1's `CMSApplication::isValidTemplate()` requires `api/templates/system/index.php` to exist. This should be verified in the deployment/packaging process. ## Acceptance Criteria - [ ] Update `MokoWaaSApi.php` to use `BeforeApiRouteEvent` typed parameter - [ ] Add `BeforeApiRouteEvent` import - [ ] Verify `api/templates/system/index.php` is included in package or deployment - [ ] Test REST API on dev site after deploying fix - [ ] Tag a patch release
jmiller added the joomlaphppriority: hightype: bug labels 2026-05-26 18:28:06 +00:00
jmiller commented 2026-05-26 18:28:07 +00:00
Author
Owner
Copy Link
Copy Source

Branch created: feature/48-plg-webservices-mokowaas-update-event-ha

git fetch origin
git checkout feature/48-plg-webservices-mokowaas-update-event-ha
Branch created: [`feature/48-plg-webservices-mokowaas-update-event-ha`](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/src/branch/feature/48-plg-webservices-mokowaas-update-event-ha) ```bash git fetch origin git checkout feature/48-plg-webservices-mokowaas-update-event-ha ```
jmiller commented 2026-05-26 18:33:54 +00:00
Author
Owner
Copy Link
Copy Source

Tracked in moko-platform as MokoConsulting/moko-platform#164

Tracked in moko-platform as MokoConsulting/moko-platform#164
jmiller commented 2026-05-26 18:34:56 +00:00
Author
Owner
Copy Link
Copy Source

Related issues:

**Related issues:** - MokoConsulting/MokoWaaS#48 (source — hotfixed on live) - MokoConsulting/moko-platform#164 (tracking) - MokoConsulting/Template-Generic#32 - MokoConsulting/Template-Joomla#13
jmiller commented 2026-05-26 18:42:47 +00:00
Author
Owner
Copy Link
Copy Source

Fix Applied

Commit: 3f20ad9 on dev

Changes

src/packages/plg_webservices_mokowaas/src/Extension/MokoWaaSApi.php:

  1. Added import: use Joomla\CMS\Event\Application\BeforeApiRouteEvent;
  2. Updated method signature:
    • Before: public function onBeforeApiRoute(&\): void
    • After: public function onBeforeApiRoute(BeforeApiRouteEvent \): void
  3. Added router extraction: \ = \->getRouter();

Remaining

  • Verify api/templates/system/index.php in package/deployment
  • Test REST API on dev site
  • Tag patch release
## Fix Applied **Commit:** [`3f20ad9`](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/commit/3f20ad9) on `dev` ### Changes `src/packages/plg_webservices_mokowaas/src/Extension/MokoWaaSApi.php`: 1. Added import: `use Joomla\CMS\Event\Application\BeforeApiRouteEvent;` 2. Updated method signature: - **Before:** `public function onBeforeApiRoute(&\): void` - **After:** `public function onBeforeApiRoute(BeforeApiRouteEvent \): void` 3. Added router extraction: `\ = \->getRouter();` ### Remaining - [ ] Verify `api/templates/system/index.php` in package/deployment - [ ] Test REST API on dev site - [ ] Tag patch release
jmiller commented 2026-05-26 19:37:14 +00:00
Author
Owner
Copy Link
Copy Source

Proof

Fixed in commit 3f20ad9 (dev), merged to main via a68e90d.

Changes:

  • Added BeforeApiRouteEvent import
  • Updated onBeforeApiRoute() signature to typed event
  • Router extracted via $event->getRouter()

Workflows also updated (paths filter removed) on both dev and main.

## Proof Fixed in commit 3f20ad9 (dev), merged to main via a68e90d. Changes: - Added BeforeApiRouteEvent import - Updated onBeforeApiRoute() signature to typed event - Router extracted via $event->getRouter() Workflows also updated (paths filter removed) on both dev and main.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
automation
Automated processes or scripts
 breaking-change
Breaking API or functionality change
 build
Build system changes
 ci-cd
CI/CD pipeline changes
 config
Configuration file changes
 css
CSS/styling changes
 dependencies
Dependency updates
 deploy-failure
Automated deploy failure tracking
 docker
Docker configuration changes
 documentation
Documentation changes
 dolibarr
Dolibarr module or extension
 generic
Generic project or library
 good first issue
Good for newcomers
 health-check
Repository health check results
 health: excellent
Health score 90-100
 health: fair
Health score 50-69
 health: good
Health score 70-89
 health: poor
Health score below 50
 help wanted
Extra attention needed
 html
HTML template changes
 javascript
JavaScript code changes
 joomla
Joomla extension or component
 major-release
Major version release (breaking changes)
 minor-release
Minor version release (XX.YY.00)
 mokostandards
MokoStandards compliance
 needs-review
Awaiting code review
 needs-testing
Requires manual or automated testing
 patch-release
Patch version release (XX.YY.ZZ)
 php
PHP code changes
 priority: critical
Critical priority, must be addressed immediately
 priority: high
High priority
 priority: low
Low priority
 priority: medium
Medium priority
 push-failure
File push failure requiring attention
 python
Python code changes
 regression
Regression from a previous working state
 release-candidate
Release candidate build
 security
Security-related changes
 size/l
Large change (101-300 lines)
 size/m
Medium change (31-100 lines)
 size/s
Small change (11-30 lines)
 size/xl
Extra large change (301-1000 lines)
 size/xs
Extra small change (1-10 lines)
 size/xxl
Extremely large change (1000+ lines)
 standards-drift
Repository drifted from MokoStandards
 standards-update
MokoStandards sync update
 standards-violation
Standards compliance failure
 status: blocked
Blocked by another issue or dependency
 status: in-progress
Currently being worked on
 status: needs-review
Awaiting code review
 status: on-hold
Temporarily on hold
 status: pending
Pending action or decision
 status: wontfix
This will not be worked on
 sync-failure
Bulk sync failure requiring attention
 sync-report
Bulk sync run report
 template-validation-failure
Template workflow validation failure
 test-failure
Automated test failure
 tests
Test suite changes
 type: bug
Something isn't working
 type: chore
Maintenance tasks
 type: enhancement
Enhancement to existing feature
 type: feature
New feature or request
 type: refactor
Code refactoring
 type: release
Release preparation or tracking
 type: test
Test suite additions or changes
 type: version
Version-related change
 typescript
TypeScript code changes
 version
Version bump or release
 version-branch
Version branch related
 version-drift
Version mismatch detected
 work-in-progress
Work in progress, not ready for merge
bug
Something is not working
 chore
Maintenance and housekeeping
 documentation
Documentation improvements
 enhancement
Improvement to existing functionality
 feature
New feature or request
 pending: dependency
Blocked by another issue or external dependency
 pending: deployment
Tested and approved, awaiting deployment to production
 pending: design
Needs UI/UX or architecture design before implementation
 pending: documentation
Feature works, needs documentation/wiki update
 pending: feedback
Awaiting feedback or decision from stakeholder
 pending: review
Implementation complete, awaiting code review
 pending: testing
Feature implemented but not yet tested
 priority: critical
Must fix immediately
 priority: high
Should fix soon
 priority: low
Nice to have
 priority: medium
Fix when convenient
 refactor
Code restructuring without behavior change
 roadmap
Planned feature or enhancement tracked on the roadmap
 scope: client
Client-specific work
 scope: dolibarr
Dolibarr modules and customizations
 scope: infrastructure
Server, CI, backups, monitoring
 scope: joomla
Joomla templates and extensions
 scope: waas
MokoWaaS platform
 security
Security vulnerability or hardening
 status: blocked
Waiting on external dependency
 status: duplicate
Duplicate of another issue
 status: in-progress
Being worked on
 status: needs-review
Ready for review
 status: wontfix
Will not be addressed
No labels joomla php priority: high type: bug
Milestone
No items
No Milestone
Assignees
Clear assignees
jmiller (Jonathan Miller)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: MokoConsulting/MokoWaaS#48
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?