<?php

/**
 * @package     Dotclear
 * @subpackage  Backend
 *
 * @copyright   Olivier Meunier & Association Dotclear
 * @copyright   AGPL-3.0
 */
declare(strict_types=1);

/**
 * @namespace   Dotclear.Core.Backend.Listing
 * @brief       Backend list pager helpers.
 */

namespace Dotclear\Core\Backend\Listing;

use ArrayObject;
use Dotclear\App;
use Dotclear\Database\MetaRecord;
use Dotclear\Helper\Html\Form\Component;
use Dotclear\Helper\Html\Form\Img;
use Dotclear\Helper\Html\Form\Text;
use Dotclear\Helper\Html\Html;

/**
 * @brief   Generic class for admin listing form.
 *
 * @template TUserColumn = Component
 *
 * @since   2.20
 */
class Listing
{
    /**
     * Previous page label.
     */
    protected string $html_prev;

    /**
     * Next page label.
     */
    protected string $html_next;

    /**
     * Constructs a new instance.
     *
     * @param   MetaRecord  $rs         The record
     * @param   int         $rs_count   Count of elements listed
     */
    public function __construct(
        protected MetaRecord $rs,
        protected int $rs_count
    ) {
        $this->html_prev = __('&#171; prev.');
        $this->html_next = __('next &#187;');
    }

    /**
     * Get user defined columns
     *
     * The $cols paramters should be populate with all possible columns and then unwanted columns
     * will be removed if user set so via App::backend()->userPref()->getUserColumns.
     * Each column having a key name and having some value (TUserColumn see class comment above).
     *
     * If $component is true then all column's value will be converted to Component if already not (as Text)
     *
     * @param      string                                                           $type       The type
     * @param      array<string, TUserColumn> | ArrayObject<string, TUserColumn>    $cols       The columns
     * @param      bool                                                             $component  Convert column's value to Component
     */
    public function userColumns(string $type, array|ArrayObject $cols, bool $component = false): void
    {
        App::backend()->userPref()->getUserColumns($type, $cols);
        if ($component) {
            foreach ($cols as &$value) {
                if (!$value instanceof Component && is_scalar($value)) {
                    $value = new Text(null, (string) $value);
                }
            }
        }
    }

    /**
     * Get image for table row and legend.
     */
    public static function getRowImage(string $title, string $image, string $class, bool $with_text = false): Img|Text
    {
        $img = (new Img($image))
            ->alt(Html::escapeHTML($title))
            ->class(['mark', 'mark-' . $class]);

        return $with_text ?
            (new Text(null, $img->render() . ' ' . Html::escapeHTML($title))) :
            $img;
    }

    /**
     * Get the number of element listed
     */
    public function getCount(): int
    {
        return $this->rs_count;
    }
}
