Download the PHP package kanvigo/audit-contracts without Composer
On this page you can find all versions of the php package kanvigo/audit-contracts. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download kanvigo/audit-contracts
More information about kanvigo/audit-contracts
Files in kanvigo/audit-contracts
Download kanvigo/audit-contracts
More information about kanvigo/audit-contracts
Files in kanvigo/audit-contracts
Vendor kanvigo
Package audit-contracts
Short Description Stable contracts for Kanvigo's pluggable audit layer: the immutable AuditEvent DTO and the AuditSink interface third-party sinks implement.
License MIT
Homepage https://github.com/Fanmade/kanvigo-audit-contracts
Package audit-contracts
Short Description Stable contracts for Kanvigo's pluggable audit layer: the immutable AuditEvent DTO and the AuditSink interface third-party sinks implement.
License MIT
Homepage https://github.com/Fanmade/kanvigo-audit-contracts
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:
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.
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?
Informations about the package audit-contracts
kanvigo/audit-contracts
Stable contracts for Kanvigo's pluggable audit layer. Both the Kanvigo core and every audit sink — official (e.g. the Chronicle bridge) or third-party — depend only on this tiny package, so sinks can be developed and versioned independently of the application (the PSR-3 / Flysystem-adapter pattern).
The contract
AuditEvent— the immutable DTO for a single audited action:action,category,subject{type,id},actorId(null = system actor),metadata[],tags[],context{source, ip, userAgent, tokenName},occurredAt. Explicitly serializable viatoArray()/fromArray()with a versioned (v) schema.AuditSink— what you implement:accepts(AuditEvent): bool(the taxonomy filter),record(AuditEvent): void,policy(): SinkPolicy.SinkPolicy— how a sink runs:sync()(inline, after commit, failures isolated),queued()(shipped by the outbox drain worker, at-least-once),failClosed()(synchronous, pre-commit, inside the domain transaction — a failure aborts the action). Queued + fail-closed is impossible by construction.AuditCategory— Content · Authn · Authz · Token · Security. The canonical event → category table lives in the enum's docblock.AuditSource— Ui · Mcp · Api · Queue · System.Exceptions\AuditIntegrityException— thrown by the emitting application when a fail-closed sink's guarantee cannot be honored (audited mutation outside a transaction).
Implementing a sink
Register the class in the application's config/audit.php sinks list — done. Sinks run
alongside each other; each receives every event it accepts.
Stability & versioning
This package follows semver with an additive-only policy inside a major version:
AuditEventfields and array-schema keys are only ever added, never renamed, retyped or removed. Thevkey identifies the schema generation.- Enum cases are only added. Sinks must tolerate (ignore or generically handle) actions, categories and sources they don't know.
- The
AuditSinkinterface gains no new required methods within a major version.
All versions of audit-contracts with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.4
The package kanvigo/audit-contracts contains the following files
Loading the files please wait ...