Download the PHP package oi-lab/oi-laravel-notes without Composer
On this page you can find all versions of the php package oi-lab/oi-laravel-notes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oi-lab/oi-laravel-notes
More information about oi-lab/oi-laravel-notes
Files in oi-lab/oi-laravel-notes
Package oi-laravel-notes
Short Description Polymorphic notes with attachments for Laravel applications
License MIT
Informations about the package oi-laravel-notes
OI Laravel Notes BETA
A Laravel package for polymorphic notes. Attach notes to any Eloquent model, author them with a user,
flag machine-generated notes, and attach files to them — built on top of oi-laravel-attachments.
Features
- Polymorphic Notes: Annotate any model via a single
HasNotestrait - Authored & Bot Notes: Optional author plus a
has_botflag for system-generated notes - File Attachments: Notes are attachable — attach files via
oi-laravel-attachments - Validation: A ready-made
NoteRequestform request with configurable file limits - Configurable Models: Swap in your own
Noteor user model subclasses - UUIDs & Soft Deletes: Every note has a unique
uuidand is soft-deletable
How It Works
The package revolves around a single Note model attached polymorphically to a notable parent. Host
models opt in with the HasNotes trait, which exposes a notes() relationship. The Note model itself
uses the HasAttachments trait, so any note can carry files. All package internals resolve model classes
through the OiNotes resolver, so you can override the Note or user model from config without touching
package code.
Requirements
- PHP 8.2+
- Laravel 11.0+, 12.0+, or 13.0+
oi-lab/oi-laravel-attachments^1.0
Installation
The package auto-discovers and registers its service provider — no manual registration required.
Local Development
For local development inside the monorepo, add a path repository to your main project's composer.json:
Then:
Publish & Migrate
Publish the migrations (and optionally the config) and run them:
This creates the notes table.
Configuration
The config file config/oi-laravel-notes.php exposes the following options:
Usage
Make a Model Notable
Add the HasNotes trait to any model:
Create & Read Notes
Bot / System Notes
Attach Files to a Note
A Note is attachable via oi-laravel-attachments:
Validating Input
OiLab\OiLaravelNotes\Http\Requests\NoteRequest validates the message and uploaded files against the
configured limits. Use it directly in a controller or extend it for your own rules.
Overriding the Note Model
Resolve models through OiNotes so your overrides apply everywhere:
AI Assistant Skills
Install Claude Code / JetBrains Junie skill files and a CLAUDE.md rules section into your app:
Testing
License
The MIT License (MIT). Please see the License File for more information.
Credits
Olivier Lacombe - Creator and maintainer
Olivier is a Product & Technology Director based in Montpellier, France, with over 20 years of experience innovating in UX/UI and emerging technologies. He specializes in guiding enterprises toward cutting-edge digital solutions, combining user-centered design with continuous optimization and artificial intelligence integration.
Projects & Resources:
- OI Dev Docs - Documentation for all Open Source OI Lab packages
- OnAI - Training courses and masterclasses on generative AI for businesses
- Promptr - Prompt engineering Management Platform
Support
For support, please open an issue on the GitHub repository.
All versions of oi-laravel-notes with dependencies
illuminate/contracts Version ^11.0|^12.0|^13.0
illuminate/database Version ^11.0|^12.0|^13.0
illuminate/http Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0
oi-lab/oi-laravel-attachments Version ^1.0
spatie/laravel-data Version ^4.0