-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(releases): now requires Elgg 2.2
BREAKING CHANGE Now requires Elgg 2.2
- Loading branch information
1 parent
b3fa686
commit 5057cd7
Showing
6 changed files
with
31 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,52 @@ | ||
hypeInbox | ||
=========== | ||
![Elgg 2.1](https://img.shields.io/badge/Elgg-2.1.x-orange.svg?style=flat-square) | ||
![Elgg 2.2](https://img.shields.io/badge/Elgg-2.2-orange.svg?style=flat-square) | ||
|
||
Enhanced inbox and user-to-user messaging for Elgg | ||
Enhanced messaging for Elgg | ||
|
||
## Features ## | ||
## Features | ||
|
||
* Define new message types and messaging rules (based on sender and recipient roles and relationships) | ||
* Multiple inboxes for private messages, notifications and custom message types | ||
* Multiple inboxes for private messages and custom message types | ||
* Message threading - messages are grouped based on message title and recipients | ||
* Multi-user threads | ||
* Message attachments (requires elgg_dropzone https://github.com/hypeJunction/elgg_dropzone) | ||
* Policing includes user roles integration with hypeApprove and roles (extendable via hooks) | ||
* Real-time updates | ||
* Message attachments (requires hypeAttachments) | ||
* Integration with hypeApprove and ArckInteractive's roles (extendable via hooks) | ||
|
||
## Screenshots ## | ||
## Screenshots | ||
|
||
![alt text](https://raw.github.com/hypeJunction/hypeInbox/master/screenshots/compose.png "Compose") | ||
![alt text](https://raw.github.com/hypeJunction/hypeInbox/master/screenshots/inbox.png "Inbox") | ||
|
||
## Attributions / Credits ## | ||
## Acknowledgements | ||
|
||
* Plugin is inspired and partially sponsored by Whitemoor School | ||
|
||
## Usage / Configuration ## | ||
## Usage / Configuration | ||
|
||
The plugin allows you to define new types of communication between users. To configure new message types, | ||
you can use recipient roles, sender roles and relationships between them | ||
|
||
For example, if you would like to allow users to send 'homework' to their supervisors, | ||
you would use the following configuration: | ||
Sender type: Any user | ||
Recipient type: Supervisor | ||
Relationship: Supervisor | ||
Inverse relationship: yes | ||
Group relationship: --blank-- | ||
For example, if you would like to allow users to send 'homework' to their supervisors, you would use the following configuration: | ||
|
||
Another example, if you would like to allow Editors to send 'notices' to Administrators, you would use the following: | ||
Sender type: Editor | ||
Recipient type: Administrator | ||
Relationship: --blank-- | ||
Inverse relationship: --blank-- | ||
Group relationship: --blank-- | ||
* Sender type: Any user | ||
* Recipient type: Supervisor | ||
* Relationship: Supervisor | ||
* Inverse relationship: yes | ||
* Group relationship: --blank-- | ||
|
||
Another example, if you would like to allow Group exchange between members of the same group, you would use the following: | ||
Sender: Any user | ||
Recipient: Any user | ||
Relationship: --blank-- | ||
Inverse relationship: --blank-- | ||
Group relationship: member | ||
If you would like to allow Editors to send 'notices' to Administrators, you would use the following: | ||
|
||
## Upgrades | ||
* Sender type: Editor | ||
* Recipient type: Administrator | ||
* Relationship: --blank-- | ||
* Inverse relationship: --blank-- | ||
* Group relationship: --blank-- | ||
|
||
### Upgrading to 3.1 | ||
If you would like to allow Group exchange between members of the same group, you would use the following: | ||
|
||
Focus of 3.1 is improved performance. As such, config values are no longer populated on each page load, | ||
if you were relying on ```elgg_get_config()``` for any of the following values: | ||
* inbox_message_types | ||
* inbox_user_types | ||
* inbox_user_relationships | ||
* inbox_user_group_relationships | ||
|
||
replace them correspondingly with: | ||
* ```hypeInbox()->config->getMessageTypes()``` | ||
* ```hypeInbox()->config->getUserTypes()``` | ||
* ```hypeInbox()->config->getUserRelationships();``` | ||
* ```hypeInbox()->config->getUserGroupRelationships()``` | ||
* Sender: Any user | ||
* Recipient: Any user | ||
* Relationship: --blank-- | ||
* Inverse relationship: --blank-- | ||
* Group relationship: member |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
![Elgg 2.1](https://img.shields.io/badge/Elgg-2.1.x-orange.svg?style=flat-square) | ||
![Elgg 2.2](https://img.shields.io/badge/Elgg-2.2-orange.svg?style=flat-square) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters