search

getdokan / dokan

Multivendor marketplace platform
https://wordpress.org/plugins/dokan-lite/
259 stars 204 forks source link

Enhance : Admin Notice Show gloablly & extand API #2446

Open osmansufy opened 3 days ago

osmansufy commented 3 days ago

All Submissions:

Changes proposed in this Pull Request:

Related Pull Request(s)

Closes

How to test the changes in this Pull Request:

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:

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.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 3 days ago

Walkthrough

The changes in this pull request introduce new functionality for handling admin notices within the Dokan plugin. A new JavaScript file is added to manage these notices, while modifications to the AdminNoticeController class enhance the retrieval and filtering of notices based on a specified scope. Additionally, a new Vue component is created to display the notices, and the Webpack configuration is updated to include this new component in the build process. Overall, these enhancements aim to improve the admin interface without altering existing functionalities.

Changes

File Change Summary
includes/Assets.php Added new JavaScript file dokan-admin-notice-js, updated methods load_dokan_admin_notices_scripts and get_scripts to enqueue and register the new script.
includes/REST/AdminNoticeController.php Updated dokan_get_admin_notices method to accept WP_REST_Request, added scope parameter, and created filtering for notices.
src/admin/components/AdminNotice.vue Introduced new prop scope to the AdminNotice component, modifying AJAX request URL to include scope.
src/admin/notice/App.vue Added a new Vue component App.vue that uses AdminNotice with props for scope, interval, and endpoint.
src/admin/notice/main.js Imported App component, initialized Vue instance if #dokan-admin-notices exists.
webpack.config.js Added new entry point for dokan-admin-notice in the Webpack configuration.
includes/Upgrade/AdminNotice.php Updated show_notice method to include a new key 'scope' with value 'global' in the returned notice array.

Possibly related PRs

Suggested labels

QA approved, Needs: Testing

Suggested reviewers

🐰 In the land of code, where rabbits hop,
New scripts are added, and notices pop!
With scopes now filtering, and Vue on the scene,
Admins rejoice, it's a developer's dream!
So let’s celebrate with a joyful cheer,
For changes that bring us all good cheer! 🎉

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 2793084ac9b83c307e66a3cac6c7f1be1b296497 and a8123b3589b627ce5173a7cb7f747850f0df20cc.
📒 Files selected for processing (2) * `includes/Upgrade/AdminNotice.php` (1 hunks) * `src/admin/notice/main.js` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * includes/Upgrade/AdminNotice.php * src/admin/notice/main.js

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mrabbani commented 23 hours ago

@getdokan/product, We may need to update the content of the Dokan data migration notice.

jamil-mahmud commented 22 hours ago

@mrabbani vai,

Kindly direct to change the text on Dokan Data Update Required announcement according to below.

"Updating your Dokan data is required to continue functional operations."

StalinDurjo commented 21 hours ago

Issue: Clicking on upgrader button doesn't work if notice is set to global scope

$notices[] = [
            'type'              => 'info',
            'title'             => __( 'Dokan Data Update Required', 'dokan-lite' ),
            'description'       => __( 'We need to update your install to the latest version', 'dokan-lite' ),
            'priority'          => 1,
            'scope'             => 'global',
            'actions'           => [
                [
                    'type'            => 'primary',
                    'text'            => __( 'Update', 'dokan-lite' ),
                    'loading_text'    => __( 'Updating...', 'dokan-lite' ),
                    'competed_text'   => __( 'Updated', 'dokan-lite' ),
                    'reload'          => true,
                    'confirm_message' => __( 'It is strongly recommended that you backup your database before proceeding. Are you sure you wish to run the updater now?', 'dokan-lite' ),
                    'ajax_data'       => [
                        'action'   => 'dokan_do_upgrade',
                        '_wpnonce' => wp_create_nonce( 'dokan_admin' ),
                    ],
                ],
            ],
        ];

Please refer to the video attached

https://jam.dev/c/db9e3cf0-3a63-4bbb-b705-afef35d1ce6a

@mralaminahamed bhai

mralaminahamed commented 21 hours ago

@StalinDurjo vai, issue fix kore diachi. let check the update