0

0

使用接口和特征在 PHP 中编写灵活的枚举

聖光之護

聖光之護

发布时间:2024-10-11 16:39:01

|

433人浏览过

|

来源于dev.to

转载

使用接口和特征在 php 中编写灵活的枚举

php 枚举是一个强大的工具,用于定义一组固定的常量,同时使您能够将功能附加到这些常量。除了简单地保存值之外,枚举还可以实现接口并使用特征来扩展其功能。这使得它们在复杂的应用程序中更加灵活和可重用。

在这篇文章中,我们将通过将枚举与接口和特征相结合,将您的 php 枚举设计提升到一个新的水平。我们将了解如何创建提供标签、描述的枚举,甚至为表单中的选择输入生成选项。最后,您将拥有一个可重用的结构,可以轻松扩展并在所有枚举中保持一致的行为。

为什么将枚举与接口和特征一起使用?

枚举非常适合表示状态、状态或类型。然而,仅仅拥有一个常量列表通常是不够的。在许多情况下,您可能需要:

  • 每个枚举案例的描述性标签或人类可读的名称。
  • 详细描述解释每个枚举案例的含义。
  • 用户界面中选择输入的结构化选项。

通过实现接口和使用特征,您可以确保您的枚举是一致的、可扩展的并且能够适应不断变化的需求。

立即学习PHP免费学习笔记(深入)”;

创建枚举接口

我们将首先定义一个任何枚举都可以实现的接口,以确保它具有返回标签、描述和生成选择输入选项的方法。

界面如下:





该接口定义了三个方法:

  1. label:为每个枚举案例返回一个人类可读的名称。
  2. 描述:提供每个枚举案例的详细描述。
  3. options:生成一个选项数组,其中每个选项包含枚举的值、标签和描述。这在构建表单时非常有用。

利用可重用逻辑的特征

我们可以通过使用特征来封装从枚举案例生成选项的通用逻辑来进一步增强我们的枚举。这就是 interactswithenumoptions 特征的用武之地。

 [
            'value' => $case->value,
            'label' => $case->label(),
            'description' => $case->description(),
        ], self::cases());
    }
}

此特征提供了一个可重用的 options() 方法,该方法循环遍历所有枚举案例 (self::cases()) 并返回一个数组,其中每个项目包含枚举案例的值、标签和描述。这在生成选择下拉选项时特别有用。

在枚举中实现接口和特征

现在让我们创建一个用于管理服务器状态的枚举。该枚举将实现 enum 接口并使用 interactswithenumoptions 特征来生成表单选项。

 'pending installation',
            self::running => 'running',
            self::stopped => 'stopped',
            self::failed => 'failed',
            default => throw new \exception('unknown enum value requested for the label'),
        };
    }

    public function description(): string
    {
        return match ($this) {
            self::pending => 'the server is currently being created or initialized.',
            self::running => 'the server is live and operational.',
            self::stopped => 'the server is stopped but can be restarted.',
            self::failed => 'the server encountered an error and is not running.',
            default => throw new \exception('unknown enum value requested for the description'),
        };
    }
}

这里发生了什么?

  1. 枚举案例:我们定义了代表不同服务器状态的几种案例(例如,pending、running、stopped、failed)。
  2. 标签和描述方法:label() 和description() 方法为每个枚举案例提供人类可读的名称和详细描述。这些方法使用匹配语句将每个案例映射到其相应的标签和描述。
  3. 选项特征:interactswithenumoptions 特征用于自动生成表单选择输入的选项数组,其中包含案例的值、标签和描述。

通过可重用存根增加灵活性

如果您正在处理多个枚举,并且想要一种快速的方法来设置它们具有类似的功能,您可以使用一个可重用的存根,它结合了我们所涵盖的所有内容。这是此类存根的改进版本:

Sheet+
Sheet+

Excel和GoogleSheets表格AI处理工具

下载
 'example label', // add labels for other cases
            default => throw new \exception('unknown enum value requested for the label'),
        };
    }

    public function description(): string
    {
        return match ($this) {
            self::example => 'this is an example description.', // add descriptions for other cases
            default => throw new \exception('unknown enum value requested for the description'),
        };
    }
}

自定义存根:

  • 将 {{ namespace }} 替换为枚举的实际命名空间。
  • 在 case 块内添加相关的枚举 case 并定义相应的标签和描述。

为什么这种模式有效

  1. 跨枚举的一致性:通过此设置,每个实现 enum 接口的枚举都必须提供标签和描述。这确保所有枚举都遵循相同的模式,使您的代码库更易于维护。
  2. 特征的可重用性:interactswithenumoptions特征封装了生成选项的通用逻辑,可以在多个枚举之间重用,而无需重复代码。
  3. 可扩展性:随着应用程序的增长,添加新的枚举案例或其他方法将成为一个无缝的过程。如果您需要修改选项的生成方式或添加新功能,您可以在特征或界面中集中执行此操作。

laravel blade 模板中的用法示例

让我们添加一个示例,说明如何在 laravel blade 模板中使用枚举。假设我们正在使用 serverstatus 枚举,并且希望使用 interactswithenumoptions 特征生成的选项生成一个选择输入,供用户选择服务器状态。

首先,确保您的控制器将枚举选项传递给视图。例如:

控制器示例:





serverstatus::options() 方法将返回一个具有以下结构的数组:

[
    ['value' => 'pending', 'label' => 'pending installation', 'description' => 'the server is currently being created or initialized.'],
    ['value' => 'running', 'label' => 'running', 'description' => 'the server is live and operational.'],
    // other cases...
]

刀片模板示例:

在 blade 模板中,您现在可以使用 statusoptions 填充选择下拉列表并在用户选择状态时显示说明。

@extends('layouts.app')

@section('content')
    

Edit Server

@csrf @method('PUT')
{{ $statusOptions[array_search($server->status, array_column($statusOptions, 'value'))]['description'] }}
@endsection

解释:

  1. 控制器:在控制器中调用 serverstatus::options() 方法来生成选项数组,然后将其传递到 blade 视图。

  2. 刀片模板

    • 创建
    • 选择上的 onchange 事件会触发 updatedescription() javascript 函数,该函数会根据所选选项更新下拉列表下方的描述。
    • 最初,页面加载时会显示当前服务器状态的描述。
  3. javascript:使用 @json 指令将 statusoptions 数组传递给 javascript,每当用户更改所选状态时 updatedescription() 函数都会更新描述。

此设置以用户友好的方式使用枚举选项,利用枚举中的标签和描述方法,在表单中提供丰富的体验。

结论

通过将 php 枚举与接口和特征相结合,您可以创建一个灵活、可扩展且可重用的模式,用于管理带有标签、描述和选择选项等附加逻辑的常量。即使应用程序的复杂性不断增加,这种设计也能确保整个代码库的一致性和可维护性。

通过我们构建的接口和特征结构,您现在可以以干净、有组织的方式实现枚举。无论您是处理服务器状态、用户角色还是支付状态,这种方法都将帮助您编写更清晰、更易于维护的代码。

编码愉快!


作者简介

nasrul hazim 是一位拥有超过 14 年经验的解决方案架构师和软件工程师。您可以在 github 上的 nasrulhazim 上探索他的更多作品。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2894

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1734

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1566

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

1099

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1546

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1277

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1669

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1309

2023.11.13

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

1

2026.01.26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号