Deprecate more code by Crabcyborg · Pull Request #2140 · Strategy11/formidable-forms

Crabcyborg · 2024-11-26T20:13:35Z

This frm_add_form_style_tab_options hook is now deprecated.

This update stops calling FrmFormsController::add_form_style_tab_options on this hook.

I also deprecated and cleared out the view file it renders.

coderabbitai · 2024-11-26T20:16:04Z

Walkthrough

The pull request introduces several modifications across multiple controller classes and a view file. Key changes include the removal of form style tab options in the FrmAppController, the deprecation of the add_form_style_tab_options method in the FrmFormsController, and the removal of the corresponding action hook in the FrmHooksController. Additionally, the view file add_form_style_options.php has been marked as deprecated. These changes streamline the management of form options and update promotional logic based on specific dates.

Changes

File	Change Summary
classes/controllers/FrmAppController.php	Removed action for form style tab options in `remove_upsells` method. Updated promotional logic for Black Friday and Cyber Monday with specific date checks.
classes/controllers/FrmFormsController.php	Deprecated `add_form_style_tab_options` method with a deprecation notice.
classes/controllers/FrmHooksController.php	Removed action hook for `add_form_style_tab_options` in `load_admin_hooks` method.
classes/views/frm-forms/add_form_style_options.php	Removed HTML note regarding "Page Turn Transitions" and added deprecation notice for the file.

Possibly related PRs

Pro issue 5404 / Black friday #2020: Modifies the FrmAppController class to enhance functionality related to Black Friday and Cyber Monday promotions.
Add a null check to avoid deprecated message when previewing #1742: Adds a null check in the FrmFormsController, relevant to the modifications in the same class.
Remove buttons settings tab #2115: Involves changes to the FrmFormsController regarding the removal of the buttons settings tab.
Remove notices from other plugins on applications pages #2120: Updates the FrmAppController to refine the logic for filtering admin notices.

Suggested labels

run analysis, run tests

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

🪧 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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 112e626 and 6a83f28.

📒 Files selected for processing (4)

classes/controllers/FrmAppController.php (0 hunks)
classes/controllers/FrmFormsController.php (1 hunks)
classes/controllers/FrmHooksController.php (1 hunks)
classes/views/frm-forms/add_form_style_options.php (1 hunks)

💤 Files with no reviewable changes (1)

classes/controllers/FrmAppController.php

✅ Files skipped from review due to trivial changes (1)

classes/views/frm-forms/add_form_style_options.php

🔇 Additional comments (2)

classes/controllers/FrmHooksController.php (2)

140-140: LGTM: Hook removal aligns with deprecation objectives.

The removal of the frm_add_form_style_tab_options hook from load_admin_hooks is consistent with the PR's goal to deprecate this functionality.

140-140: Verify impact on plugin integrations.

Since we're removing a public hook, let's verify if there are any plugin integrations that might be affected by this change.

coderabbitai · 2024-11-26T20:16:07Z

+
+	/**
+	 * Education for premium features.
+	 *
+	 * @since 4.05
+	 * @deprecated x.x
+	 *
+	 * @return void
+	 */
+	public static function add_form_style_tab_options() {
+		_deprecated_function( __METHOD__, 'x.x' );
+		include FrmAppHelper::plugin_path() . '/classes/views/frm-forms/add_form_style_options.php';
+	}


🛠️ Refactor suggestion

Update the deprecation version number

The deprecation version is currently set to "x.x" which is a placeholder. This should be updated to reflect the actual version number where this method will be deprecated.

Additionally, consider adding a @see tag in the docblock to point users to the new recommended way of handling form styles.

- * @deprecated x.x + * @deprecated 6.0 + * @see FrmStylesController::add_form_style_options() Use this method instead.

Committable suggestion skipped: line range outside the PR's diff.

Crabcyborg added 3 commits November 26, 2024 16:10

Deprecate more code

6a56a0b

Stop removing since it is removed

3965e9b

Also call deprecated function

6a83f28

Crabcyborg added run analysis run tests labels Nov 26, 2024

Crabcyborg added this to the 6.16.3 milestone Nov 26, 2024

Crabcyborg merged commit 1509a99 into master Nov 26, 2024

Crabcyborg deleted the deprecate_more_old_code branch November 26, 2024 20:15

coderabbitai Bot reviewed Nov 26, 2024

View reviewed changes

coderabbitai Bot mentioned this pull request Jan 12, 2026

Drop deprecated add_form_style_tab_options function and view #2774

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate more code#2140

Deprecate more code#2140
Crabcyborg merged 3 commits into
masterfrom
deprecate_more_old_code

Crabcyborg commented Nov 26, 2024

Uh oh!

coderabbitai Bot commented Nov 26, 2024

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Nov 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

Crabcyborg commented Nov 26, 2024

Uh oh!

coderabbitai Bot commented Nov 26, 2024

Walkthrough

Changes

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

CodeRabbit Configuration File (`.coderabbit.yaml`)