Download the PHP package leshkens/laravel-read-time without Composer
On this page you can find all versions of the php package leshkens/laravel-read-time. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-read-time
Laravel read time package
A package for laravel that shows users the approximate time to read content.
Requirements
- Laravel version 6 or higher
Installation
You can install the package via composer:
Publish config file
Config file config/read-time.php
Global options:
Word counter class
You can use your class and logic in word counting.
Your class must implement the Leshkens\LaravelReadTime\Contracts\CounterInterface
interface. The logic should be in the count()
method.
For example, this is what a standard word counter logic looks like:
Locale list
List of locales for forming the string "time to read":
Locale class must implement the Leshkens\LaravelReadTime\Contracts\LocaleInterface
interface. The logic should be in the result()
method.
For example, let's add the Ru locale class:
In config:
Usage
Object
You can pass your array of settings (the same settings as the global ones) as the second argument of the ReadTime
object.
Example:
String
Just add the get()
method.
The method can take a locale (from package config locale list) string value as the first argument. If nothing is passed to the method, or the value is null, the current application locale is taken.
Will return 3 секунды
Note: If the object of the desired locale is not in the config file of the package, then by default the string for English will be output
You can also use the readtime()
helper to render a string:
In model
Add the HasReadTime
trait and readTime()
method with settings to your model:
$article->read_time
returns the string value of the time to read.
If your attribute contains an array or json with locales:
you can set localable
to true
:
$article->read_time
returns the array value:
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Alexey Chugunov
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-read-time with dependencies
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
ext-json Version *