README

一个PHP URL缩略词创建和清理库，只需传入一个字符串（如博客标题），它就会创建一个URL友好的缩略词。

要求

此库对PHP 7.3、7.4、8.0、8.1和8.2进行了单元测试！

如果您需要使用较旧的PHP版本，建议安装此库的2.x版本（详细信息见下文）。

许可证

此客户端库在MIT许可证下发布，许可证的副本包含在此包中。许可证副本

安装

强烈推荐在安装和使用此库时使用Composer，尽管不是强制性的，如果您需要，可以使用提供的'include'脚本来加载此库。

Composer

通过运行以下命令将Sluginator的最新版本添加到您的项目中

composer require ballen/sluginator

如果您需要使用较旧的PHP版本，版本1.x.x支持PHP 5.6、7.0、7.1和7.2，您可以使用Composer通过以下命令安装此版本

composer require ballen/sluginator ^1.0

独立使用

您可以通过从GitHub发行版部分下载此库，将其文件提取到您的服务器上的某个位置，然后像这样将"include"添加到您的代码中。

require_once 'path/to/Sluginator/lib/Slug.php';

示例

use Ballen\Sluginator\Slug;

$slug = new Slug('My awesomely *wickid* example title!!!');

echo $slug;

输出将是 my-awesomely-wickid-example-title。

该库还包含其他一些有用的方法，使您能够

指定应从字符串中删除的字符，默认情况下删除了一组健康的非URL字符。
指定不同的空格替换字符（默认为连字符'-'）。
输出带有或没有URL编码的缩略词（默认不启用）。
强制以全部小写字符输出（默认为'true'）。

以下是一个使用一些额外设置的示例

use Ballen\Sluginator\Slug;

$slug = new Slug('My awesomely *wickid* example title!!!');

$slug->setUseLowercase(false)->setSpaceCharacter('_')->build();

echo $slug->getSlug();

在上面的示例中，我们请求缩略词字符大小写保持不变，并且我们不会使用连字符（-）来分隔空格，而是将它们替换为下划线字符（_）。

测试和覆盖率

此库完全使用PHPUnit进行单元测试。

我使用GitHub Actions进行持续集成，它会在每次提交时触发单元测试。

如果您希望自行运行测试，请运行以下命令

# Install the Sluginator Library with the 'development' packages this then including PHPUnit!
composer install

# Now we run the unit tests (from the root of the project) like so:
./vendor/bin/phpunit

还可以运行代码覆盖率，但需要安装XDebug...

./vendor/bin/phpunit --coverage-html ./report

支持

我很乐意通过我的个人电子邮件地址提供支持，因此如果您需要帮助，请给我发电子邮件： ballen@bobbyallen.me。

ballen / sluginator

维护者

详细信息

README

要求

许可证

安装

Composer

独立使用

示例

测试和覆盖率

支持