Feat/pro 2329 product category include exclude vendor coupon

[mrabbani]

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 developer documentation (optional)
• I've added proper labels to this pull request

Related PR

• https://github.com/weDevsOfficial/dokan-pro/pull/2343

Changes proposed in this Pull Request:

• Closes https://github.com/weDevsOfficial/dokan-pro/issues/2329

How to test the changes in this Pull Request:

Changelog entry

Enter a summary of all changes on this Pull Request. This will appear in the changelog if accepted.

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

• Bug Fixes
  • Updated the condition for coupon validation to clarify that a coupon must be bound to a product only when the pro version is deactivated.
  • Enhanced security during order status changes with nonce verification for refund processing.

[coderabbitai]

Walkthrough

The recent changes enhance the handling of order statuses and coupon validation within the Hooks class. The ensure_vendor_coupon method now includes a conditional check for coupon binding based on the pro version's status. Additionally, nonce verification has been added to the manage_refunded_for_order method to bolster security during status updates. The on_order_status_change method continues to manage order status synchronization while ensuring proper formatting for database updates.

Changes

Files	Change Summary
includes/Order/Hooks.php	Updated ensure_vendor_coupon method to specify coupon binding condition based on pro version status. Added nonce verification to manage_refunded_for_order.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Add product category selection support to vendor coupon on the frontend (#2329)	❌	The changes do not address the requirement for product category selection support for vendor coupons.

Possibly related PRs

• fix: Improve vendor coupon validation for various discount item types and empty cart scenarios #2351: This PR modifies the ensure_vendor_coupon method in the same file as the main PR, enhancing coupon validation logic, which is directly related to the changes made in the main PR.
• fix: Prevent incorrect sub-order status updates #2354: This PR enhances the on_order_status_change method, which is also modified in the main PR, focusing on order status management and ensuring correct status updates for sub-orders.

Suggested labels

:+1: Dev Review Done, Upcoming Release

Suggested reviewers

• mrabbani

Poem

In the vendor's digital space so bright,
Coupons gain new wings, now in flight,
With checks in place, security's tight,
Order statuses dance, a seamless sight,
Enhancements made, all feels just right!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2c19d8f and 1d44fd8.

📒 Files selected for processing (1)

• includes/Order/Hooks.php (1 hunks)

🔇 Additional comments (1)

includes/Order/Hooks.php (1)

455-457: LGTM! Verify pro version detection.

The conditional check for binding coupons to products in non-pro version is well implemented. The error message is properly escaped.

Let's verify the pro version detection:

✅ Verification successful

Based on the search results, I can verify that dokan()->is_pro_exists() is consistently used throughout the codebase as the standard method for pro version detection. The implementation is found in dokan-class.php:

public function is_pro_exists() {
    return apply_filters( 'dokan_is_pro_exists', false );
}

The method is properly hooked with a filter that allows the pro version to override the default false value. This is a standard WordPress pattern for extensibility.

Pro version detection is implemented correctly.

The conditional check in the review code follows the established pattern used across the codebase for pro version detection. The implementation is consistent with other pro/lite version checks in files like:

• includes/Order/Manager.php
• includes/REST/StoreController.php
• includes/Admin/Menu.php
• includes/Dashboard/Templates/Products.php

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify pro version detection implementation
# Check if there are any other places in the codebase using similar pro version detection

# Search for pro version detection patterns
rg -A 2 "dokan\(\)->is_pro_exists\(\)"

# Search for alternative pro version detection methods
rg -A 2 "(is_pro|pro_exists|has_pro)"

Length of output: 81178

---

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 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.

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d2a44e3 and 54fb2e5.

Files selected for processing (1)

• includes/Order/Hooks.php (1 hunks)

Additional context used

GitHub Check: Run PHPCS inspection

includes/Order/Hooks.php

[failure] 352-352:
Whitespace found at end of line

---

[failure] 355-355:
All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '__'.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54fb2e5 and 2c19d8f.

Files selected for processing (1)

• includes/Order/Hooks.php (1 hunks)

Files skipped from review due to trivial changes (1)

• includes/Order/Hooks.php

[mralaminahamed]

It has no impact in the relates issue.