primo commit

libraries/fof40/Render/RenderBase.php

@@ -0,0 +1,250 @@
+<?php
+/**
+ * @package   FOF
+ * @copyright Copyright (c)2010-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace FOF40\Render;
+
+defined('_JEXEC') || die;
+
+use FOF40\Container\Container;
+use Joomla\Registry\Registry;
+use LogicException;
+use stdClass;
+
+/**
+ * Base class for other render classes
+ *
+ * @package FOF40\Render
+ * @since   3.0.0
+ */
+abstract class RenderBase implements RenderInterface
+{
+	/** @var   Container|null  The container we are attached to */
+	protected $container;
+
+	/** @var   bool  Is this renderer available under this execution environment? */
+	protected $enabled = false;
+
+	/** @var   int  The priority of this renderer in case we have multiple available ones */
+	protected $priority = 0;
+
+	/** @var   Registry  A registry object holding renderer options */
+	protected $optionsRegistry;
+
+	/**
+	 * Public constructor. Determines the priority of this class and if it should be enabled
+	 */
+	public function __construct(Container $container)
+	{
+		$this->container = $container;
+
+		$this->optionsRegistry = new Registry();
+	}
+
+	/**
+	 * Set a renderer option (depends on the renderer)
+	 *
+	 * @param   string  $key    The name of the option to set
+	 * @param   mixed   $value  The value of the option
+	 *
+	 * @return  void
+	 */
+	public function setOption(string $key, string $value): void
+	{
+		$this->optionsRegistry->set($key, $value);
+	}
+
+	/**
+	 * Set multiple renderer options at once (depends on the renderer)
+	 *
+	 * @param   array  $options  The options to set as key => value pairs
+	 *
+	 * @return  void
+	 */
+	public function setOptions(array $options): void
+	{
+		foreach ($options as $key => $value)
+		{
+			$this->setOption($key, $value);
+		}
+	}
+
+	/**
+	 * Get the value of a renderer option
+	 *
+	 * @param   string  $key      The name of the parameter
+	 * @param   mixed   $default  The default value to return if the parameter is not set
+	 *
+	 * @return  mixed  The parameter value
+	 */
+	public function getOption(string $key, $default = null)
+	{
+		return $this->optionsRegistry->get($key, $default);
+	}
+
+	/**
+	 * Returns the information about this renderer
+	 *
+	 * @return  stdClass
+	 */
+	public function getInformation(): stdClass
+	{
+		$classParts = explode('\\', get_class($this));
+
+		return (object) [
+			'enabled'  => $this->enabled,
+			'priority' => $this->priority,
+			'name'     => strtolower(array_pop($classParts)),
+		];
+	}
+
+	/**
+	 * Performs initialisation.
+	 *
+	 * This is where you load your CSS and JavaScript frameworks. Only load the common code that the view's static
+	 * assets will definitely depend on.
+	 *
+	 * This runs at the top of the View's display() method, before ony onBefore* handlers. Any files inserted to the
+	 * Joomla document / WebAssetManager by this method CAN plausibly be removed by code in the view or any view event
+	 * handlers in plugins.
+	 *
+	 * @param   string  $view  The current view
+	 * @param   string  $task  The current task
+	 *
+	 * @return  void
+	 * @since   4.0.0
+	 */
+	public function initialise(string $view, string $task): void
+	{
+		$this->loadCustomCss();
+	}
+
+	/**
+	 * Echoes any HTML to show before the view template
+	 *
+	 * @param   string  $view  The current view
+	 * @param   string  $task  The current task
+	 *
+	 * @return  void
+	 */
+	public function preRender(string $view, string $task): void
+	{
+	}
+
+	/**
+	 * Echoes any HTML to show after the view template
+	 *
+	 * @param   string  $view  The current view
+	 * @param   string  $task  The current task
+	 *
+	 * @return  void
+	 */
+	public function postRender(string $view, string $task): void
+	{
+	}
+
+	/**
+	 * Renders the submenu (link bar) for a category view when it is used in a
+	 * extension
+	 *
+	 * Note: this function has to be called from the addSubmenu function in
+	 *         the ExtensionNameHelper class located in
+	 *         administrator/components/com_ExtensionName/helpers/Extensionname.php
+	 *
+	 * @return  void
+	 */
+	public function renderCategoryLinkbar(): void
+	{
+		throw new LogicException(sprintf('Renderer class %s must implement the %s method', get_class($this), __METHOD__));
+	}
+
+	/**
+	 * Opens a wrapper DIV. Our component's output will be inside this wrapper.
+	 *
+	 * @param   array  $classes  An array of additional CSS classes to add to the outer page wrapper element.
+	 *
+	 * @return  void
+	 */
+	protected function openPageWrapper(array $classes): void
+	{
+		$removeClasses = $this->getOption('remove_wrapper_classes', []);
+
+		if (!is_array($removeClasses))
+		{
+			$removeClasses = explode(',', $removeClasses);
+		}
+
+		$removeClasses = array_map('trim', $removeClasses);
+
+		foreach ($removeClasses as $class)
+		{
+			$x = array_search($class, $classes);
+
+			if ($x !== false)
+			{
+				unset($classes[$x]);
+			}
+		}
+
+		// Add the following classes to the wrapper div
+		$addClasses = $this->getOption('add_wrapper_classes', '');
+
+		if (!is_array($addClasses))
+		{
+			$addClasses = explode(',', $addClasses);
+		}
+
+		$addClasses    = array_map('trim', $addClasses);
+		$customClasses = implode(' ', array_unique(array_merge($classes, $addClasses)));
+
+		$id = $this->getOption('wrapper_id', null);
+		$id = empty($id) ? "" : sprintf(' id="%s"', $id);
+
+		echo <<< HTML
+<div class="$customClasses"$id>
+
+HTML;
+	}
+
+	/**
+	 * Outputs HTML which closes the page wrappers opened with openPageWrapper.
+	 *
+	 * @return  void
+	 */
+	protected function closePageWrapper(): void
+	{
+		echo "</div>\n";
+	}
+
+	/**
+	 * Loads the custom CSS files defined in the custom_css renderer option.
+	 */
+	protected function loadCustomCss()
+	{
+		$custom_css_raw = $this->getOption('custom_css', '');
+		$custom_css_raw = trim($custom_css_raw);
+
+		if (empty($custom_css_raw))
+		{
+			return;
+		}
+
+		$files        = explode(',', $custom_css_raw);
+		$mediaVersion = $this->container->mediaVersion;
+
+		foreach ($files as $file)
+		{
+			$file = trim($file);
+
+			if (empty($file))
+			{
+				continue;
+			}
+
+			$this->container->template->addCSS($file, $mediaVersion);
+		}
+	}
+}