Overview and General Docs

#User Extended

Overview

User Extended provides simple components and User Utility functions for complex interactions with users.

User Extended currently offers friends lists, role management, and User Utilities.

User Extended is typically a dependency to my other plugins.

Dependencies

• RainLab.User http://octobercms.com/plugin/rainlab-user https://github.com/rainlab/user-plugin
• [Optional. Only required for some features] Clake.DataStructures http://octobercms.com/plugin/clake-datastructures https://github.com/ShawnClake/DataStructures-Plugin

Installation

Install this plugin and run php artisan october:up

Usage

• Just add the components you require to a page and everything should work out of the box
• You can create modules to interact with User Extended and other UE modules

Check out the bug tracker and feature planner

Feature List

• Frontend role/group management
• Advanced page restriction using groups
• Friends lists. You can send friend requests, and block/delete/accept friends
• User Utility functions which can be used accross your own plugins
• User profiles and a profile comment system
• User search. Search for users by name, email or username
• Timezone support! Use the '|timezonify' twig filter
• Timezonable trait which can be added to models to automagically convert times
• Backend user role/group management
• Extensible modules

Planned Features

Check out the feature planner

Roadmap

View our road map

Details

User Extended is not trying to be a social network plugin. We are providing functionality for more complex user functions which have use cases outside of social networks.

Websites specializing in online games, forums, blogs, news etc. can all benefit from User Extended.

Event List

• clake.ue.preregistration(post &$data) : halted. $data contains registration form data. Returning false will cancel registration.
• clake.ue.postregistration(UserExtended &$user). $user contains the final user object before saving it and logging out the user to finalize registration.
• clake.ue.login(User $user). $user contains the user object after authenticating.
• clake.ue.logout(User $user). $user contains the user object after logging out.
• clake.ue.settings.create(UserSettingsManager &$instance). After the user settings instance object has been created
• clake.ue.settings.update(UserSettingsManager &$instance). After the user settings instance object has been created