JReviews Documentation

MyLists extends the core JReviews Favorites system by allowing multiple site-defined and user-created lists.

List Types:

• Site Lists: Public lists created by administrators. They can be associated with one or more listing types. A migration tool is available to move core favorites into a site list.
• User Lists: Created by end-users. Admins can configure whether users can create private lists, if lists should be auto-published, or if they require moderation.

JReviews provides default light and dark themes. The light theme contains all core assets, while the dark theme primarily provides color variable overrides. Themes are managed under Configuration → Theme & Navigation with three primary settings:

• Site Theme: Loaded on desktops and tablets.
• Mobile Theme: Loaded on mobile devices (though the site theme is responsive, this allows for distinct mobile output).
• Fallback Theme: Used as the source for any files not present in the active Site or Mobile theme. This should typically be the default theme unless building a theme from scratch.

MapsPro adds geo-directory functionality to JReviews, enabling location-based search, filtering, and map integration. Key features include:

• Maps on listing detail and list pages
• Dedicated map landing pages and widgets (via Joomla module or WordPress widget)
• Location-based searches in advanced search/filtering
• Map cover images (Google, Mapbox only)
• Streetview in detail pages (Google only)
• Proximity filters in listings modules and related listing widgets
• A modern 'Map View Page' (available in JReviews 6 Early Access) featuring clustered markers and interactive filtering.

JReviews 6 Early Access features use a modern customization system that differs from the legacy JReviews 3/5 approach. This system applies only to features that have been rewritten for Early Access. Features not yet rewritten continue to use the legacy .thtml and .po systems.

Key differences include:

• Templates: Uses Blade .blade.php files (replacing .thtml files).
• Language: Uses PHP arrays (replacing .po files).
• Location: Files are located in the /resources directory (replacing /jreviews and /locale).

ListingResources is an add-on that allows you to supplement listing information with external or internal content such as news, articles, offers, affiliate links, and external reviews. Key features include:

• Resource Types: Group and classify resources within listings.
• Access Settings: Control who can submit, update, and delete resources.
• Expiration Dates: Automatically hide resources after a specific date.
• Link Management: Support for link cloaking, tracking, and nofollow settings.
• Moderation: Ability to moderate new resource submissions.

JSON Custom Query is the recommended advanced-query format for modern JReviews pages and widgets. It allows developers to add model-aware filters and ordering using strict JSON instead of raw SQL.

Key constraints:

• Strict Validation: JReviews validates the entire JSON document. Any unknown field, invalid value, or unavailable context token will cause the entire query to be rejected (fail-closed), returning no matches.
• Narrowing Only: JSON where conditions can only narrow the set of eligible rows; they cannot widen it or bypass regular publication/access rules.
• No SQL: Raw SQL, subqueries, joins, and arbitrary SQL functions are not supported. You must migrate the intent of legacy SQL conditions into the supported JSON schema.

JReviews v6 uses two distinct systems for customization: CSS for visual styling and Templates for structure and content.

• CSS: A single custom.css file applies globally to all pages, regardless of whether they have been rewritten to the new system.
• Templates: The system depends on the page version:
  • Rewritten pages: Use .blade.php files located in the overrides folder (no custom theme required).
  • Non-rewritten pages: Use .thtml files and require a custom theme for overrides.