# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意，禁止将本产品用于以下任何行为：
# | 1. 任何违反中华人民共和国法律法规的用途；
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为，本团队有权：
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================

"""
字典项表单验证模块
=============================================================

该模块定义了字典项管理功能中使用的表单验证类。
用于对前端提交的字典项数据进行验证，确保数据符合业务规则和数据库约束。
字典项是字典类型的具体数据，如下拉框、单选框、复选框的选项。
"""

from django import forms

from application.dict_item import models


# =============================================================
# 字典项表单验证类
# =============================================================

class DictItemForm(forms.ModelForm):
    """
    字典项表单验证类

    用于创建和更新字典项信息时的表单验证。
    字典项是字典的具体数据，每个字典项属于一个字典类型。

    验证字段包括：
    - dictId: 所属字典类型的ID
    - name: 字典项显示名称
    - value: 字典项实际值
    - note: 备注说明
    - sort: 排序值
    """

    # ----------------------------------------------------------
    # 字典ID
    # ----------------------------------------------------------
    # 字段说明: 所属字典类型的ID
    # 字段类型: 整型（IntegerField）
    # 验证规则: 必填（required=True），最小值0
    # 业务说明: 关联到字典表（Dict）的主键ID，标识该字典项属于哪个字典类型
    dictId = forms.IntegerField(
        required=True,
        min_value=0,
        error_messages={
            'required': '字典ID不能为空',
            'min_value': '字典ID不能小于0',
        }
    )

    # ----------------------------------------------------------
    # 字典项名称
    # ----------------------------------------------------------
    # 字段说明: 字典项的显示名称
    # 字段类型: 字符型（CharField）
    # 验证规则: 必填（required=True），最大长度100字符
    # 业务说明: 用于前端展示，如性别字典下的"男"、"女"；状态字典下的"启用"、"禁用"
    name = forms.CharField(
        required=True,
        max_length=100,
        error_messages={
            'required': '字典项名称不能为空',
            'max_length': '字典项名称长度不得超过100个字符',
        }
    )

    # ----------------------------------------------------------
    # 字典项值
    # ----------------------------------------------------------
    # 字段说明: 字典项的实际值
    # 字段类型: 字符型（CharField）
    # 验证规则: 必填（required=True），最大长度100字符
    # 业务说明: 用于业务逻辑判断和数据存储，如性别字典下的"1"、"2"
    value = forms.CharField(
        required=True,
        max_length=100,
        error_messages={
            'required': '字典项值不能为空',
            'max_length': '字典项值长度不得超过100个字符',
        }
    )

    # ----------------------------------------------------------
    # 字典项备注
    # ----------------------------------------------------------
    # 字段说明: 字典项的说明信息
    # 字段类型: 字符型（CharField）
    # 验证规则: 可选填（required=False），最大长度255字符
    # 业务说明: 描述字典项的含义或使用场景
    note = forms.CharField(
        required=False,
        max_length=255,
        error_messages={
            'max_length': '字典项备注长度不得超过255个字符',
        }
    )

    # ----------------------------------------------------------
    # 字典项排序
    # ----------------------------------------------------------
    # 字段说明: 字典项的显示顺序
    # 字段类型: 整型（IntegerField）
    # 验证规则: 必填（required=True），取值范围0-99999
    # 排序规则: 数字越小越靠前
    sort = forms.IntegerField(
        required=True,
        min_value=0,
        max_value=99999,
        error_messages={
            'required': '字典项排序不能为空',
            'min_value': '字典项排序值在0~99999之间',
            'max_value': '字典项排序值在0~99999之间',
        }
    )

    # =============================================================
    # 表单元数据配置
    # =============================================================

    class Meta:
        """
        表单元数据配置类

        定义表单绑定的模型和需要验证的字段。
        """

        # 绑定模型
        # 指定该表单对应的数据模型为 DictItem（字典项）
        model = models.DictItem

        # 指定需要验证的字段
        # 只验证以下字段，其他字段不进行表单验证
        fields = [
            'dictId',
            'name',
            'value',
            'note',
            'sort'
        ]