feat: added forms for article and category to opengraph plugin

Author: shahzan01

plugins/system/opengraph/language/en-GB/plg_system_opengraph.ini

@@ -65,3 +65,112 @@ PLG_SYSTEM_OPENGRAPH_PRIORITY_ARTICLE="Article"
 PLG_SYSTEM_OPENGRAPH_PRIORITY_CATEGORY="Category"
 PLG_SYSTEM_OPENGRAPH_PRIORITY_GLOBAL="Global"
 PLG_SYSTEM_OPENGRAPH_PRIORITY_AUTO="Auto-generated"
+
+; Form Fieldsets
+PLG_SYSTEM_OPENGRAPH_FIELDSET_ARTICLE="OpenGraph Settings"
+PLG_SYSTEM_OPENGRAPH_FIELDSET_ARTICLE_DESC="Configure OpenGraph metadata for social media sharing. These settings override global defaults."
+
+PLG_SYSTEM_OPENGRAPH_FIELDSET_CATEGORY="OpenGraph Category Settings"
+PLG_SYSTEM_OPENGRAPH_FIELDSET_CATEGORY_DESC="Configure OpenGraph metadata for this category. These settings will be used for articles in this category when no article-specific settings are defined."
+
+; Common Field Labels
+PLG_SYSTEM_OPENGRAPH_OG_TITLE_LABEL="OpenGraph Title"
+PLG_SYSTEM_OPENGRAPH_OG_TITLE_DESC="Custom title for social media sharing. Recommended length: 40-60 characters."
+PLG_SYSTEM_OPENGRAPH_OG_TITLE_HINT="Enter a compelling title for social sharing"
+
+PLG_SYSTEM_OPENGRAPH_OG_DESCRIPTION_LABEL="OpenGraph Description"
+PLG_SYSTEM_OPENGRAPH_OG_DESCRIPTION_DESC="Brief description for social media sharing. Recommended length: 120-160 characters."
+PLG_SYSTEM_OPENGRAPH_OG_DESCRIPTION_HINT="Enter a brief, engaging description"
+
+PLG_SYSTEM_OPENGRAPH_OG_IMAGE_LABEL="OpenGraph Image"
+PLG_SYSTEM_OPENGRAPH_OG_IMAGE_DESC="Image for social media sharing. Recommended size: 1200x630 pixels."
+
+PLG_SYSTEM_OPENGRAPH_OG_IMAGE_ALT_LABEL="OpenGraph Image Alt Text"
+PLG_SYSTEM_OPENGRAPH_OG_IMAGE_ALT_DESC="Alternative text for the OpenGraph image for accessibility."
+
+PLG_SYSTEM_OPENGRAPH_OG_TYPE_LABEL="OpenGraph Type"
+PLG_SYSTEM_OPENGRAPH_OG_TYPE_DESC="Content type for social media platforms."
+
+PLG_SYSTEM_OPENGRAPH_OG_URL_LABEL="Custom URL"
+PLG_SYSTEM_OPENGRAPH_OG_URL_DESC="Override the canonical URL for sharing."
+PLG_SYSTEM_OPENGRAPH_OG_URL_HINT="Leave empty to use the article's URL"
+
+PLG_SYSTEM_OPENGRAPH_ENABLE_LABEL="Enable OpenGraph"
+PLG_SYSTEM_OPENGRAPH_ENABLE_DESC="Enable OpenGraph tags for this content."
+
+; OpenGraph Types
+PLG_SYSTEM_OPENGRAPH_USE_DEFAULT="Use Default"
+PLG_SYSTEM_OPENGRAPH_TYPE_ARTICLE="Article"
+PLG_SYSTEM_OPENGRAPH_TYPE_WEBSITE="Website"
+PLG_SYSTEM_OPENGRAPH_TYPE_BLOG="Blog"
+PLG_SYSTEM_OPENGRAPH_TYPE_VIDEO="Video"
+PLG_SYSTEM_OPENGRAPH_TYPE_MUSIC="Music"
+PLG_SYSTEM_OPENGRAPH_TYPE_BOOK="Book"
+PLG_SYSTEM_OPENGRAPH_TYPE_PROFILE="Profile"
+PLG_SYSTEM_OPENGRAPH_TYPE_PRODUCT="Product"
+PLG_SYSTEM_OPENGRAPH_TYPE_EVENT="Event"
+
+; Article Specific
+PLG_SYSTEM_OPENGRAPH_ARTICLE_SECTION_LABEL="Article Section"
+PLG_SYSTEM_OPENGRAPH_ARTICLE_SECTION_DESC="Section or category tag for the article."
+PLG_SYSTEM_OPENGRAPH_ARTICLE_SECTION_HINT="e.g., Technology, Sports, News"
+
+PLG_SYSTEM_OPENGRAPH_PRIORITY_NOTE_LABEL="Priority Information"
+PLG_SYSTEM_OPENGRAPH_PRIORITY_NOTE_DESC="These article settings take priority over category and global settings. Leave fields empty to inherit from higher levels."
+
+; Category Specific
+PLG_SYSTEM_OPENGRAPH_CATEGORY_TITLE_DESC="Custom title for this category's social media sharing."
+PLG_SYSTEM_OPENGRAPH_CATEGORY_TITLE_HINT="Enter a title that represents this category"
+
+PLG_SYSTEM_OPENGRAPH_CATEGORY_DESCRIPTION_DESC="Description for articles in this category when no article-specific description is set."
+PLG_SYSTEM_OPENGRAPH_CATEGORY_DESCRIPTION_HINT="Describe what this category contains"
+
+PLG_SYSTEM_OPENGRAPH_CATEGORY_IMAGE_DESC="Default image for articles in this category."
+PLG_SYSTEM_OPENGRAPH_CATEGORY_TYPE_DESC="Default content type for articles in this category."
+PLG_SYSTEM_OPENGRAPH_CATEGORY_URL_DESC="Custom URL for this category page."
+PLG_SYSTEM_OPENGRAPH_CATEGORY_URL_HINT="Leave empty to use the category's URL"
+PLG_SYSTEM_OPENGRAPH_CATEGORY_ENABLE_DESC="Enable OpenGraph tags for this category and its articles."
+
+PLG_SYSTEM_OPENGRAPH_INHERIT_PARENT_LABEL="Inherit from Parent"
+PLG_SYSTEM_OPENGRAPH_INHERIT_PARENT_DESC="Inherit OpenGraph settings from parent category when available."
+
+PLG_SYSTEM_OPENGRAPH_DEFAULT_ARTICLES_LABEL="Default for Articles"
+PLG_SYSTEM_OPENGRAPH_DEFAULT_ARTICLES_DESC="Use these settings as defaults for articles in this category."
+
+PLG_SYSTEM_OPENGRAPH_CATEGORY_SPECIFIC_LABEL="Category-Specific Options"
+
+PLG_SYSTEM_OPENGRAPH_SHOW_CATEGORY_LABEL="Show Category in Articles"
+PLG_SYSTEM_OPENGRAPH_SHOW_CATEGORY_DESC="Include category name in article OpenGraph metadata."
+
+PLG_SYSTEM_OPENGRAPH_USE_KEYWORDS_LABEL="Use Category Keywords"
+PLG_SYSTEM_OPENGRAPH_USE_KEYWORDS_DESC="Include category keywords in OpenGraph metadata."
+
+PLG_SYSTEM_OPENGRAPH_INHERITANCE_NOTE_LABEL="Inheritance Information"
+PLG_SYSTEM_OPENGRAPH_INHERITANCE_NOTE_DESC="Category settings are inherited by articles unless overridden at the article level. Global settings serve as the final fallback."
+
+; Character Counters
+PLG_SYSTEM_OPENGRAPH_TITLE_COUNTER_DESC="Character counter for title optimization"
+PLG_SYSTEM_OPENGRAPH_DESCRIPTION_COUNTER_DESC="Character counter for description optimization"
+
+; Note Fields
+PLG_SYSTEM_OPENGRAPH_CATEGORY_NOTE_LABEL="Category Settings Note"
+PLG_SYSTEM_OPENGRAPH_CATEGORY_NOTE_DESC="These settings apply to this category and can be inherited by articles within it."
+
+; Additional Missing Constants
+PLG_SYSTEM_OPENGRAPH_CATEGORY_SETTINGS="Category OpenGraph Settings"
+PLG_SYSTEM_OPENGRAPH_GLOBAL_SETTINGS="Global OpenGraph Settings"
+PLG_SYSTEM_OPENGRAPH_ARTICLE_SETTINGS="Article OpenGraph Settings"
+
+; Default values text
+PLG_SYSTEM_OPENGRAPH_DEFAULT_TITLE="Use site title"
+PLG_SYSTEM_OPENGRAPH_DEFAULT_DESCRIPTION="Use site description"
+PLG_SYSTEM_OPENGRAPH_DEFAULT_IMAGE="Use site logo"
+
+; Status messages for category fields
+PLG_SYSTEM_OPENGRAPH_CATEGORY_ENABLED="OpenGraph enabled for this category"
+PLG_SYSTEM_OPENGRAPH_CATEGORY_DISABLED="OpenGraph disabled for this category"
+PLG_SYSTEM_OPENGRAPH_CATEGORY_INHERIT="Inherit from global settings"
+
+; Help text for complex fields
+PLG_SYSTEM_OPENGRAPH_TYPE_HELP="Select the content type that best describes this category. This affects how social media platforms display shared links."
+PLG_SYSTEM_OPENGRAPH_IMAGE_HELP="Upload an image that represents this category. Recommended dimensions: 1200x630 pixels for optimal display on social media."

plugins/system/opengraph/opengraph.xml

@@ -13,6 +13,7 @@
 
     <files>
         <folder plugin="opengraph">src</folder>
+        <folder>services</folder>
         <filename>opengraph.xml</filename>
     </files>
 

plugins/system/opengraph/services/provider.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * @package     Joomla.Plugin
+ * @subpackage  System.Opengraph
+ *
+ * @copyright   (C) 2024 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+\defined('_JEXEC') or die;
+
+use Joomla\CMS\Extension\PluginInterface;
+use Joomla\CMS\Factory;
+use Joomla\CMS\Plugin\PluginHelper;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Plugin\System\Opengraph\Extension\Opengraph;
+
+return new class () implements ServiceProviderInterface {
+    /**
+     * Registers the service provider with a DI container.
+     *
+     * @param   Container  $container  The DI container.
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function register(Container $container)
+    {
+        $container->set(
+            PluginInterface::class,
+            function (Container $container) {
+                $plugin = new Opengraph(
+                    $container->get(DispatcherInterface::class),
+                    (array) PluginHelper::getPlugin('system', 'opengraph')
+                );
+                $plugin->setApplication(Factory::getApplication());
+
+                return $plugin;
+            }
+        );
+    }
+};

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

@@ -9,9 +9,12 @@
 
 namespace Joomla\Plugin\System\Opengraph\Extension;
 
+use Joomla\CMS\Application\CMSApplication;
 use Joomla\CMS\Event\Application\BeforeCompileHeadEvent;
+use Joomla\CMS\Event\Model\PrepareFormEvent;
 use Joomla\CMS\Plugin\CMSPlugin;
 use Joomla\Event\SubscriberInterface;
+use Joomla\CMS\Form\Form;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -24,15 +27,128 @@
  * @since  __DEPLOY_VERSION__
  */
 
-final class PlgSystemOpengraph extends CMSPlugin implements SubscriberInterface
+final class Opengraph extends CMSPlugin implements SubscriberInterface
 {
-
-
+    /**
+     * Returns an array of events this subscriber will listen to.
+     *
+     * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
+     */
     public static function getSubscribedEvents(): array
     {
         return [
             'onBeforeCompileHead' => 'onBeforeCompileHead',
+            'onContentPrepareForm' => 'onContentPrepareForm',
         ];
     }
 
+    /**
+     * Application object
+     *
+     * @var    CMSApplication
+     * @since  __DEPLOY_VERSION__
+     */
+    protected $app;
+
+    /**
+     * Load the language file on instantiation.
+     *
+     * @var    boolean
+     * @since  __DEPLOY_VERSION__
+     */
+    protected $autoloadLanguage = true;
+
+    /**
+     * Method to handle the onBeforeCompileHead event
+     *
+     * @param   BeforeCompileHeadEvent  $event  The event object
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function onBeforeCompileHead(BeforeCompileHeadEvent $event)
+    {
+        $app = $this->getApplication();
+
+        // Only run in frontend
+        if (!$app->isClient('site')) {
+            return;
+        }
+
+        // Will add OpenGraph meta tags logic here in the future
+        // This method will be called to generate OpenGraph tags
+    }
+
+    /**
+     * Method to add OpenGraph fields to content forms
+     *
+     * @param   PrepareFormEvent  $event  The event object.
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function onContentPrepareForm(PrepareFormEvent $event): void
+    {
+        $app = $this->getApplication();
+
+        if (!$app->isClient('administrator')) {
+            return;
+        }
+
+        $form = $event->getForm();
+        $data = $event->getData();
+
+        $name = $form->getName();
+
+
+
+        // Check if it's the article form
+        if ($name === 'com_content.article') {
+            $xmlFile = __DIR__ . '/../Forms/Article/Article.xml';
+            if (file_exists($xmlFile)) {
+                $result = $form->loadFile($xmlFile, false);
+
+            }
+        }
+
+        // Check if it's the category form
+        if (strpos($name, 'com_categories.category') === 0) {
+            $extension = '';
+
+            // Extract extension from form name if it's concatenated
+            if ($name === 'com_categories.categorycom_content') {
+                $extension = 'com_content';
+            } else {
+                // Try to get extension from different sources
+                if (is_object($data) && isset($data->extension)) {
+                    $extension = $data->extension;
+                } elseif (is_array($data) && isset($data['extension'])) {
+                    $extension = $data['extension'];
+                } else {
+                    $extension = $form->getValue('extension');
+                }
+
+                // If still empty, try from request
+                if (empty($extension)) {
+                    $input = $this->getApplication()->input;
+                    $extension = $input->get('extension', '', 'cmd');
+                }
+            }
+
+
+
+            // Load form only for content categories
+            if ($extension === 'com_content') {
+                $xmlFile = __DIR__ . '/../Forms/Category/Category.xml';
+                if (file_exists($xmlFile)) {
+                    $result = $form->loadFile($xmlFile, false);
+
+                }
+            }
+        }
+    }
 }