Skip to content

docs: Port "Helpers" page to 7.2#572

Open
promptless-for-oss wants to merge 1 commit into
mautic:7.2from
Promptless:promptless/docs-issue-411-helpers-7.2
Open

docs: Port "Helpers" page to 7.2#572
promptless-for-oss wants to merge 1 commit into
mautic:7.2from
Promptless:promptless/docs-issue-411-helpers-7.2

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Ports the legacy Helpers developer guide (ChartQuery/Graphs, DateTime, Input helper classes) into docs/plugin_miscellaneous/helpers.rst, converting the legacy Markdown to RST. Targets the 7.2 base branch per the team's plan to set content in 7.2 first, then cherry-pick to 7.1/7.0/6.0/5.x. Resolves docs issue #411 (parent #410).

Trigger Events


Tip: Tag @Promptless in GitHub PR comments to guide documentation changes during code review 🐙


.. vale off

ChartQuery and Graphs

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourced the ChartQuery, LineChart, PieChart, and BarChart descriptions and the chart-rendering example in this section from the legacy _plugin_misc_helpers_chartquery.md include, linked from porting issue #410.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_misc_helpers_chartquery.md


.. vale off

DateTime

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourced the DateTimeHelper UTC/local conversion example (toUtcString()) from the legacy _plugin_misc_helpers_datetime.md include, linked from porting issue #410.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_misc_helpers_datetime.md


.. vale off

Input

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourced the InputHelper sanitization methods (clean, int, alphanum, html) from the legacy _plugin_misc_helpers_input.md include, linked from porting issue #410.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_misc_helpers_input.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant