Download the PHP package bgeneto/ci4-audits without Composer

On this page you can find all versions of the php package bgeneto/ci4-audits. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of bgeneto/ci4-audits

Informations about the package ci4-audits

ci4-audits

Simple and lightweight audit logging for CodeIgniter 4

Quick Start

  1. Install with Composer: > composer require bgeneto/ci4-audits
  2. Update the database: > php spark migrate --all
  3. Set up your models:

Features

Provides ready-to-use object logging for CodeIgniter 4

Installation

Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:

Or, install manually by downloading the source files and adding the directory to app/Config/Autoload.php.

Once the files are downloaded and included in the autoload, run any library migrations to ensure the database is setup correctly:

Configuration (optional)

The library's default behavior can be altered by extending its config file. Copy examples/Audits.php to app/Config/Audits.php and follow the instructions in the comments. If no config file is found in app/Config the library will use its own.

Usage

Once the library is included all the resources are ready to go and you just need to specify which models and events to audit. Use AuditsTrait to add support to any models you would like tracked:

Then specify which events you want audited by assigning the corresponding audit methods for those events in the constructor (or initialize()):

The Audits library will create basic logs of each event in the audits table, for example:

id source source_id user_id event summary data created_at
10 sites 27 9 create 2 fields: name, phone (NULL) 2024-04-05 15:58:40
11 jobs 11 8 update 1 fields: description (NULL) 2024-04-05 16:01:35

If you want to log arbitrary data you can use the logEvent static method anywhere in your code:

The library will record the data (as json) in the audits table with the class and method names that called it, for example:

id source source_id user_id event summary data created_at
12 App\Controllers\User\Profile 0 2 update Profile data changed {"name":"John Doe"} 2024-04-06 10:59:01
13 App\Controllers\Login 0 3 action User Logged in {"user":"Foo Bar","email":"[email protected]"} 2024-04-06 11:00:05

All versions of ci4-audits with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bgeneto/ci4-audits contains the following files

Loading the files please wait ....