README

Component\Core\StringUtils 是一个易于使用的 PHP 组件，提供对数据类型 string 的操作。

目录

• 简介
• 功能
• 要求
• 使用
• 安装
• 测试
• 贡献
• 致谢
• 许可

简介

简介

PHP脚本语言的字符串函数不一致

• 一些函数名以 str 开头，例如 strpos。
• 一些函数名以 str_ 开头，例如 str_rot13。
• 一些函数名 不以 str 开头，例如 trim 和 substr。

许多内置字符串函数只是底层C编程语言字符串函数的包装函数。因此，许多有用的字符串函数没有包含在 PHP 标准库中。

Component\Core\StringUtils 提供静态类，该类提供对数据类型 string 的操作。本项目的目标是创建一个统一的、简化的应用程序编程接口 (API)，用于在 PHP 脚本语言中使用字符串函数。

该项目受到了以下来自 Apache Commons Lang 应用程序编程接口 (API) 的 Java 类的启发

• StringUtils
• WordUtils
• CharUtils
• RandomStringUtils

实现已根据 PHP 进行了调整和抽象。

功能

• 类 StringUtils 提供对数据类型 string 的操作（目前有 39 个方法）。
• 类 WordUtils 提供对包含单词的数据类型 string 的操作（目前有 7 个方法）。
• 类 CharUtils 提供对字符的操作（目前有 18 个方法）。
• 类 RandomStringUtils 提供随机字符串的操作（目前有 7 个方法）。
• 已使用静态和动态测试程序测试了工件
  • 使用 PHPUnit 实现了动态组件测试（单元和集成测试）。
  • 使用以下工具执行了静态代码分析
    • PHP_CodeSniffer：样式检查器
    • PHP Mess Detector (PHPMD)：代码分析器
    • PHP Depend：代码度量
    • phpcpd：复制/粘贴检测器 (CPD)
    • phpdcd：死代码检测器（DCD）
    • SensioLabs 安全检查器：安全检查器
  • 使用以下网络服务进行持续集成（CI）
    • Scrutinizer CI
    • SensioLabs Insight
    • Coveralls
    • VersionEye
    • 依赖于
    • Waffle
• 提供了一个Packagist软件包，可以使用依赖管理器Composer进行安装。点击这里获取Packagist上的软件包。
• 提供了一个由文档生成器Sami生成的完整的应用程序编程接口（API）文档。点击这里获取API文档。
• 遵循PHP 框架互操作性小组（FIG）的以下“标准”。PSR代表PHP标准建议

  • PSR-0：自动加载标准

    旨在提供一个标准文件、类和命名空间的约定，以允许即插即用的代码。

  • PSR-1：基本编码标准

    旨在确保共享PHP代码之间具有高度的互操作性。

  • PSR-2：编码风格指南

    为希望标准化其代码的项目提供编码风格指南。

  • PSR-4：自动加载器

    对自动加载的一种更现代的看法，反映了生态系统的进步。

• 遵循语义版本化（SemVer）规范版本2.0.0。

要求

生产

• PHP >= 5.3.3
• Composer

开发

• PHPUnit
• phpcpd
• phpdcd
• PHP_CodeSniffer
• PHP Mess Detector（PHPMD）
• Sami
• SensioLabs 安全检查器
• php-coveralls

安装

Component\Util\Singleton应使用依赖管理器Composer进行安装。

Composer是PHP中依赖关系管理的工具。它允许您声明项目需要的依赖库，并且会为您在项目中安装它们。

可以使用php下载Composer安装程序。

php -r "readfile('https://getcomposer.org/installer');" | php

这只会检查几个PHP设置，然后下载composer.phar到您的当前工作目录。此文件是Composer的二进制文件。它是一个PHAR（PHP存档），是一种用于PHP的存档格式，可以用于命令行以及其他操作。

要解决和下载依赖项，请运行install命令

php composer.phar install

如果您正在创建依赖于Component\Util\Singleton的组件，请确保将Component\Util\Singleton添加到组件的composer.json文件中

{
    "require": {
        "duanyong/component-core-stringutils": "0.4.*"
    }
}

使用

Component\Core\StringUtils的最佳文档是包含在软件包中的单元测试。

Component\Core\StringUtils仅包含静态类。因此不能构造类的实例。

相反，类应该这样使用

StringUtils::trim(' foo ');
WordUtils::wrap('foo bar', 20);

测试

phpunit

贡献

请参阅 CONTRIBUTING 获取详细信息。

致谢

• 弗洛里安·沃尔特斯
• 所有贡献者

许可

本程序是免费软件：您可以按照自由软件基金会发布的GNU Lesser General Public License（许可证版本3或您选择的任何后续版本）的条款重新分发和/或修改该软件。

本程序的分发是基于它可能是有用的，但没有任何保证；甚至没有关于其商业性或适用于特定目的的暗示性保证。有关详细信息，请参阅GNU Lesser General Public License。

您应该已经随本程序收到了GNU Lesser General Public License的副本。如果没有，请参阅https://gnu.org/licenses/lgpl.txt。