cakemanager/cakephp-whosonline

WhosOnline plugin for CakePHP to check your users activity

WhosOnline plugin for CakePHP

The WhosOnline plugin for CakePHP 3.0 and the CakeManager helps you to watch your registered users. You are able to see the following:, _(*1)

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

Note that you need the CakeManager Plugin for this plugin!, _(*2)

Installation

You can install this plugin into your CakePHP application using composer., _(*3)

The recommended way to install composer packages is:, _(*4)

composer require cakemanager/cakephp-whosonline

Configuration

You will need to add the following line to your application's bootstrap.php file:, _(*5)

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

Next you need migrations to create the table for the plugin in your shell:, _(*6)

cake migrations migrate --plugin="WhosOnline"

Usage

Component

Add the following to your AppController to use the plugin-callbacks:, _(*7)

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

Options for the component:, _(*8)

• 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
• lastLogin - Boolean if we should save the lastLogin-status
• passedLogins - Boolean if we should save the passedLogins-status
• failedLogins - Boolean if we should save the failedLogins-status
• passwordRequests - Boolean if we should save the passwordRequests-status

All statuses are default set to true., _(*9)

Example:, _(*10)

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

From now on the component will save all statuses automatically!, _(*11)

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., _(*12)

Support

• CakeManager Website - Website of the CakeManager Team. Here you can find everything about us and our plugins., _(*13)

• Gitter - Chat Tool for GitHub to talk about issues and new features., _(*14)

• GitHub - When there's something wrong, please open a new issue!, _(*15)

• CakeManager Docs - Documentation about the CakeManager Plugin., _(*16)

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., _(*17)

License

The MIT License (MIT), _(*18)

Copyright (c) 2014 CakeManager by bobmulder, _(*19)

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:, _(*20)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., _(*21)

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., _(*22)