README

Fetch and display Google Place reviews in Neos CMS. Provides a content element, Eel helper, CLI commands, and automatic caching.

Supports both the legacy Google Maps API and the new Google Places API (v1).

Requirements

• Neos CMS 7.3+ / 8.x
• PHP 8.1+
• A Google Cloud API key with the Places API enabled

Installation

composer require upassist/neos-googlereviews

Configuration

Add your API key and default Place ID in Settings.yaml:

UpAssist:
  Neos:
    GoogleReviews:
      apiKey: 'YOUR_GOOGLE_API_KEY'
      defaultPlaceId: 'ChIJ...'

All options

Usage

Content element

Insert the Google Reviews content element in the Neos backend. It displays a rating summary and individual review cards in a responsive grid.

The element reads the Place ID from the nearest document node (via the GooglePlaceId mixin) or falls back to defaultPlaceId from settings.

Editor options in the inspector:

• Show author photo - Display reviewer avatars
• Max displayed reviews - Slider from 1 to 5
• Show link to all reviews - Link to Google reviews page

Document mixin

Add the mixin to any document NodeType to enable per-page Place ID configuration:

'Your.Package:Document.Page':
  superTypes:
    'UpAssist.Neos.GoogleReviews:Mixin.GooglePlaceId': true

This adds a "Google Reviews" tab in the inspector where editors can set the Place ID.

Eel helper

Use the GoogleReviews helper directly in Fusion:

# Get all data (rating, totalReviews, reviews array)
data = ${GoogleReviews.getData(placeId)}

# Individual accessors
reviews = ${GoogleReviews.getReviews(placeId)}
rating = ${GoogleReviews.getRating(placeId)}
totalReviews = ${GoogleReviews.getTotalReviews(placeId)}

The placeId argument is optional; it falls back to defaultPlaceId from settings.

CLI commands

Find a Place ID:

./flow googlereviews:findplaceid "Your Business Name City"

Fetch and cache reviews:

./flow googlereviews:fetch [placeId]

Clear the cache:

./flow googlereviews:clearcache [placeId]

Styling

The package ships minimal structural CSS. Override styles in your site package for branding. All classes use the BEM convention with the google-reviews block:

.google-reviews
.google-reviews__summary
.google-reviews__grid
.google-reviews__card
.google-reviews__stars
.google-reviews__star--filled
.google-reviews__footer
.google-reviews__cta

The grid uses a --reviews-count CSS custom property and collapses to a single column below 768px.

Caching

Reviews are cached using Flow's file-based cache backend. On API errors, stale cached data is served as a fallback. Use the clearcache CLI command or wait for the TTL to expire.

API versions

Translations

Includes English and Dutch translations out of the box. Add your own XLIFF files in the standard Neos translation path.

License

MIT