feat : created opengraph service interface and field type for opengraph plugin

Author: shahzan01

administrator/components/com_content/src/Extension/ContentComponent.php

@@ -25,6 +25,7 @@
 use Joomla\CMS\Helper\ContentHelper as LibraryContentHelper;
 use Joomla\CMS\HTML\HTMLRegistryAwareTrait;
 use Joomla\CMS\Language\Text;
+use Joomla\CMS\Opengraph\OpengraphServiceInterface;
 use Joomla\CMS\Schemaorg\SchemaorgServiceInterface;
 use Joomla\CMS\Schemaorg\SchemaorgServiceTrait;
 use Joomla\CMS\Tag\TagServiceInterface;
@@ -53,7 +54,8 @@ class ContentComponent extends MVCComponent implements
     SchemaorgServiceInterface,
     WorkflowServiceInterface,
     RouterServiceInterface,
-    TagServiceInterface
+    TagServiceInterface,
+    OpengraphServiceInterface
 {
     use AssociationServiceTrait;
     use RouterServiceTrait;
@@ -204,6 +206,30 @@ public function getSchemaorgContexts(): array
         return $contexts;
     }
 
+
+    /**
+     * Returns valid contexts for opengraph
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    public function getOpengraphFields(): array
+    {
+        Factory::getLanguage()->load('com_content', JPATH_ADMINISTRATOR);
+
+        $fields = [
+            'title' => Text::_('JGLOBAL_TITLE'),
+            'articletext' => Text::_('COM_CONTENT_FIELD_ARTICLETEXT_LABEL'),
+
+            // 'image_intro' => Text::_('COM_CONTENT_FIELD_INTRO_LABEL'),
+            // 'image_intro_alt' => Text::_('COM_CONTENT_FIELD_ARTICLETEXT_LABEL'),
+        ];
+
+        return $fields;
+    }
+
+
     /**
      * Returns valid contexts
      *
@@ -295,7 +321,6 @@ public function getModelName($context): string
 
         return ucfirst($modelname);
     }
-
     /**
      * Method to filter transitions by given id of state.
      *

libraries/src/Opengraph/OpengraphServiceInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  (C) 2025 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\CMS\Opengraph;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * The Opengraph service.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+interface OpengraphServiceInterface
+{
+    /**
+     * Returns valid contexts.
+     *
+     * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getOpengraphFields(): array;
+}

plugins/system/opengraph/src/Extension/opengraph.php

@@ -132,11 +132,20 @@ public function onContentPrepareForm(PrepareFormEvent $event): void
         $form = $event->getForm();
         $name = $form->getName();
 
-        if ($name === 'com_content.article') {
-            $xml = __DIR__ . '/../forms/opengraph.xml';
-            if (file_exists($xml)) {
-                $form->loadFile($xml, false);
-            }
+        //todo : replace with interface check
+        $supportedForms = [
+            'com_content.article',
+            'com_categories.categorycom_content',
+            'com_menus.item'
+        ];
+
+        if (!in_array($name, $supportedForms, true)) {
+            return;
+        }
+
+        $xml = __DIR__ . '/../forms/opengraph.xml';
+        if (file_exists($xml)) {
+            $form->loadFile($xml, false);
         }
     }
 

plugins/system/opengraph/src/Field/OpengraphField.php

@@ -0,0 +1,70 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  (C) 2009 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Plugin\System\Opengraph\Field;
+
+use Joomla\CMS\Extension\Component;
+use Joomla\CMS\Factory;
+use Joomla\CMS\Form\Field\ListField;
+use Joomla\CMS\Opengraph\OpengraphServiceInterface;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Form Field class for the Joomla Platform.
+ * Supports a generic list of options.
+ *
+ * @since  1.7.0
+ */
+
+class OpengraphField extends ListField
+{
+    /**
+     * The form field type.
+     *
+     * @var    string
+     * @since  1.7.0
+     */
+    protected $type = 'Opengraph';
+
+
+    /**
+     * Method to get the field options.
+     *
+     * @return  object[]  The field option objects.
+     *
+     * @since   3.7.0
+     */
+    protected function getOptions()
+    {
+
+        $app =  Factory::getApplication();
+        $options   = parent::getOptions();
+        //todo : make this more modular or flexible
+        $component = $app->bootComponent('com_content');
+        if (!$component instanceof OpengraphServiceInterface) {
+            return $options;
+        }
+
+        $fields = $component->getOpengraphFields();
+        foreach ($fields as $value => $text) {
+            $tmp = [
+                'value'    => $value,
+                'text'     => $text
+
+            ];
+            //todo : ordering of the fields
+            array_unshift($options, $tmp);
+        }
+
+        return $options;
+    }
+}

plugins/system/opengraph/src/forms/opengraph.xml

@@ -3,9 +3,10 @@
     <fieldset name="opengraph"
               label="PLG_SYSTEM_OPENGRAPH_FIELDSET_ARTICLE">
         <fieldset name="opengraph_field_mapping"
-                  label="PLG_SYSTEM_OPENGRAPH_FIELD_MAPPING_SECTION">
+                  label="PLG_SYSTEM_OPENGRAPH_FIELD_MAPPING_SECTION"
+                  addfieldprefix="Joomla\Plugin\System\Opengraph\Field">
             <field name="og_title_field"
-                   type="list"
+                   type="opengraph"
                    label="PLG_SYSTEM_OPENGRAPH_TITLE_FIELD_LABEL"
                    description="PLG_SYSTEM_OPENGRAPH_TITLE_FIELD_DESC"
                    class="form-select">