emoji-detector-php 项目使用教程

emoji-detector-php 项目使用教程

emoji-detector-php This library will find all emoji in an input string and return information about each emoji character. 项目地址: https://gitcode.com/gh_mirrors/em/emoji-detector-php

1. 项目目录结构及介绍

emoji-detector-php/
├── src/
│   ├── Emoji.php
│   ├── map.json
│   └── regexp.json
├── tests/
│   └── EmojiTest.php
├── example.php
├── composer.json
├── phpunit.xml
├── README.md
├── LICENSE
└── CONTRIBUTING.md

目录结构说明

• src/: 包含项目的主要源代码文件。

  • Emoji.php: 主要的Emoji检测类文件。
  • map.json: Emoji映射数据文件。
  • regexp.json: Emoji正则表达式数据文件。

• tests/: 包含项目的测试文件。

  • EmojiTest.php: Emoji检测类的测试文件。

• example.php: 项目的示例文件，展示了如何使用Emoji检测类。

• composer.json: Composer配置文件，用于管理项目的依赖。

• phpunit.xml: PHPUnit配置文件，用于配置测试环境。

• README.md: 项目的说明文档。

• LICENSE: 项目的开源许可证文件。

• CONTRIBUTING.md: 项目贡献指南文件。

2. 项目启动文件介绍

example.php

example.php 文件是项目的示例启动文件，展示了如何使用 Emoji 类来检测输入字符串中的Emoji。

<?php
require 'vendor/autoload.php';

use p3k\Emoji;

$input = "Hello 👍🏼 World 👨‍👩‍👦‍👦";
$emoji = Emoji\detect_emoji($input);
print_r($emoji);

使用说明

1. 确保已经通过Composer安装了项目的依赖。
2. 运行 example.php 文件，可以看到输入字符串中所有Emoji的详细信息。

3. 项目的配置文件介绍

composer.json

composer.json 文件是Composer的配置文件，用于管理项目的依赖和自动加载。

{
    "name": "p3k/emoji-detector",
    "description": "This library will find all emoji in an input string and return information about each emoji character.",
    "license": "MIT",
    "require": {
        "php": ">=7.0"
    },
    "autoload": {
        "psr-4": {
            "p3k\\": "src/"
        }
    }
}

配置说明

• name: 项目的名称。
• description: 项目的描述。
• license: 项目的开源许可证。
• require: 项目所需的PHP版本。
• autoload: 自动加载配置，指定命名空间 p3k 对应的源代码目录 src/。

phpunit.xml

phpunit.xml 文件是PHPUnit的配置文件，用于配置测试环境。

<phpunit bootstrap="vendor/autoload.php">
    <testsuites>
        <testsuite name="Emoji Detector Tests">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
</phpunit>

配置说明

• bootstrap: 指定自动加载文件 vendor/autoload.php。
• testsuites: 指定测试套件，包含 tests 目录下的所有测试文件。

通过以上配置，可以确保项目在开发和测试过程中能够正确加载依赖并运行测试。

emoji-detector-php This library will find all emoji in an input string and return information about each emoji character. 项目地址: https://gitcode.com/gh_mirrors/em/emoji-detector-php