<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2012 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Layout;

use Joomla\Registry\Registry;

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

/**
 * Base class for rendering a display layout
 *
 * @link   https://docs.joomla.org/Special:MyLanguage/Sharing_layouts_across_views_or_extensions_with_JLayout
 * @since  3.0
 */
class BaseLayout implements LayoutInterface
{
    /**
     * Options object
     *
     * @var    Registry
     * @since  3.2
     */
    protected $options = null;

    /**
     * Data for the layout
     *
     * @var    array
     * @since  3.5
     */
    protected $data = array();

    /**
     * Debug information messages
     *
     * @var    array
     * @since  3.2
     */
    protected $debugMessages = array();

    /**
     * Set the options
     *
     * @param   array|Registry  $options  Array / Registry object with the options to load
     *
     * @return  BaseLayout  Instance of $this to allow chaining.
     *
     * @since   3.2
     */
    public function setOptions($options = null)
    {
        // Received Registry
        if ($options instanceof Registry) {
            $this->options = $options;
        } elseif (\is_array($options)) {
            // Received array
            $this->options = new Registry($options);
        } else {
            $this->options = new Registry();
        }

        return $this;
    }

    /**
     * Get the options
     *
     * @return  Registry  Object with the options
     *
     * @since   3.2
     */
    public function getOptions()
    {
        // Always return a Registry instance
        if (!($this->options instanceof Registry)) {
            $this->resetOptions();
        }

        return $this->options;
    }

    /**
     * Function to empty all the options
     *
     * @return  BaseLayout  Instance of $this to allow chaining.
     *
     * @since   3.2
     */
    public function resetOptions()
    {
        return $this->setOptions(null);
    }

    /**
     * Method to escape output.
     *
     * @param   string  $output  The output to escape.
     *
     * @return  string  The escaped output.
     *
     * @note the ENT_COMPAT flag was replaced by ENT_QUOTES in Joomla 4.0 to also escape single quotes
     *
     * @since   3.0
     */
    public function escape($output)
    {
        return $output === null ? '' : htmlspecialchars($output, ENT_QUOTES, 'UTF-8');
    }

    /**
     * Get the debug messages array
     *
     * @return  array
     *
     * @since   3.2
     */
    public function getDebugMessages()
    {
        return $this->debugMessages;
    }

    /**
     * Method to render the layout.
     *
     * @param   array  $displayData  Array of properties available for use inside the layout file to build the displayed output
     *
     * @return  string  The necessary HTML to display the layout
     *
     * @since   3.0
     */
    public function render($displayData)
    {
        // Automatically merge any previously data set if $displayData is an array
        if (\is_array($displayData)) {
            $displayData = array_merge($this->data, $displayData);
        }

        return '';
    }

    /**
     * Render the list of debug messages
     *
     * @return  string  Output text/HTML code
     *
     * @since   3.2
     */
    public function renderDebugMessages()
    {
        return implode("\n", $this->debugMessages);
    }

    /**
     * Add a debug message to the debug messages array
     *
     * @param   string  $message  Message to save
     *
     * @return  self
     *
     * @since   3.2
     */
    public function addDebugMessage($message)
    {
        $this->debugMessages[] = $message;

        return $this;
    }

    /**
     * Clear the debug messages array
     *
     * @return  self
     *
     * @since   3.5
     */
    public function clearDebugMessages()
    {
        $this->debugMessages = array();

        return $this;
    }

    /**
     * Render a layout with debug info
     *
     * @param   mixed  $data  Data passed to the layout
     *
     * @return  string
     *
     * @since    3.5
     */
    public function debug($data = array())
    {
        $this->setDebug(true);

        $output = $this->render($data);

        $this->setDebug(false);

        return $output;
    }

    /**
     * Method to get the value from the data array
     *
     * @param   string  $key           Key to search for in the data array
     * @param   mixed   $defaultValue  Default value to return if the key is not set
     *
     * @return  mixed   Value from the data array | defaultValue if doesn't exist
     *
     * @since   3.5
     */
    public function get($key, $defaultValue = null)
    {
        return $this->data[$key] ?? $defaultValue;
    }

    /**
     * Get the data being rendered
     *
     * @return  array
     *
     * @since   3.5
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Check if debug mode is enabled
     *
     * @return  boolean
     *
     * @since   3.5
     */
    public function isDebugEnabled()
    {
        return $this->getOptions()->get('debug', false) === true;
    }

    /**
     * Method to set a value in the data array. Example: $layout->set('items', $items);
     *
     * @param   string  $key    Key for the data array
     * @param   mixed   $value  Value to assign to the key
     *
     * @return  self
     *
     * @since   3.5
     */
    public function set($key, $value)
    {
        $this->data[(string) $key] = $value;

        return $this;
    }

    /**
     * Set the the data passed the layout
     *
     * @param   array  $data  Array with the data for the layout
     *
     * @return  self
     *
     * @since   3.5
     */
    public function setData(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Change the debug mode
     *
     * @param   boolean  $debug  Enable / Disable debug
     *
     * @return  self
     *
     * @since   3.5
     */
    public function setDebug($debug)
    {
        $this->options->set('debug', (bool) $debug);

        return $this;
    }
}