feat(releases): Elgg 3 rewrite

README.md

@@ -1,134 +1,62 @@
-Group Subtypes for Elgg
-=======================
-![Elgg 2.0](https://img.shields.io/badge/Elgg-2.0.x-orange.svg?style=flat-square)
+hypeGroups
+==========
+![Elgg 3.0](https://img.shields.io/badge/Elgg-3.0-orange.svg?style=flat-square)
 
 ## Features
 
- * API for introducing new group subtypes
- * A tool for upgrading existing groups to one of the introduced subtypes
- * Admin interface for configuring root level and subgroup subtypes
- * Admin interface for creating groups with fixed tool presets
+* Extended search and sort functionality
+* API to add new group subtypes
+* API to manage group hierarchies
+* API for managing group fields
+* API for restricting group tools, as well as using preset tools
 
-![Group Subtypes](https://raw.github.com/hypeJunction/Elgg-group_subtypes/master/screenshots/group_subtypes.png "Admin Interface for managing group subtypes")
+## Notes
 
-## Description
+### Subtypes
 
-The plugin provides high level hooks and some preliminary UI for introducing group subtypes,
-spreading out groups across multiple page handlers, using context specific language strings etc.
-The plugin does not provide actual translations, and does not change existing resource views -
-those are done in sister plugins (group_lists, group_membership, group_profiles).
+Registering new subtypes and configuring them is made easy.
 
-Please note that the plugin overwrites some of the group views, which are commonly
-overwritten by other plugins (e.g. group_tools), so you may need to integrate them if you rely
-on both functionalities.
-
-## Usage
-
-### Hooks
-
- * `'list_subtypes',$identifier` - filters group subtypes to be displayed on an `$identifier` page
- * `'page_identifier',"$type:$subtype"` - filter the route page identifier for a group of given type and subtype
- * `'permissions_check:parent','group'` - filter the permission for a parent entity to have the group as a child
-
-### Translations
-
-Once you set up the subtypes, there will be numerous untranslated language keys. I am yet to write a plugin to automate the process.
-In the meantime, you can do the following:
-
-1. Create a new plugin for your translations
-2. Add your language files to `/languages/`, e.g. `/languages/en.php`
-3. Add translations 2 translations for each subtype, e.e. if your subtype is school:
+Here is an example of how to remove groups from the top level of the site, and making them subgroups of a new subtype called classroom.
 
 ```php
-// /languages/en.php
-return [
-	'group:school' => 'School',
-	'item:group:school' => 'Schools',
-];
-```
-
-4. In your `start.php`, add the following:
-
-```php
-elgg_register_event_handler('ready', 'system', 'group_subtypes_register_translations');
-
-/**
- * Use groups plugin translations for group subtypes
- * @global type $GLOBALS
- */
-function group_subtypes_register_translations() {
-
-	global $GLOBALS;
-
-	$conf = group_subtypes_get_config();
-	$identifiers = array();
-	foreach ($conf as $subtype => $options) {
-		$identifier = elgg_extract('identifier', $options);
-		if ($identifier && $identifier !== 'groups') {
-			$identifiers[$subtype] = $identifier;
-		}
-	}
-
-	$languages = array_keys(get_installed_translations());
-
-	foreach ($languages as $language) {
-		$translations = $GLOBALS['_ELGG']->translations[$language];
-
-		$to_translate = array();
-		if (file_exists(__DIR__ . "/languages/$language.php")) {
-			$to_translate = include_once __DIR__ . "/languages/$language.php";
-		}
-
-		$original_str = $translations["groups:group"];
-		$original_str_plural = $translations["groups"];
-
-		foreach ($identifiers as $subtype => $identifier) {
-
-			$subtype_str = $original_str;
-			if (isset($translations["group:$subtype"])) {
-				$subtype_str = $translations["group:$subtype"];
-			}
-			$to_translate["group:$subtype"] = $subtype_str;
-
-			$subtype_str_plural = $original_str_plural;
-			if (isset($translations["item:group:$subtype"])) {
-				$subtype_str_plural = $translations["item:group:$subtype"];
-			}
-			$to_translate["item:group:$subtype"] = $subtype_str_plural;
-
-			foreach ($translations as $key => $translation) {
-				$identifier_key = preg_replace("/^(groups)/", $identifier, $key);
-				if ($identifier_key == $key) {
-					continue;
-				}
-				if (!empty($translations[$identifier_key])) {
-					continue;
-				}
-
-				$translation = str_replace(strtolower($original_str), strtolower($subtype_str), $translation);
-				$translation = str_replace(ucfirst($original_str), ucfirst($subtype_str), $translation);
-
-				$translation = str_replace(strtolower($original_str_plural), strtolower($subtype_str_plural), $translation);
-				$translation = str_replace(ucfirst($original_str_plural), ucfirst($subtype_str_plural), $translation);
 
-				$to_translate[$identifier_key] = $translation;
-			}
-		}
+		$svc = elgg()->groups;
+		/* @var $svc \hypeJunction\Groups\GroupsService */
+
+		$svc->registerSubtype('classroom', [
+			'labels' => [
+				'en' => [
+					'item' => 'Classroom',
+					'collection' => 'Classrooms',
+				],
+			],
+			'root' => true,
+			'identifier' => 'classrooms',
+			'class' => \CustomPlugin\Classroom::class,
+			'collections' => [
+				'all' => \CustomPlugin\DefaultClassroomCollection::class,
+				'owner' => \CustomPlugin\OwnedClassroomCollection::class,
+				'member' => \CustomPlugin\JoinedClassroomCollection::class,
+			],
+		]);
+
+		$svc->registerSubtype('group', [
+			'site_menu' => false,
+			'labels' => [
+				'en' => [
+					'item' => 'Group',
+					'collection' => 'Groups',
+				],
+			],
+			'root' => false,
+			'parents' => ['classroom'],
+			'identifier' => 'groups',
+		]);
 
-		$file = fopen(__DIR__ . "/languages/$language.php", 'w');
-		$contents = var_export($to_translate, true);
-		fwrite($file, "<?php\r\n\r\nreturn $contents;\r\n");
-		fclose($file);
-	}
-}
 ```
 
-5. Load the website
-6. You will now see new language files in `/languages/`, e.g. `/languages/en.schools.php`
-7. Edit the new files to your needs. You don't need to copy anything, these files will be loaded like other translation files.
-8. Remove all the code from `start.php`, as you don't want to run that code all the time
-9. Flush the caches and enjoy!
+You can put multiple subtypes into a collection by assigning them to the same `identifier`, e.g. you could create `usa_state` and `canada_province` subtypes and register them for `regions` identifier.
 
-## Acknowledgements
+### Fields
 
-This plugin has been sponsored by [IvyTies.com](http://www.ivyties.com) - a social network platform for college admissions
+Fields are managed by hypePost. Please see the documentation there for more information.

autoloader.php

@@ -4,4 +4,4 @@
 if (file_exists("{$plugin_root}/vendor/autoload.php")) {
 	// check if composer dependencies are distributed with the plugin
 	require_once "{$plugin_root}/vendor/autoload.php";
-}
+}

classes/hypeJunction/Groups/CollectionTabs.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace hypeJunction\Groups;
+
+use Elgg\Hook;
+use hypeJunction\Lists\Collection;
+use hypeJunction\Lists\CollectionInterface;
+
+class CollectionTabs {
+
+	/**
+	 * @elgg_plugin_hook register menu:filter:collection/all
+	 *
+	 * @param Hook $hook
+	 *
+	 * @return mixed|null
+	 */
+	public function __invoke(Hook $hook) {
+
+		$collection = $hook->getParam('collection');
+
+		if (!$collection instanceof DefaultGroupCollection || !in_array($collection->getCollectionType(), ['all', 'member'])) {
+			return null;
+		}
+
+		if ($collection->getCollectionType() === 'member' && $collection->getTarget()->guid != elgg_get_logged_in_user_guid()) {
+			return null;
+		}
+
+		return elgg_trigger_plugin_hook('register', 'menu:filter:groups/all', $hook->getParams(), $hook->getValue());
+	}
+}

classes/hypeJunction/Groups/ConfigureContainerPermissions.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace hypeJunction\Groups;
+
+use Elgg\Hook;
+
+class ConfigureContainerPermissions {
+
+	/**
+	 * Restrict group creation
+	 *
+	 * @param Hook $hook Hook
+	 *
+	 * @return bool
+	 */
+	public function __invoke(Hook $hook) {
+		if (elgg_get_plugin_setting('limited_groups', 'groups') && !elgg_is_admin_logged_in()) {
+			return false;
+		}
+	}
+}

classes/hypeJunction/Groups/ConfigureEditPermissions.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace hypeJunction\Groups;
+
+use Elgg\Hook;
+
+class ConfigureEditPermissions {
+
+	/**
+	 * Setup group edit permissions
+	 *
+	 * @param Hook $hook Hook
+	 *
+	 * @return bool
+	 */
+	public function __invoke(Hook $hook) {
+
+		$group = $hook->getEntityParam();
+		$user = $hook->getUserParam();
+
+		if (!$group instanceof \ElggGroup || $user instanceof \ElggUser) {
+			return null;
+		}
+
+		if (check_entity_relationship($user->guid, 'group_admin', $group->guid)) {
+			return true;
+		}
+	}
+}