Download the PHP package prolix/entity-audit-bundle without Composer

On this page you can find all versions of the php package prolix/entity-audit-bundle. 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 prolix/entity-audit-bundle

Informations about the package entity-audit-bundle

EntityAudit Extension for Doctrine2

Master 1.0 Branch
Build Status Build Status
documentation documentation

WARNING: Master isn't stable yet and it might not be working! Please use version ^1.0 and this documentation: https://github.com/simplethings/EntityAudit/blob/1.0/README.md

This extension for Doctrine 2 is inspired by Hibernate Envers and allows full versioning of entities and their associations.

Is this library still maintained?

Maybe? - please discuss and support us in the linked issue

How does it work?

There are a bunch of different approaches to auditing or versioning of database tables. This extension creates a mirroring table for each audited entitys table that is suffixed with "_audit". Besides all the columns of the audited entity there are two additional fields:

The global revision table contains an id, timestamp, username and change comment field.

With this approach it is possible to version an application with its changes to associations at the particular points in time.

This extension hooks into the SchemaTool generation process so that it will automatically create the necessary DDL statements for your audited entities.

Installation (Standalone)

Installing the lib/bundle

Simply run assuming you have installed composer.phar or composer binary:

For standalone usage you have to pass the EntityManager.

Installation (In Symfony2 Application)

Enable the bundle

Enable the bundle in the kernel:

Configuration

You can configure the audited tables.

app/config/config.yml

Creating new tables

Call the command below to see the new tables in the update schema queue.

Usage

Define auditable entities

You need add Auditable annotation for the entities which you want to auditable.

You can also ignore fields in an specific entity.

Use AuditReader

Querying the auditing information is done using a SimpleThings\EntityAudit\AuditReader instance.

In a standalone application you can create the audit reader from the audit manager:

In Symfony2 the AuditReader is registered as the service "simplethings_entityaudit.reader":

Find entity state at a particular revision

This command also returns the state of the entity at the given revision, even if the last change to that entity was made in a revision before the given one:

Instances created through AuditReader#find() are NOT injected into the EntityManagers UnitOfWork, they need to be merged into the EntityManager if it should be reattached to the persistence context in that old version.

Find Revision History of an audited entity

A revision has the following API:

Find Changed Entities at a specific revision

A changed entity has the API:

Find Current Revision of an audited Entity

Setting the Current Username

Each revision automatically saves the username that changes it. For this to work, the username must be resolved.

In the Symfony2 web context the username is resolved from the one in the current security context token.

You can override this with your own behaviour by configuring the username_callable service in the bundle configuration. Your custom service must be a callable and should return a string or null.

app/config/config.yml

In a standalone app or Symfony command you can username callable to a specific value using the AuditConfiguration.

Viewing auditing

A default Symfony2 controller is provided that gives basic viewing capabilities of audited data.

To use the controller, import the routing (don't forget to secure the prefix you set so that only appropriate users can get access)

app/config/routing.yml

This provides you with a few different routes:

TODOS

Supported DB

We can only really support the databases if we can test them via Travis.

Contributing

Please before commiting, run this command ./vendor/bin/php-cs-fixer fix --verbose to normalize the coding style.

If you already have the fixer locally you can run php-cs-fixer fix ..

All versions of entity-audit-bundle with dependencies

PHP Build Version
Package Version
Requires doctrine/dbal Version ~2.5
php Version ^5.3.9|~7.0
doctrine/orm Version ~2.4
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 prolix/entity-audit-bundle contains the following files

Loading the files please wait ....