primo commit

libraries/fof30/Render/RenderInterface.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @package   FOF
+ * @copyright Copyright (c)2010-2021 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 2, or later
+ */
+
+namespace FOF30\Render;
+
+defined('_JEXEC') || die;
+
+use FOF30\Container\Container;
+use stdClass;
+
+/**
+ * Interface for FOF view renderers
+ *
+ * @package FOF30\Render
+ * @since   3.0.0
+ */
+interface RenderInterface
+{
+	/**
+	 * Public constructor
+	 *
+	 * @param   Container  $container  The container we are attached to
+	 */
+	function __construct(Container $container);
+
+	/**
+	 * Returns the information about this renderer
+	 *
+	 * @return object
+	 */
+	function getInformation(): stdClass;
+
+	/**
+	 * Echoes any HTML to show before the view template
+	 *
+	 * @param   string  $view  The current view
+	 * @param   string  $task  The current task
+	 *
+	 * @return  void
+	 */
+	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
+	 */
+	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
+	 */
+	function renderCategoryLinkbar(): void;
+
+	/**
+	 * 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
+	 */
+	function setOption(string $key, $value = null): void;
+
+	/**
+	 * Set multiple renderer options at once (depends on the renderer)
+	 *
+	 * @param   array  $options  The options to set as key => value pairs
+	 *
+	 * @return  void
+	 */
+	function setOptions(array $options): void;
+
+	/**
+	 * 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
+	 */
+	function getOption(string $key, $default = null);
+}