README

英文 | 俄语

EMAIL CSE 辅助工具

此辅助工具允许您操作、提取和检测电子邮件。

项目仓库: https://github.com/cs-eliseev/helpers-email

演示

switch (true) {
    case Email::is($emial):
        break;
    case Email::exist($emial):
        $emial = Email::extract($emial);
        break;
    default:
        new Exception('Email is not exist');
}

$emial = Email::hide($emial);

简介

CSE 辅助工具是一个用于人们的 PHP 简单函数库集合。

尽管 PHP 是互联网的主要编程语言，但其功能不足以处理电子邮件操作、提取和检测。EMAIL CSE 辅助工具正是为此而设计的。

CSE 辅助工具是为了快速开发网络应用程序而创建的。

CSE 辅助工具项目

以下是一些有关如何初始化库和执行常见命令的信息。

安装

您可以在此处找到此项目的最新版本。

Composer

执行以下命令以获取包的最新版本

composer require cse/helpers-email

或者 composer.json 应包含以下内容

{
    "require": {
        "cse/helpers-email": "*"
    }
}

Git

将此仓库本地克隆

git clone https://github.com/cs-eliseev/helpers-email.git

下载

在此处下载最新版本.

使用

该类包含静态方法，便于在任何项目中使用。请参阅示例 examples-email.php。

隐藏电子邮件

示例简短电子邮件

Email::hide('mail@google.com');
// m***@google.com

示例中等电子邮件

Email::hide('email@google.com');
// m***l@google.com

示例长电子邮件

Email::hide('email2018@google.com');
// e***l***8@google.com

检查电子邮件域名

示例

$domain = 'google.com';
Email::checkDomain('mail@google.com', $domain);
// true
Email::checkDomain('mail@mail.ru', $domain);
// false

检查电子邮件

示例

Email::is('mail@google.com');
// true

检查字符串中的电子邮件

Email::is('Example text mail@google.com');
// false

存在电子邮件

示例

Email::exist('mail@google.com');
// true

检查字符串中的电子邮件

Email::exist('Example text mail@google.com');
// true

更改模式

Email::exist('Example text mail@inbox.com', '([a-z]+@google.com)');
// false

从字符串中提取电子邮件

示例

Email::extract('Example text mail@google.com');
// mail@google.com

更改模式

Email::extract('Example text mail@inbox.com', '([a-z]+@google.com)');
// null

从字符串中提取所有电子邮件

示例

Email::extract('Example text mail@google.com, mail@inbox.com');
/**
* [
*     0 => 'mail@google.com',
*     1 => 'mail@inbox.com'
* ]
*/

更改模式

Email::extract('Example text mail@google.com, mail@inbox.com', '([a-z]+@google.com)');
/**
* [
*     0 => 'mail@google.com'
* ]
*/

测试 & 代码覆盖率

使用 PHPUnit 进行单元测试。单元测试确保类和方法确实做了它们应该做的事情。

有关 PHPUnit 的通用文档，请参阅 https://phpunit.de/documentation.html。

要运行 PHPUnit 单元测试，请执行

phpunit PATH/TO/PROJECT/tests/

如果您想生成代码覆盖率报告，请使用以下

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

使用 PHPUnit 默认配置

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

捐赠

您可以通过此处支持此项目。您还可以通过为项目做出贡献、报告错误或提出功能建议来帮助。任何帮助都是受欢迎的。

许可

EMAIL CSE 辅助工具是开源 PHP 库，根据 MIT 许可证授权。有关更多信息，请参阅许可文件。

GitHub @cs-eliseev

cse / helpers-email

维护者

详细信息

README

EMAIL CSE 辅助工具

简介

安装

Composer

Git

下载

使用

测试 & 代码覆盖率

捐赠

许可