README

Bookworm估算阅读特定文本所需的时间。

安装

目前，安装Bookworm唯一可靠（也是推荐）的方式是通过PHP包管理器Composer。

{
    "require": {
        "worddrop/bookworm": "dev-master"
    }
}

<?php
use Bookworm\Bookworm;

$text = '...';
$time = Bookworm::estimate($text);
echo $time; // 5 minutes

Bookworm::estimate(string $text, string|array|bool $units = [ ' minute', ' minutes' ]);

参数

$text 应基于此文本的估算。
$units = [' minute', ' minutes' ] 可选。 设置为false，则只返回作为整数的分钟数。如果您提供字符串，如m，它将被用于单数和复数，并产生5m。如果您提供包含两个值的数组，第一个将用于单数，第二个用于复数。[' minute', ' minutes' ]（不包括前面的空格）将产生5 minutes。

返回值 int 或 string

您可以配置Bookworm以不同于默认的方式响应。您可以更改每分钟平均阅读单词数以及用户查看图片所需的时间。如果您不希望图片影响阅读时间估算，只需将其设置为0。

<?php
use Bookworm\Bookworm;

Bookworm::configure([
    'wordsPerMinute' => 200,
    'codewordsPerMinute' => 200,
    'secondsPerImage' => 12
]);

wordsPerMinute 用户每分钟平均阅读的单词数（默认200）。

codewordsPerMinute 代码块中用户每分钟平均阅读的单词数（默认200）。

secondsPerImage 用户查看图片的平均秒数（默认12）。

该项目受MIT许可协议保护。有关完整的版权和许可信息，请查看与源代码一起分发的LICENSE文件。

您可以以任何方式贡献，只要您同意您的代码将受到与项目本身相同的许可协议的保护。

请在提交前确保运行测试。

$ composer test