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 Application Programming Interface (API) 的Java类的启发

• StringUtils
• WordUtils
• CharUtils
• RandomStringUtils

实现已经针对 PHP 进行了适配和抽象。

特性

• 类 StringUtils 提供了数据类型 string 的操作（目前有 39 个方法）。
• 类 WordUtils 提供了包含单词的数据类型 string 的操作（目前有 7 个方法）。
• 类 CharUtils 提供了字符的操作（目前有 18 个方法）。
• 类 RandomStringUtils 提供了随机 string 的操作（目前有 7 个方法）。
• 使用静态和动态测试程序测试了工件
  • 使用 PHPUnit 实现了动态组件测试（单元和集成测试）。
  • 使用以下工具执行了静态代码分析
    • PHP_CodeSniffer: 样式检查器
    • PHP Mess Detector (PHPMD): 代码分析器
    • PHP Depend: 代码度量
    • phpcpd: 复制/粘贴检测器 (CPD)
    • phpdcd: 死代码检测器 (DCD)
    • SensioLabs Security Checker：安全检查器
  • 使用以下网络服务进行持续集成（CI）
    • Scrutinizer CI
    • SensioLabsInsight
    • Coveralls
    • VersionEye
    • 依赖于
    • Waffle
• 提供由依赖管理器Composer安装的Packagist包。点击此处查看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 Security Checker
• php-coveralls

安装

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

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

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

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

这将只检查一些PHP设置，然后下载composer.phar到你的工作目录。此文件是Composer的二进制文件。它是一个PHAR（PHP存档），是一种PHP存档格式，可以在命令行上运行，以及其他事项。

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

php composer.phar install

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

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

使用方法

关于Component\Core\StringUtils的最好文档是包含在包中的单元测试。

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

相反，类应该这样使用

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

测试

phpunit

贡献

有关详细信息，请参阅CONTRIBUTING。

致谢

• Florian Wolters
• 所有贡献者

许可证

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

本程序的分发是希望它是有用的，但没有任何保证；甚至没有关于适销性或特定用途适用性的暗示保证。有关更多详情，请参阅GNU Lesser General Public License。

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