<?php
/**
 * Orange Management
 *
 * PHP Version 8.0
 *
 * @package   Modules\News\Models
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://orange-management.org
 */
declare(strict_types=1);

namespace Modules\News\Models;

use Modules\Admin\Models\AccountMapper;
use Modules\Comments\Models\CommentListMapper;
use Modules\Tag\Models\TagMapper;
use phpOMS\DataStorage\Database\DataMapperAbstract;

/**
 * News mapper class.
 *
 * @package Modules\News\Models
 * @license OMS License 1.0
 * @link    https://orange-management.org
 * @since   1.0.0
 *
 * @todo Orange-Management/oms-News#???
 *  Too complicated select.
 *  I think the default getAll etc. is too complicated and has too many joins which are not really required.
 *  Check and fix!
 */
final class NewsArticleMapper extends DataMapperAbstract
{
    /**
     * Columns.
     *
     * @var array<string, array{name:string, type:string, internal:string, autocomplete?:bool, readonly?:bool, writeonly?:bool, annotations?:array}>
     * @since 1.0.0
     */
    protected static array $columns = [
        'news_id'           => ['name' => 'news_id',         'type' => 'int',      'internal' => 'id'],
        'news_publish'      => ['name' => 'news_publish',    'type' => 'DateTime', 'internal' => 'publish'],
        'news_title'        => ['name' => 'news_title',      'type' => 'string',   'internal' => 'title'],
        'news_plain'        => ['name' => 'news_plain',      'type' => 'string',   'internal' => 'plain'],
        'news_content'      => ['name' => 'news_content',    'type' => 'string',   'internal' => 'content'],
        'news_lang'         => ['name' => 'news_lang',       'type' => 'string',   'internal' => 'language'],
        'news_status'       => ['name' => 'news_status',     'type' => 'int',      'internal' => 'status'],
        'news_type'         => ['name' => 'news_type',       'type' => 'int',      'internal' => 'type'],
        'news_featured'     => ['name' => 'news_featured',   'type' => 'bool',     'internal' => 'featured'],
        'news_comment_list' => ['name' => 'news_comment_list',   'type' => 'int',     'internal' => 'comments'],
        'news_created_at'   => ['name' => 'news_created_at', 'type' => 'DateTimeImmutable', 'internal' => 'createdAt', 'readonly' => true],
        'news_created_by'   => ['name' => 'news_created_by', 'type' => 'int',      'internal' => 'createdBy', 'readonly' => true],
    ];

    /**
     * Has one relation.
     *
     * @var array<string, array{mapper:string, external:string, by?:string, column?:string, conditional?:bool}>
     * @since 1.0.0
     */
    protected static array $ownsOne = [
        'comments' => [
            'mapper'     => CommentListMapper::class,
            'external'   => 'news_comment_list',
        ],
    ];

    /**
     * Belongs to.
     *
     * @var array<string, array{mapper:string, external:string}>
     * @since 1.0.0
     */
    protected static array $belongsTo = [
        'createdBy' => [
            'mapper'     => AccountMapper::class,
            'external'   => 'news_created_by',
        ],
    ];

    /**
     * Has many relation.
     *
     * @var array<string, array{mapper:string, table:string, self?:?string, external?:?string, column?:string}>
     * @since 1.0.0
     */
    protected static array $hasMany = [
        'tags' => [
            'mapper'   => TagMapper::class,
            'table'    => 'news_tag',
            'self'     => 'news_tag_dst',
            'external' => 'news_tag_src',
        ],
    ];

    /**
     * Primary table.
     *
     * @var string
     * @since 1.0.0
     */
    protected static string $table = 'news';

    /**
     * Primary field name.
     *
     * @var string
     * @since 1.0.0
     */
    protected static string $primaryField = 'news_id';
}