Download the PHP package maize-tech/laravel-legal-consent without Composer

# Laravel Legal Consent [](https://packagist.org/packages/maize-tech/laravel-legal-consent) [](https://github.com/maize-tech/laravel-legal-consent/actions?query=workflow%3Arun-tests+branch%3Amain) [](https://github.com/maize-tech/laravel-legal-consent/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain) [](https://packagist.org/packages/maize-tech/laravel-legal-consent) Easily integrate legal documents (like privacy policies, terms of use, etc.) to your application. ## Installation You can install the package via composer: You can publish and run the migrations with: You can publish the config file with: This is the content of the published config file: ## Usage ### Basic To use the package, add the `Maize\LegalConsent\HasLegalConsent` trait to the all Authenticatable models you want to handle. Here's an example including the `HasLegalConsent` trait to both User and Admin models: Once done, you must define the list of allowed document types by adding them in the `allowed_document_types` list from `config/legal-consent.php`. You can then create one or multiple documents from the DB or, if you wish, you could handle the creation with a CMS. Here are the fields who should be filled: - **type**: the document type name - **body**: the content of the document - **noted**: additional notes to show for the document - **published_at**: the date of publication for the given document Let's say we create a privacy policy document with the publication on 2021-01-01: here's the model entity we would have: You can now call the custom API to retrieve and accept the current document, which can be customized in `config/legal-consent.php`: #### GET - **/legal/documents/privacy-policy** This endpoint retrieves the current legal document using the given criteria: - the document type must be `privacy-policy` - the published_at date must be earlier than `now()` The document entries are then ordered by their published_at date in order to pick the latest one published. The response contains the document id (used for the POST route) along with all its information useful for rendering. Here is a sample response body: #### POST - **/legal/documents/{id}** This endpoint stores the consent for the given document from the currently authenticated user. ### Legal Document Listener You can eventually accept all active legal documents using our listener. This can be useful, for example, when your application handles the registration of users, and they must accept all legal documents through a checkbox before proceeding. In this case, all you should do is add the listener to the `Registered` event in `EventServiceProvider`: ## Testing ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Contributing Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details. ## Security Vulnerabilities Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities. ## Credits - [Enrico De Lazzari](https://github.com/enricodelazzari) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.