feat: add LocalBusiness JSON-LD schema type
Universal: Auto Version Bump / Version Bump (push) Successful in 12s
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 11s

Adds configurable LocalBusiness structured data with address,
contact, geo coordinates, and opening hours. Enabled via plugin
parameters. Closes #65
This commit is contained in:
Jonathan Miller
2026-06-23 11:27:59 -05:00
parent 96eea6060f
commit 44d9daf3bc
5 changed files with 302 additions and 0 deletions
@@ -39,3 +39,35 @@ PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED="Enable JSON-LD"
PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED_DESC="Output JSON-LD structured data (Article, WebPage) for Google rich results."
PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS="JSON-LD Breadcrumbs"
PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS_DESC="Output BreadcrumbList JSON-LD schema from Joomla's pathway."
PLG_SYSTEM_MOKOOG_FIELDSET_LOCALBUSINESS="Local Business"
PLG_SYSTEM_MOKOOG_FIELD_LB_ENABLED="Enable LocalBusiness Schema"
PLG_SYSTEM_MOKOOG_FIELD_LB_ENABLED_DESC="Output LocalBusiness JSON-LD structured data on all pages."
PLG_SYSTEM_MOKOOG_FIELD_LB_NAME="Business Name"
PLG_SYSTEM_MOKOOG_FIELD_LB_NAME_DESC="Your business name for structured data."
PLG_SYSTEM_MOKOOG_FIELD_LB_TYPE="Business Type"
PLG_SYSTEM_MOKOOG_FIELD_LB_TYPE_DESC="Schema.org business type."
PLG_SYSTEM_MOKOOG_FIELD_LB_STREET="Street Address"
PLG_SYSTEM_MOKOOG_FIELD_LB_STREET_DESC="Street address of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_CITY="City"
PLG_SYSTEM_MOKOOG_FIELD_LB_CITY_DESC="City of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_REGION="State/Region"
PLG_SYSTEM_MOKOOG_FIELD_LB_REGION_DESC="State or region of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_POSTAL="Postal Code"
PLG_SYSTEM_MOKOOG_FIELD_LB_POSTAL_DESC="Postal/ZIP code of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_COUNTRY="Country"
PLG_SYSTEM_MOKOOG_FIELD_LB_COUNTRY_DESC="Country code (e.g. US, GB, DE)."
PLG_SYSTEM_MOKOOG_FIELD_LB_PHONE="Phone"
PLG_SYSTEM_MOKOOG_FIELD_LB_PHONE_DESC="Business phone number."
PLG_SYSTEM_MOKOOG_FIELD_LB_EMAIL="Email"
PLG_SYSTEM_MOKOOG_FIELD_LB_EMAIL_DESC="Business email address."
PLG_SYSTEM_MOKOOG_FIELD_LB_URL="Website URL"
PLG_SYSTEM_MOKOOG_FIELD_LB_URL_DESC="Business website URL."
PLG_SYSTEM_MOKOOG_FIELD_LB_OPENING_HOURS="Opening Hours"
PLG_SYSTEM_MOKOOG_FIELD_LB_OPENING_HOURS_DESC="Opening hours in schema.org format (e.g. Mo-Fr 09:00-17:00)."
PLG_SYSTEM_MOKOOG_FIELD_LB_LATITUDE="Latitude"
PLG_SYSTEM_MOKOOG_FIELD_LB_LATITUDE_DESC="Geographic latitude of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_LONGITUDE="Longitude"
PLG_SYSTEM_MOKOOG_FIELD_LB_LONGITUDE_DESC="Geographic longitude of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_PRICE_RANGE="Price Range"
PLG_SYSTEM_MOKOOG_FIELD_LB_PRICE_RANGE_DESC="Price range indicator (e.g. $, $$, $$$)."
@@ -39,3 +39,35 @@ PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED="Enable JSON-LD"
PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED_DESC="Output JSON-LD structured data (Article, WebPage) for Google rich results."
PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS="JSON-LD Breadcrumbs"
PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS_DESC="Output BreadcrumbList JSON-LD schema from Joomla's pathway."
PLG_SYSTEM_MOKOOG_FIELDSET_LOCALBUSINESS="Local Business"
PLG_SYSTEM_MOKOOG_FIELD_LB_ENABLED="Enable LocalBusiness Schema"
PLG_SYSTEM_MOKOOG_FIELD_LB_ENABLED_DESC="Output LocalBusiness JSON-LD structured data on all pages."
PLG_SYSTEM_MOKOOG_FIELD_LB_NAME="Business Name"
PLG_SYSTEM_MOKOOG_FIELD_LB_NAME_DESC="Your business name for structured data."
PLG_SYSTEM_MOKOOG_FIELD_LB_TYPE="Business Type"
PLG_SYSTEM_MOKOOG_FIELD_LB_TYPE_DESC="Schema.org business type."
PLG_SYSTEM_MOKOOG_FIELD_LB_STREET="Street Address"
PLG_SYSTEM_MOKOOG_FIELD_LB_STREET_DESC="Street address of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_CITY="City"
PLG_SYSTEM_MOKOOG_FIELD_LB_CITY_DESC="City of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_REGION="State/Region"
PLG_SYSTEM_MOKOOG_FIELD_LB_REGION_DESC="State or region of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_POSTAL="Postal Code"
PLG_SYSTEM_MOKOOG_FIELD_LB_POSTAL_DESC="Postal/ZIP code of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_COUNTRY="Country"
PLG_SYSTEM_MOKOOG_FIELD_LB_COUNTRY_DESC="Country code (e.g. US, GB, DE)."
PLG_SYSTEM_MOKOOG_FIELD_LB_PHONE="Phone"
PLG_SYSTEM_MOKOOG_FIELD_LB_PHONE_DESC="Business phone number."
PLG_SYSTEM_MOKOOG_FIELD_LB_EMAIL="Email"
PLG_SYSTEM_MOKOOG_FIELD_LB_EMAIL_DESC="Business email address."
PLG_SYSTEM_MOKOOG_FIELD_LB_URL="Website URL"
PLG_SYSTEM_MOKOOG_FIELD_LB_URL_DESC="Business website URL."
PLG_SYSTEM_MOKOOG_FIELD_LB_OPENING_HOURS="Opening Hours"
PLG_SYSTEM_MOKOOG_FIELD_LB_OPENING_HOURS_DESC="Opening hours in schema.org format (e.g. Mo-Fr 09:00-17:00)."
PLG_SYSTEM_MOKOOG_FIELD_LB_LATITUDE="Latitude"
PLG_SYSTEM_MOKOOG_FIELD_LB_LATITUDE_DESC="Geographic latitude of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_LONGITUDE="Longitude"
PLG_SYSTEM_MOKOOG_FIELD_LB_LONGITUDE_DESC="Geographic longitude of your business."
PLG_SYSTEM_MOKOOG_FIELD_LB_PRICE_RANGE="Price Range"
PLG_SYSTEM_MOKOOG_FIELD_LB_PRICE_RANGE_DESC="Price range indicator (e.g. $, $$, $$$)."
@@ -181,6 +181,135 @@
<option value="0">JNO</option>
</field>
</fieldset>
<fieldset name="localbusiness" label="PLG_SYSTEM_MOKOOG_FIELDSET_LOCALBUSINESS">
<field
name="lb_enabled"
type="radio"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_ENABLED"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_ENABLED_DESC"
default="0"
class="btn-group"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="lb_name"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_NAME"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_NAME_DESC"
default=""
filter="string"
/>
<field
name="lb_type"
type="list"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_TYPE"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_TYPE_DESC"
default="LocalBusiness"
>
<option value="LocalBusiness">LocalBusiness</option>
<option value="Restaurant">Restaurant</option>
<option value="Store">Store</option>
<option value="MedicalBusiness">MedicalBusiness</option>
<option value="LegalService">LegalService</option>
<option value="FinancialService">FinancialService</option>
<option value="EducationalOrganization">EducationalOrganization</option>
</field>
<field
name="lb_street"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_STREET"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_STREET_DESC"
default=""
filter="string"
/>
<field
name="lb_city"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_CITY"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_CITY_DESC"
default=""
filter="string"
/>
<field
name="lb_region"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_REGION"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_REGION_DESC"
default=""
filter="string"
/>
<field
name="lb_postal"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_POSTAL"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_POSTAL_DESC"
default=""
filter="string"
/>
<field
name="lb_country"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_COUNTRY"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_COUNTRY_DESC"
default="US"
filter="string"
/>
<field
name="lb_phone"
type="tel"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_PHONE"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_PHONE_DESC"
default=""
/>
<field
name="lb_email"
type="email"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_EMAIL"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_EMAIL_DESC"
default=""
/>
<field
name="lb_url"
type="url"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_URL"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_URL_DESC"
default=""
/>
<field
name="lb_opening_hours"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_OPENING_HOURS"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_OPENING_HOURS_DESC"
default=""
filter="string"
/>
<field
name="lb_latitude"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_LATITUDE"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_LATITUDE_DESC"
default=""
filter="string"
/>
<field
name="lb_longitude"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_LONGITUDE"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_LONGITUDE_DESC"
default=""
filter="string"
/>
<field
name="lb_price_range"
type="text"
label="PLG_SYSTEM_MOKOOG_FIELD_LB_PRICE_RANGE"
description="PLG_SYSTEM_MOKOOG_FIELD_LB_PRICE_RANGE_DESC"
default=""
filter="string"
/>
</fieldset>
</fields>
</config>
</extension>
@@ -298,6 +298,15 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface
}
}
}
// LocalBusiness JSON-LD
if ($this->params->get('lb_enabled', 0)) {
$lbSchema = JsonLdBuilder::buildLocalBusiness($this->params);
if ($lbSchema) {
$doc->addCustomTag(JsonLdBuilder::toScriptTag($lbSchema));
}
}
}
/**
@@ -282,6 +282,106 @@ class JsonLdBuilder
return $schema;
}
/**
* Build LocalBusiness schema from plugin parameters.
*
* @param object $params Plugin parameters object
*
* @return array|null
*/
public static function buildLocalBusiness(object $params): ?array
{
$name = trim((string) $params->get('lb_name', ''));
if ($name === '') {
return null;
}
$schema = [
'@context' => 'https://schema.org',
'@type' => $params->get('lb_type', 'LocalBusiness'),
'name' => $name,
];
// Build PostalAddress
$address = [];
$street = trim((string) $params->get('lb_street', ''));
$city = trim((string) $params->get('lb_city', ''));
$region = trim((string) $params->get('lb_region', ''));
$postal = trim((string) $params->get('lb_postal', ''));
$country = trim((string) $params->get('lb_country', ''));
if ($street !== '') {
$address['streetAddress'] = $street;
}
if ($city !== '') {
$address['addressLocality'] = $city;
}
if ($region !== '') {
$address['addressRegion'] = $region;
}
if ($postal !== '') {
$address['postalCode'] = $postal;
}
if ($country !== '') {
$address['addressCountry'] = $country;
}
if (!empty($address)) {
$address['@type'] = 'PostalAddress';
$schema['address'] = $address;
}
// Contact properties
$phone = trim((string) $params->get('lb_phone', ''));
$email = trim((string) $params->get('lb_email', ''));
$url = trim((string) $params->get('lb_url', ''));
if ($phone !== '') {
$schema['telephone'] = $phone;
}
if ($email !== '') {
$schema['email'] = $email;
}
if ($url !== '') {
$schema['url'] = $url;
}
// Opening hours
$openingHours = trim((string) $params->get('lb_opening_hours', ''));
if ($openingHours !== '') {
$schema['openingHours'] = $openingHours;
}
// GeoCoordinates
$latitude = trim((string) $params->get('lb_latitude', ''));
$longitude = trim((string) $params->get('lb_longitude', ''));
if ($latitude !== '' && $longitude !== '') {
$schema['geo'] = [
'@type' => 'GeoCoordinates',
'latitude' => $latitude,
'longitude' => $longitude,
];
}
// Price range
$priceRange = trim((string) $params->get('lb_price_range', ''));
if ($priceRange !== '') {
$schema['priceRange'] = $priceRange;
}
return $schema;
}
/**
* Encode a schema array to a JSON-LD script tag string.
*