Download the PHP package gmory/laranotes without Composer
On this page you can find all versions of the php package gmory/laranotes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package laranotes
LaraNotes
A package for laravel that allows you to attach notes to any model of your choosing. This is particularly helpful when you want to add a snippet of information to any of your models.
Use Cases
Some use cases include:
- Noting models with readable messages related to exceptions.
- Noting user log-on/off times.
- Noting an article with the last user to edit it.
Installation
Use Composer to install the package.
-
You can do this by running:
-
Add the service provider to your
config/app.phpfile: - Add the Facade to your
config/app.phpfile:
Usage
Setup Relationships with NotesTrait
First place the NotesTrait on each of the models you wish to attach notes to. This will give those models the appropriate relationships to access their notes.
Adding Notes
To add a note, specify what model you want the note attached to by using attach($model), followed by the note($content, [$unique]) method:
You can specify to only add the note if it's unique (ensuring that you don't add a duplicate identical note) by passing true as the second argument in the note() method.
You can make a note regard a secondary model with regarding($model). This is useful when you want a note attached to a particular model, but you want to know what the note is referencing.
Deleting Notes
You can delete all old notes associated with a model when creating a new note with deleteOld([$attachedToModel], [$regardingModel], [$onlyThoseBelongingToBoth], [$content]).
You must include either an $attachedToModel or a $regardingModel for this function to delete any notes.
You can further expand on the deleting capability by signifying that you only want to delete notes with both the $attachedTo model and the $regardingModel, and/or by specifying the exact $content of the notes you want to delete.
Delete all notes attached to $user
Delete all notes regarding $post
Delete all notes attached to $user and all notes regarding $post
Delete only notes both attached to $user and regarding $post
Delete only notes both attached to $user and regarding $post that have a content of 'User authored a new post'
Retrieving Notes
To retrieve notes from a particular model, you can call the notes() relationship that the NotesTrait granted it.
To retrieve any notes that are regarding a particular model, you can call the regardedBy() relationship that the NotesTrait granted it.
Note Properties
To return a note's content, call the content attribute
To return the model the note is attached to, use the noting relationship
To return the model the note is regarding, use the regarding relationship
License
MIT
