Reviews Plugin Documentation

[ Reviews ]

Review Subject Plugins

Subject Plugins determine what is the subject of the review.

Functionality can be extended by adding plugin classes for additional review Subject Plugins. Review Subject plugins are simple classes that provide the functionality to adapt Reviews to alternative review subjects. They should inherit from SubjectPluginBase. Details are provided by comments in the code.

Plugins can be added by placing the plugin classes at packages/anyPackageName/src/JtF/Reviews/ReviewSubject/Plugins/PluginName or application/src/JtF/Reviews/ReviewSubject/Plugins/PluginName. Plugins can also be similarly placed beneath the plugin type's namespace declared in a package controller's AutoloaderRegistries.

[ Reviews ]

Current Page

The subject of the review is the current page.

The review block will associate the page the review block is rendered on as the subject of the review

[ Reviews ]

Selected Image

The subject of the review is a selected image.

The review block will associate a selected image file as the subject of the review

[ Reviews ]

Selected Page

The subject of the review is a selected page.

The review block will associate a selected page as the subject of the review

[ Reviews ]

Visitor Form Plugins

Visitor Form Plugins provide forms for site visitors to post a review.

Functionality can be extended by adding plugin classes for additional Visitor Form Plugins. Visitor Form Plugins are simple classes that provide the functionality to adapt reviews to alternative form inputs. They should inherit from VisitorFormPluginBase. Details are provided by comments in the code.

Plugins can be added by placing the plugin classes at packages/anyPackageName/src/JtF/Reviews/VisitorForm/Plugins/PluginName or application/src/JtF/Reviews/VisitorForm/Plugins/PluginName. Plugins can also be similarly placed beneath the plugin type's namespace declared in a package controller's AutoloaderRegistries.

[ Reviews ]

Stars and Note

A simple built in form allowing a visitor to add a star rating and review text.

The reveiw block will show a self-contained form for entry of a star rating and review text.

[ Reviews ]

Stars and Note No ID

A variant of the Stars and Note form, but without id="" in the form elements.

The reveiw block will show a self-contained form for entry of a star rating and review text. This is essentially the same as Stars and Note, but without the ID fields the core form helper adds to all elements. This can be useful if the ID fields would otherwise conflict elsewhere on the page or if more than one form is on a page.

[ Reviews ]

Review Summary Plugins

Review Summary Plugins provide a summary of reviews.

Functionality can be extended by adding plugin classes for additional Review Summary Plugins. Review Summary Plugins are simple classes that provide the functionality to adapt reviews to alternative form inputs. They should inherit from ReviewSummaryPluginBase. Details are provided by comments in the code.

Plugins can be added by placing the plugin classes at packages/anyPackageName/src/JtF/Reviews/ReviewSummary/Plugins/PluginName or application/src/JtF/Reviews/ReviewSummary/Plugins/PluginName. Plugins can also be similarly placed beneath the plugin type's namespace declared in a package controller's AutoloaderRegistries.

[ Reviews ]

Mean Last X

Provide a simple mean of the last X ratings.

The scope of the mean is the last X reviews that have been approved.

[ Reviews ]

Mean With Count

Provide a simple mean of all review ratings with a count of the number of reviews.

The scope of the mean is all reviews that have been approved. To insert a count, place the marker "%d" into the description text.

[ Reviews ]

None

No summary.

Do not bother to calculate or display a summary.

[ Reviews ]

Simple Mean

Provide a simple mean of all review ratings.

The scope of the mean is all reviews that have been approved.

[ Reviews ]

Review Subject Display Plugins

Subject Display Plugins determine what is the subject of the review displayed.

Functionality can be extended by adding plugin classes for additional Plugins. Typically Review Subject Display Plugins map 1:1 against Review Subject Plugins, but a display could combine the results of multiple subject. Review Subject Plugins are simple classes that provide the functionality to adapt reviews to alternative subjects. They should inherit from the respective PluginBase. Details are provided by comments in the code.

Plugins can be added by placing the plugin classes at packages/anyPackageName/src/JtF/Reviews/ReviewSubjectDisplay/Plugins/PluginName or application/src/JtF/Reviews/ReviewSubjectDisplay/Plugins/PluginName. Plugins can also be similarly placed beneath the plugin type's namespace declared in a package controller's AutoloaderRegistries.

[ Reviews ]

All Pages Display

Reviews for all pages are displayed.

This subject display plugin combines all pages as the review subject and is typically coupled with the Subject Plugin "Current Page".

[ Reviews ]

Current Page Display

Reviews for the current page are displayed.

This subject display plugin selects the current page as the review subject and is typically coupled with the Subject Plugin "Current Page".

[ Reviews ]

Selected Image Display

Reviews for a selected image are displayed.

This subject display plugin selects an image to display reviews for and is typically coupled with the Subject Plugin "Selected Image".

[ Reviews ]

Selected Page Display

Reviews for a selected page are displayed.

This subject display plugin selects a page to display reviews for and is typically coupled with the Subject Plugin "Current Page".

[ Reviews ]

Visitor Form Display Plugins

Visitor Form Display Plugins provide displays for Vistor Form plugins.

Functionality can be extended by adding plugin classes for additional Plugins. Typically Visitor Form Display Plugins map 1:1 against Visitor Form Plugins, but a display could combine the results of multiple forms. Visitor Form Plugins are simple classes that provide the functionality to adapt reviews to alternative form inputs. They should inherit from the respective PluginBase. Details are provided by comments in the code.

Plugins can be added by placing the plugin classes at packages/anyPackageName/src/Reviews/VisitorFormDisplay/Plugins/PluginName or application/src/Reviews/VisitorFormDisplay/Plugins/PluginName. Plugins can also be similarly placed beneath the plugin type's namespace declared in a package controller's AutoloaderRegistries.

[ Reviews ]

Stars and Note Display

Dsiplay results from the simple built in form Stars and Note.

This result display plugin is coupled with the Visitor Form Plugin "Stars and Note".

Additional Pages

Reviews

 

 

 

This Page Reviews

  • Wow, built in documentation!

    John
    5 Dec 2019
    I am rather chuffed with the way my plugin system includes documentation.
    But I am only giving it 3 stars so you can bump it up (or down) with your own reviews.