Download the PHP package east/laravel-activityfeed without Composer
On this page you can find all versions of the php package east/laravel-activityfeed. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download east/laravel-activityfeed
More information about east/laravel-activityfeed
Files in east/laravel-activityfeed
Package laravel-activityfeed
Short Description Your Package Description here
License MIT
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 laravel-activityfeed
laravel-activityfeed
[
]()
Install
It is strongly recommended to have Laravel Backpack Pro version installed (https://backpackforlaravel.com/). The web interface for defining ruling and templates relies on Backpack and it will be hard to manage without it.
Important note about database
This extension relies heavily on users table and requires you to have a column called "admin". The users model is published to make it easier to edit columns and relationships if you have customised the database. Note though that
will overwrite your changes to thisAf model. So you can change this model to extend your existing user class.
Screenshots
Run installer
Usage
Available command line commands
This will create a rule templates and corresponding template entries based on your entire database structure. Running it again will not overwrite anything, but will add any tables that were not there before.
Template, rule etc. handling interfaces is based on Laravel Backpack. It's not included with the ActivityFeed package.
Individual notifications
Best way to use ActivityFeed is to extend your base model with ActivityFeedBaseModel. This allows the rules to hook into database events directly based on the rules that are tied to database tables. You can also create notification directly. You still need to have a rule for this purpose, as rule defines the template.
Model based triggering - rules
Rules are tied to events in particular database tables and include the following options:
- Table name
- Event (create, update, delete)
- If it's update, which column will trigger the update
- Change (any, based on rules)
- Column name
- Operator
- Value
In addition, you can create custom rules with PHP code. These go under app/ActivityFeed/Rules/. When you do the install, an example rule will be put in place.
Creators
In addition to manually defined rules that take care of the saving, you can also use a custom save class - these are called creators. The creators go under app/ActivityFeed/Creators/. When you do the install, an example creator will be put in place.
Targeting
Target should always be an individual user, regardless of whether it's shown on a feed or sent via some other channel(s). In addition target can be admin users. Whether a particular notification
This is where it gets slightly complicated. Let's say a database record modification/creation in Posts launches a notification event that should be targeted at certain group of users. Example database structure:
As pivot records don't exist when creating the Posts, we will save this event to be created as a notification by the cron job. The difficult part is on mapping the relationship chain.
Templating
Templates are in Laravel Blade format and saved to database. Templates are fed with var replacement and data replacement. Idea is that you can dump data from your database record and it's relations directly to the template. So you would define it like this:
So also this would work:
And this (provided you are sending the correct objects):
The variable replacement happens at save time and is "blind" so you should adjust your templates accordingly.
Rules define targeting and channels.
Forking / messing with the models
As I'm lazy, I've used the excellent model generator from krlove. You can use it like this (adjust paths obviously):
Rendering
Upon install we publish af.css to public css directory and it's included with the widgets. Alternatively you can copy it to resources/css/ and import it to your app.css. In this case make sure to set configuration option for not including the css with the widgets.
Include widgets
Available widgets:
- FeedWidget
- MenuWidget
- NotificationWidget
Understanding the flow
As pivot records don't exist when creating the Posts, we will save this event to be created as a notification by the cron job. The difficult part is on mapping the relationship chain.
Testing
Run the tests with:
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
License
The MIT License (MIT). Please see License File for more information.
