saidabdulsalam/laravel-memo

There is no license information available for the latest version (dev-main) of this package.

A Laravel package for managing memos

dev-main 2025-08-19 06:42 UTC

Requires

• php: ^8.0
• illuminate/support: ^11.0

Requires (Dev)

• orchestra/testbench: ^9.0
• phpunit/phpunit: ^10.0

Unknown License

• Said Abdulsalam

README

A configurable Laravel package for managing memos, designed to be integrated into existing Laravel applications.

Table of Contents

• Installation
• Configuration
• API Endpoints
• Events

Installation

Install the package using Composer:

composer require saidabdulsalam/laravel-memo

Publish the configuration file:

php artisan vendor:publish --tag=memo-config

Run the database migrations:

php artisan migrate

Configuration

The configuration file (config/memo.php) allows you to customize the package to fit your application's needs.

Option	Type	Default	Description
pagination_length	Integer	15	The number of memos to display per page.
members_models	Array	[App\User::class]	An array of models to be used for users/members.
office_model	Array	[App\Office::class]	The model to be used for offices.
name	Array	['full_name']	The column name(s) to be used for the user's full name.
department_model	String	App\Models\Department::class	The model to be used for departments.
role_column_name	String	'role_id'	The column name on the user model that stores the user's role.
user_department_id_column	String	'department_id'	The column name on the user model that stores the user's department ID.
user_office_id_column	String	'office_id'	The column name on the user model that stores the user's office ID.
members_models_filters	Array	null	An array of filters to apply when fetching members (e.g., [['type' => 'staff']]).
load_routes	Boolean	true	Whether to load the package's routes automatically.

Load Routes with Helper

To load the routes automatically, you can use the memoRoutes() helper function:

memoRoutes();

API Endpoints

All endpoints are prefixed with /memo.

Method	URI	Action	Description
GET	/boot	boot	Fetches initial data for the frontend.
GET	/all	index	Fetches a paginated list of memos.
POST	/	createOrUpdateMemo	Creates or updates a memo.
GET	/statuses	memoStatus	Fetches the available memo statuses.
GET	/types	memoTypes	Fetches the available memo types.
GET	/members	members	Fetches the list of members/users.
POST	/reject	rejectMemo	Rejects a memo.
POST	/approve	approveMemo	Approves a memo.
POST	/make_comment	saveComment	Adds a comment to a memo.
PUT	/comment/{id}	updateComment	Updates a comment.
DELETE	/comment/{id}	deleteComment	Deletes a comment.
GET	/departments	departments	Fetches the list of departments.
DELETE	/{id}	deleteMemo	Deletes a memo.

Events

The package fires the following events:

• MemoApproved
• MemoComment
• MemoCreated
• MemoRejected
• MemoUpdated