Download the PHP package dewsign/pusher-agent without Composer
On this page you can find all versions of the php package dewsign/pusher-agent. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dewsign/pusher-agent
More information about dewsign/pusher-agent
Files in dewsign/pusher-agent
Package pusher-agent
Short Description Vuex/Axios/Pusher store to enable SPAs to work with remote data without needing to interact with Ajax
License GPL-3.0
Informations about the package pusher-agent
AJAX Vuex Store
Authors:
- Marco Mark
- Sam Wrigley
Overview
A namespaced Vuex store module that makes use of AJAX to get and update the store's data from the given API end-point.
Usage
To use the AJAX Vuex store in your application, start by extending the AjaxStore
class from your own store class, such as below:
You can specify the AJAX request 'action' and 'method' when calling the parent class' constructor.
Import your newly created namespaced store module into your Vuex store, for example:
To get data from the namespaced Vuex store (or to update it) in your Vue component, you can make use of the Vuex mapGetters
and mapActions
helper methods. Below is an example implementation of a Vue component that checks if the namespaced Vuex store contains any items during the created
lifecycle hook. If the store contains no items, then the updateItems
action is dispatched to get the items from the given API end-point specified in your namespaced store module using AJAX.
PusherAgent for Laravel Echo with Pusher
The agent will listen for any updates from the api and commit them into the current state to ensure all connected clients are in-sync and remove the need for regular ajax calls to fetch the latest data.
IMPORTANT: The agent will automatically listen to private
pusher channels with the same name as the Vuex Store Module defined earlier. In this case example
(private-example
). This should also match the name of your Laravel Model class.
When creating your root Vue instance, add the PusherAgent plugin and mixin.
Gotchas
The BroadcastsPusherEvents
trait will set the wasRecentlyCreated
property of a model to false after the first saved
event hook. This means that a new model can be instanciated with create()
which fires a save
event and any further saves on the model will be treated as an update. This is useful when associating many-to-many relations with the model which require the model to be present in the database.