Download the PHP package starfolksoftware/factchecks without Composer
On this page you can find all versions of the php package starfolksoftware/factchecks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download starfolksoftware/factchecks
More information about starfolksoftware/factchecks
Files in starfolksoftware/factchecks
Package factchecks
Short Description Add factchecking to your Laravel application
License MIT
Homepage https://github.com/starfolksoftware/factchecks
Informations about the package factchecks
Add factchecks to your Laravel application
Add the ability to associate factchecks to your Laravel Eloquent models.
Installation
You can install the package via composer:
The package will automatically register itself.
You can publish the migration with:
After the migration has been published you can create the media-table by running the migrations:
You can publish the config-file with:
Usage
Registering Models
To let your models be able to receive factchecks, add the HasFactchecks
trait to the model classes.
Creating Factchecks
To create a comment on your commentable models, you can use the comment
method. It receives the string of the comment that you want to store.
The factcheck method returns the newly created factcheck class.
Sometimes you also might want to create factchecks on behalf of other users. You can do this using the factcheckAsUser
method and pass in your user model that should get associated
with this factcheck:
Auto Approve Factchecks
If you want to automatically approve a factcheck for a specific user (and optionally model) you can let your User model implement the following interface and method:
The needsFactcheckApproval
method received the model instance that you want to add a factcheck to and you can either return true
to mark the factcheck as not approved, or return false
to mark the factcheck as approved.
Auto Approve Factchecks
If you want to automatically approve a factcheck for a specific user (and optionally model) you can let your User model implement the following interface and method:
The needsFactcheckApproval
method received the model instance that you want to add a factcheck to and you can either return true
to mark the factcheck as not approved, or return false
to mark the factcheck as approved.
Submitting Factchecks
By default, all factchecks that you create are saved as draft and not approved - this is just a datetime column called submitted_at
that you can use in your views/controllers to filter out factchecks that you might not yet want to display.
To submit a single comment, you may use the submit
method on the Factcheck model like this:
Approving Factchecks
After submitting a factcheck, the next stage on the journey to publishing is approval - this is just a datetime column called approved_at
that you can use in your views/controllers to filter out factchecks that you might not yet want to display.
To approve a single factcheck, you may use the approve
method on the Factcheck model like this:
Publishing Factchecks
After approving a factcheck, the final stage is approval - this is just a datetime column called published_at
that you can use in your views/controllers to filter out factchecks that you might not yet want to display.
To approve a single factcheck, you may use the publish
method on the Factcheck model like this:
Retrieving Factchecks
The models that use the HasFactchecks
trait have access to it's factchecks using the factchecks
relation:
Testing
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
- Faruk Nasir
- Marcel Pociot
- All Contributors
License
The MIT License (MIT). Please see License File for more information.