Download the PHP package betapeak/laravel-auditing-filesystem without Composer
On this page you can find all versions of the php package betapeak/laravel-auditing-filesystem. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download betapeak/laravel-auditing-filesystem
More information about betapeak/laravel-auditing-filesystem
Files in betapeak/laravel-auditing-filesystem
Package laravel-auditing-filesystem
Short Description A filesystem driver for the owen-it/laravel-auditing package. Allows storage of the audits in CSV files, across all registered Laravel disks.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-auditing-filesystem
This driver provides the ability to save your model audits in CSV files. It's integrated with Laravel's Storage system so you can use any of the disks specified in your application as the storage destinations of the audit files.
We also recognize that many systems generate a substantial amount of audit actions and that's why the package allows to specify how the audit files are generated - from a flat catch-all file to files generated for each hour of operation.
Installation
This driver requires that you are using owen-it/laravel-auditing: ^7.0. Provided this is fulfilled,
you can install the driver like so:
Setup
You need to add the following config entries in config/audit.php if you need to change the default behaviour of the driver.
The drivers key of the config file should look like so:
For simplicity, there are just 4 settings you can adjust and they're described below:
| Parameter | Type | Description |
|---|---|---|
| disk | (string) | The name of any filesystem disk in the app. Usage of remote disks (AWS, Rackspace, etc) is discouraged, as it introduces substantial additional http request overheads to the remote disk |
| dir | (string) | The directory on the disk where the audit csv files will be saved |
| filename | (string) | The filename of the audit file. If logging_type is different from 'single', this filename is ignored as it's being dynamically generated |
| logging_type | (string) | Defines how the audit files are being generated. One of 'single', 'daily' or 'hourly'. |
Usage
You can use the driver in any Auditable model (locally) like so:
or globally like so in config/audit.php:
More information on using community drivers with owen-it/laravel-auditing can be found on their homepage
Testing
This package can be tested with phpunit. You need to run composer install (With dev dependencies).
By default, you will only be able to run vendor/bin/phpunit --testsuite local.
If you want to test with remote disks, you need to install Docker and Docker Compose beforehand.
You need to run docker-compose up -d which will start a local s3 minio instance which will allow testing remote disks.
You can now run vendor/bin/phpunit or vendor/bin/phpunit --testsuite remote
All versions of laravel-auditing-filesystem with dependencies
ext-json Version *
owen-it/laravel-auditing Version ^10.0
league/csv Version ^9.0
league/flysystem Version ~1.0