enhance: Seperate dokan rest controller for role-wise API implementation.

[MdAsifHossainNadim]

All Submissions:

• My code follow the WordPress' coding standards
• My code satisfies feature requirements
• My code is tested
• My code passes the PHPCS tests
• My code has proper inline documentation
• I've included related pull request(s) (optional)
• I've included developer documentation (optional)
• I've added proper labels to this pull request

Changes proposed in this Pull Request:

Related Pull Request(s)

• Full PR Link

Closes

• Closes #

How to test the changes in this Pull Request:

• Steps or issue link

Changelog entry

Title

Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

• Code is not following code style guidelines
• Bad naming: make sure you would understand your code if you read it a few months from now.
• KISS: Keep it simple, Sweetie (not stupid!).
• DRY: Don't Repeat Yourself.
• Code that is not readable: too many nested 'if's are a bad sign.
• Performance issues
• Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
• Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

• Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
• Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
• Readable — Will your future self be able to understand this change months down the road?
• Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

• New Features

  • Comprehensive documentation for Dokan REST Controllers, including role-based controllers for Admin, Vendor, and Customer.
  • Introduction of new abstract classes for base REST controllers and role-specific controllers.

• Bug Fixes

  • Improved permission checks for Admin, Vendor, and Customer controllers.

• Documentation

  • Enhanced API documentation with code snippets and detailed descriptions of controller functionalities.

[mrabbani]

I was reviewed #2484

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive restructuring of Dokan's REST API controllers by creating a new base controller (DokanRESTBaseController) and role-specific abstract controllers for admin, vendor, and customer endpoints. The changes centralize common functionality like response formatting and pagination handling, while providing role-specific permission checks. The documentation in docs/api/api.md offers detailed guidance on implementing and extending these controllers, demonstrating a more modular and flexible approach to REST API management in the Dokan plugin.

Changes

File	Change Summary
docs/api/api.md	Added comprehensive documentation for Dokan REST Controllers, including base and role-specific controller classes with examples
includes/Abstracts/DokanRESTBaseController.php	New abstract base controller with format_collection_response method for standardizing API responses and pagination
includes/Abstracts/DokanRESTAdminController.php	Updated to extend new base controller, modified check_permission method, and removed format_collection_response
includes/Abstracts/DokanRESTVendorController.php	New abstract vendor controller with check_permission method for vendor-specific API access
includes/Abstracts/DokanRESTCustomerController.php	New abstract customer controller with check_permission method for customer-specific API access

Possibly related PRs

• Feat: Add CustomersController: Vendor-specific CRUD, Batch, and Search API for Customer Management #2406: The CustomersController introduces a new REST API controller for managing customer data, which is relevant to the role-specific controllers in this PR.
• enhance: Hide revenue coupon info from woocommerce analytics report. #2418: This PR enhances the customer search functionality for vendors, which relates to the role-specific controllers discussed in the main PR, particularly in terms of managing permissions and API endpoints.

Suggested labels

Needs: Testing, Needs: Dev Review

Poem

🐰 Hop, hop, REST controllers dance,
Permissions checked with rabbit's glance,
Base class blooms like spring's delight,
Endpoints now shine ever so bright,
Code flows smooth, no more a trance! 🌈

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02d4fe1 and 17de3aa.

📒 Files selected for processing (5)

• docs/api/api.md (1 hunks)
• includes/Abstracts/DokanRESTAdminController.php (2 hunks)
• includes/Abstracts/DokanRESTBaseController.php (1 hunks)
• includes/Abstracts/DokanRESTCustomerController.php (1 hunks)
• includes/Abstracts/DokanRESTVendorController.php (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.