README

此包提供了一个简单的方法来计算和显示阿拉伯语和英语内容的预估阅读时间。

安装

您可以通过composer安装此包

composer require somarkn99/estimated-reading-time

此包的WordPress版本作为插件在此处可用

使用

服务提供商

将服务提供商添加到config/app.php文件中的providers数组中

'providers' => [
    // Other Service Providers
    Somarkn99\EstimatedReadingTime\EstimatedReadingTimeServiceProvider::class,
],

配置

您可以使用此命令发布配置文件

php artisan vendor:publish --provider="Somarkn99\EstimatedReadingTime\EstimatedReadingTimeServiceProvider" --tag="config"

这将把estimatedreadingtime.php配置文件发布到config目录。

Blade指令

您可以使用Blade指令在您的视图中显示预估阅读时间

@readingtime($content, 'en')

或对于阿拉伯语内容

@readingtime($content, 'ar')

直接使用主类

您可以直接从您的控制器、命令或应用的其它部分调用EstimatedReadingTime类中的calculate方法

use Somarkn99\EstimatedReadingTime\EstimatedReadingTime;

$readingTime = EstimatedReadingTime::calculate($content, 'en');

API使用

如果您更喜欢使用API来获取预估阅读时间，可以使用提供的端点。

定义路由

确保路由已加载，将其包含在您的routes/api.php中

Route::prefix('api')->group(function () {
    require base_path('vendor/somarkn99/estimated-reading-time/src/routes/api.php');
});

发送请求

向/api/reading-time发送包含内容和语言的POST请求。

请求

POST /api/reading-time
Content-Type: application/json

{
    "content": "Your article content goes here...",
    "lang": "en"
}

响应

{
    "reading_time": "Estimated Time of Reading: 3 Min"
}

配置选项

您可以通过修改配置选项来自定义包

return [
    'ar_prefix' => 'الوقت المقدر للقراءة: ',
    'ar_suffix_s' => 'دقيقة',
    'ar_suffix_p' => 'دقائق',
    'en_prefix' => 'Estimated Time of Reading: ',
    'en_suffix' => 'Min',
    'en_wpm' => 300,
    'ar_wpm' => 250,
    'exclude_images' => true,
];

安全

如果您发现任何安全相关问题，请通过kesen.somar.99@gmail.com发送邮件，而不是使用问题跟踪器。

致谢

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。

somarkn99 / estimated-reading-time

维护者

详细信息