README

The WhosOnline plugin for CakePHP 3.0 (and the CakeManager) helps you to watch your registered users. You can see when they're logged in, last seen and more!

You are able to see the following:

Last login timestamp
Last seen timestamp
Total passed logins
Total failed logins
Total new password requests

The plugin is especially built for theCakeManager Plugin but is also easy to use without the CakeManager. Read below to change the current events, so you can customize it.

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require cakemanager/cakephp-whosonline

Configuration

You will need to add the following line to your application's bootstrap.php file:

Plugin::load('WhosOnline', ['bootstrap' => true, 'routes' => true]);

Note: You don't need to load the routes if you are not using the CakeManager Plugin.

Usage

Component

Add the following to your AppController to use the plugin-callbacks:

$this->loadComponent('WhosOnline.WhosOnline', []);

Options for the component:

userId - Path to the users id in the session
userModel - The model of the users. Default CakeManager.Users
usermetasModel - The model of the usermetas. Default WhosOnline.Usermetas
lastSeen - Boolean if we should save the lastSeen-status. Default true
lastLogin - Boolean if we should save the lastLogin-status. Default true
passedLogins - Boolean if we should save the passedLogins-status. Default true
failedLogins - Boolean if we should save the failedLogins-status. Default true
passwordRequests - Boolean if we should save the passwordRequests-status. Default true
events - Array with all events to use custom events.
- lastSeen - Event for when the users is last seen. Default Component.Manager.beforeFilter
- passwordRequests - Event for when an user requests a new password. Default Controller.Users.afterForgotPassword
- passedLogin - Event for a passed login. Default Controller.Users.afterLogin
- failedLogin - Event for a failed login. Default Controller.Users.afterInvalidLogin

Note: Via the events configurations you can customize the events for your own application!

Example:

$this->loadComponent('WhosOnline.WhosOnline', [
  'lastSeen' => true,
  'failedLogins' => false,
  'events.lastSeen' => 'Controller.Users.customAfterLogin'
]);

From now on the component will save all statuses automatically!

Watching

If you want to watch the usermetas, watch the menu-item "Who Is Online" and click on it. You will see a list of recent online users and its data.

Support

CakeManager Website - Website of the CakeManager Team. Here you can find everything about us and our plugins.
Gitter - Chat Tool for GitHub to talk about issues and new features.
GitHub - When there's something wrong, please open a new issue!
CakeManager Docs - Documentation about the CakeManager Plugin.

Contributing

If you have a good idea for a new feature, feel free to pull or open a new issue. Pull requests are always more than welcome.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

cakemanager / cakephp-whosonline

Maintainers

Details