Skip to content

Commit

Permalink
feat(releases): now requires Elgg 2.2
Browse files Browse the repository at this point in the history
BREAKING CHANGE
Now requires Elgg 2.2
  • Loading branch information
hypeJunction committed Sep 22, 2016
1 parent b3fa686 commit 5057cd7
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 50 deletions.
71 changes: 28 additions & 43 deletions README.md
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
5 changes: 2 additions & 3 deletions manifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@

<author>Ismayil Khayredinov (ismayil.khayredinov@gmail.com)</author>
<website>http://hypeJunction.com</website>
<copyright>2011-2014 (c) Ismayil Khayredinov</copyright>
<copyright>2011-2016 (c) Ismayil Khayredinov</copyright>
<license>GNU Public License version 2</license>

<requires>
<type>elgg_release</type>
<version>2.1</version>
<version>2.2</version>
</requires>

<requires>
Expand Down Expand Up @@ -53,6 +53,5 @@
<type>plugin</type>
<name>hypeGraph</name>
</suggests>


</plugin_manifest>
2 changes: 1 addition & 1 deletion release.md
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)
Binary file modified screenshots/compose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshots/inbox.png
Binary file not shown.
3 changes: 0 additions & 3 deletions start.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
/**
* Enhanced inbox for Elgg
*
* @package hypeJunction
* @subpackage hypeInbox
*
* @author Ismayil Khayredinov <info@hypejunction.com>
*/
require_once __DIR__ . '/autoloader.php';
Expand Down

0 comments on commit 5057cd7

Please sign in to comment.