AnonymousFox

/home/develito/.trash/v5/plugins/content/fields/src/Extension/Fields.php

<?php

/**
 * @package     Joomla.Plugin
 * @subpackage  Content.fields
 *
 * @copyright   (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Plugin\Content\Fields\Extension;

use Joomla\CMS\Event\Content\ContentPrepareEvent;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Component\Fields\Administrator\Helper\FieldsHelper;
use Joomla\Event\SubscriberInterface;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Plug-in to show a custom field in eg an article
 * This uses the {fields ID} syntax
 *
 * @since  3.7.0
 */
final class Fields extends CMSPlugin implements SubscriberInterface
{
    /**
     * Returns an array of events this subscriber will listen to.
     *
     * @return array
     *
     * @since   5.3.0
     */
    public static function getSubscribedEvents(): array
    {
        return [
            'onContentPrepare' => 'onContentPrepare',
        ];
    }

/**
     * Plugin that shows a custom field
     *
     * @param   ContentPrepareEvent $event  The event instance.
     *
     * @return void
     *
     * @since  3.7.0
     */
    public function onContentPrepare(ContentPrepareEvent $event)
    {
        $context = $event->getContext();
        $item    = $event->getItem();

// If the item has a context, overwrite the existing one
        if ($context === 'com_finder.indexer' && !empty($item->context)) {
            $context = $item->context;
        } elseif ($context === 'com_finder.indexer') {
            // Don't run this plugin when the content is being indexed and we have no real context
            return;
        }

// This plugin only works if $item is an object
        if (!\is_object($item)) {
            return;
        }

// Don't run if there is no text property (in case of bad calls) or it is empty
        if (!property_exists($item, 'text') || empty($item->text)) {
            return;
        }

// Prepare the text
        if (property_exists($item, 'text') && str_contains($item->text, 'field')) {
            $item->text = $this->prepare($item->text, $context, $item);
        }

// Prepare the intro text
        if (property_exists($item, 'introtext') && \is_string($item->introtext) && str_contains($item->introtext, 'field')) {
            $item->introtext = $this->prepare($item->introtext, $context, $item);
        }

// Prepare the full text
        if (!empty($item->fulltext) && str_contains($item->fulltext, 'field')) {
            $item->fulltext = $this->prepare($item->fulltext, $context, $item);
        }
    }

/**
     * Prepares the given string by parsing {field} and {fieldgroup} groups and replacing them.
     *
     * @param   string  $string   The text to prepare
     * @param   string  $context  The context of the content
     * @param   object  $item     The item object
     *
     * @return string
     *
     * @since  3.8.1
     */
    private function prepare($string, $context, $item)
    {
        // Search for {field ID} or {fieldgroup ID} tags and put the results into $matches.
        $regex = '/{(field|fieldgroup)\s+(.*?)}/i';
        preg_match_all($regex, $string, $matches, PREG_SET_ORDER);

if (!$matches) {
            return $string;
        }

$parts = FieldsHelper::extract($context);

if (!$parts || \count($parts) < 2) {
            return $string;
        }

$context    = $parts[0] . '.' . $parts[1];
        $fields     = FieldsHelper::getFields($context, $item, true);
        $fieldsById = [];
        $groups     = [];

// Rearranging fields in arrays for easier lookup later.
        foreach ($fields as $field) {
            $fieldsById[$field->id]     = $field;
            $groups[$field->group_id][] = $field;
        }

foreach ($matches as $i => $match) {
            // $match[0] is the full pattern match, $match[1] is the type (field or fieldgroup) and $match[2] the ID and optional the layout
            $explode = explode(',', $match[2]);
            $id      = (int) $explode[0];
            $output  = '';

if ($match[1] === 'field' && $id) {
                if (isset($fieldsById[$id])) {
                    $layout = !empty($explode[1]) ? trim($explode[1]) : $fieldsById[$id]->params->get('layout', 'render');
                    $output = FieldsHelper::render(
                        $context,
                        'field.' . $layout,
                        [
                            'item'    => $item,
                            'context' => $context,
                            'field'   => $fieldsById[$id],
                        ]
                    );
                }
            } else {
                if ($match[2] === '*') {
                    $match[0]     = str_replace('*', '\*', $match[0]);
                    $renderFields = $fields;
                } else {
                    $renderFields = $groups[$id] ?? '';
                }

if ($renderFields) {
                    $layout = !empty($explode[1]) ? trim($explode[1]) : 'render';
                    $output = FieldsHelper::render(
                        $context,
                        'fields.' . $layout,
                        [
                            'item'    => $item,
                            'context' => $context,
                            'fields'  => $renderFields,
                        ]
                    );
                }
            }

$string = preg_replace("|$match[0]|", addcslashes($output, '\\$'), $string, 1);
        }

return $string;
    }
}