changed: updated for Elgg 6

.github/workflows/phpunit.yml

@@ -3,6 +3,8 @@ name: PHPUnit Plugin Tests
 on: [push, pull_request]
 
 jobs:
-  lint:
+  phpunit:
     name: Run PHPUnit test suites
     uses: ColdTrick/.github/.github/workflows/phpunit.yml@master
+    with:
+      elgg_major_version: 6

README.md

@@ -1,7 +1,7 @@
 Site announcements
 ==================
 
-![Elgg 5.1](https://img.shields.io/badge/Elgg-5.1-green.svg)
+![Elgg 6.0](https://img.shields.io/badge/Elgg-6.0-green.svg)
 ![Lint Checks](https://github.com/ColdTrick/site_announcements/actions/workflows/lint.yml/badge.svg?event=push)
 [![Latest Stable Version](https://poser.pugx.org/coldtrick/site_announcements/v/stable.svg)](https://packagist.org/packages/coldtrick/site_announcements)
 [![License](https://poser.pugx.org/coldtrick/site_announcements/license.svg)](https://packagist.org/packages/coldtrick/site_announcements)

classes/ColdTrick/SiteAnnouncements/Access.php

@@ -15,7 +15,6 @@ class Access {
 	 * @return null|array
 	 */
 	public static function userWriteCollections(\Elgg\Event $event): ?array {
-
 		$input_params = $event->getParam('input_params');
 		if (empty($input_params) || !is_array($input_params)) {
 			return null;

classes/ColdTrick/SiteAnnouncements/Cron.php

@@ -2,6 +2,8 @@
 
 namespace ColdTrick\SiteAnnouncements;
 
+use Elgg\I18n\DateTime;
+
 /**
  * Cron listener
  */
@@ -15,21 +17,21 @@ class Cron {
 	 * @return void
 	 */
 	public static function cleanupExpiredAnnouncements(\Elgg\Event $event): void {
-
 		$archive_cleanup = (int) elgg_get_plugin_setting('archive_cleanup', 'site_announcements');
 		if ($archive_cleanup < 1) {
 			return;
 		}
 
-		$time = (int) $event->getParam('time', time());
+		/* @var $dt DateTime */
+		$dt = $event->getParam('dt', new \DateTime());
 
 		$options = [
 			'type' => 'object',
 			'subtype' => \SiteAnnouncement::SUBTYPE,
 			'limit' => false,
 			'metadata_name_value_pairs' => [
 				'name' => 'enddate',
-				'value' => $time - ($archive_cleanup * 24 * 60 * 60),
+				'value' => $dt->modify("-{$archive_cleanup} days")->getTimestamp(),
 				'operand' => '<',
 				'type' => ELGG_VALUE_INTEGER,
 			],

classes/ColdTrick/SiteAnnouncements/Gatekeeper.php

@@ -32,7 +32,7 @@ public function __invoke(Request $request): void {
 	/**
 	 * Check if a user is an editor
 	 *
-	 * @param \ElggUser $user (optional) the user to check, defaults to loggedin user
+	 * @param null|\ElggUser $user (optional) the user to check, defaults to logged-in user
 	 *
 	 * @return bool
 	 */

classes/ColdTrick/SiteAnnouncements/Menus/AdminHeader.php

@@ -28,7 +28,6 @@ public static function register(\Elgg\Event $event): ?MenuItems {
 			'name' => 'site_announcements',
 			'text' => elgg_echo('site_announcements'),
 			'href' => elgg_generate_url('collection:object:site_announcement:all'),
-			'is_trusted' => true,
 			'parent_name' => 'administer',
 		]);
 

classes/ColdTrick/SiteAnnouncements/Menus/Filter.php

@@ -18,7 +18,6 @@ class Filter {
 	 * @return null|MenuItems
 	 */
 	public static function register(\Elgg\Event $event): ?MenuItems {
-
 		/* @var $returnvalue MenuItems */
 		$returnvalue = $event->getValue();
 
@@ -27,7 +26,6 @@ public static function register(\Elgg\Event $event): ?MenuItems {
 			'text' => elgg_echo('site_announcements:filter:active'),
 			'href' => elgg_generate_url('collection:object:site_announcement:all'),
 			'priority' => 100,
-			'is_trusted' => true,
 			'selected' => $event->getParam('filter_value') === 'all',
 		]);
 
@@ -36,7 +34,6 @@ public static function register(\Elgg\Event $event): ?MenuItems {
 			'text' => elgg_echo('site_announcements:filter:archive'),
 			'href' => elgg_generate_url('collection:object:site_announcement:archive'),
 			'priority' => 200,
-			'is_trusted' => true,
 		]);
 
 		if (Gatekeeper::isEditor()) {
@@ -45,15 +42,13 @@ public static function register(\Elgg\Event $event): ?MenuItems {
 				'text' => elgg_echo('site_announcements:filter:scheduled'),
 				'href' => elgg_generate_url('collection:object:site_announcement:scheduled'),
 				'priority' => 300,
-				'is_trusted' => true,
 			]);
 
 			$returnvalue[] = \ElggMenuItem::factory([
 				'name' => 'editors',
 				'text' => elgg_echo('site_announcements:filter:editors'),
 				'href' => elgg_generate_url('collection:object:site_announcement:editors'),
 				'priority' => 400,
-				'is_trusted' => true,
 			]);
 		}
 

classes/ColdTrick/SiteAnnouncements/Menus/Footer.php

@@ -25,7 +25,6 @@ public static function register(\Elgg\Event $event): ?MenuItems {
 			'icon' => 'bullhorn',
 			'text' => elgg_echo('site_announcements'),
 			'href' => elgg_generate_url('collection:object:site_announcement:all'),
-			'is_trusted' => true,
 		]);
 
 		return $returnvalue;

classes/ColdTrick/SiteAnnouncements/Menus/UserHover.php

@@ -18,7 +18,6 @@ class UserHover {
 	 * @return null|MenuItems
 	 */
 	public static function register(\Elgg\Event $event): ?MenuItems {
-
 		if (!elgg_is_admin_logged_in()) {
 			return null;
 		}

classes/ColdTrick/SiteAnnouncements/Seeder.php

@@ -48,6 +48,7 @@ public function seed() {
 
 			// undo some seeding stuff
 			unset($entity->title);
+			unset($entity->tags);
 
 			$this->advance();
 		}

classes/SiteAnnouncement.php

@@ -42,8 +42,7 @@ public function markAsRead(): bool {
 	 *
 	 * @return string
 	 */
-	public function getMessageTypeIconName() {
-
+	public function getMessageTypeIconName(): string {
 		switch ($this->announcement_type) {
 			case 'attention':
 				return 'exclamation-triangle';

composer.json

@@ -10,6 +10,6 @@
 		"issues": "https://github.com/ColdTrick/site_announcements/issues"
 	},
 	"conflict": {
-		"elgg/elgg": "<5.1"
+		"elgg/elgg": "<6.0"
 	}
 }

views/default/forms/site_announcements/edit.php

@@ -20,53 +20,57 @@
 	'value' => elgg_extract('description', $vars),
 ]);
 
-echo '<div>';
-echo '<label for="startdate">' . elgg_echo('site_announcements:edit:startdate') . '</label>';
-echo elgg_view('input/date', [
-	'name' => 'startdate',
-	'value' => elgg_extract('startdate', $vars),
-	'timestamp' => true,
-	'class' => 'mhs elgg-col-1of5',
-]);
-echo '@';
-echo elgg_view('input/select', [
-	'name' => 'starthour',
-	'value' => elgg_extract('starthour', $vars),
-	'options' => $hour_options,
-	'class' => 'mhs',
-]);
-echo ':';
-echo elgg_view('input/select', [
-	'name' => 'startmins',
-	'value' => elgg_extract('startmins', $vars),
-	'options' => $mins_options,
-	'class' => 'mls',
+echo elgg_view_field([
+	'#type' => 'fieldset',
+	'#label' => elgg_echo('site_announcements:edit:startdate'),
+	'align' => 'horizontal',
+	'fields' => [
+		[
+			'#type' => 'date',
+			'name' => 'startdate',
+			'value' => elgg_extract('startdate', $vars),
+			'timestamp' => true,
+		],
+		[
+			'#type' => 'select',
+			'name' => 'starthour',
+			'value' => elgg_extract('starthour', $vars),
+			'options' => $hour_options,
+		],
+		[
+			'#type' => 'select',
+			'name' => 'startmins',
+			'value' => elgg_extract('startmins', $vars),
+			'options' => $mins_options,
+		],
+	],
 ]);
-echo '</div>';
 
-echo '<div>';
-echo '<label for="enddate">' . elgg_echo('site_announcements:edit:enddate') . '</label>';
-echo elgg_view('input/date', [
-	'name' => 'enddate',
-	'value' => elgg_extract('enddate', $vars),
-	'timestamp' => true,
-	'class' => 'mhs elgg-col-1of5',
-]);
-echo '@';
-echo elgg_view('input/select', [
-	'name' => 'endhour',
-	'value' => elgg_extract('endhour', $vars),
-	'options' => $hour_options,
-	'class' => 'mhs',
-]);
-echo ':';
-echo elgg_view('input/select', [
-	'name' => 'endmins',
-	'value' => elgg_extract('endmins', $vars),
-	'options' => $mins_options,
-	'class' => 'mls',
+echo elgg_view_field([
+	'#type' => 'fieldset',
+	'#label' => elgg_echo('site_announcements:edit:enddate'),
+	'align' => 'horizontal',
+	'fields' => [
+		[
+			'#type' => 'date',
+			'name' => 'enddate',
+			'value' => elgg_extract('enddate', $vars),
+			'timestamp' => true,
+		],
+		[
+			'#type' => 'select',
+			'name' => 'endhour',
+			'value' => elgg_extract('endhour', $vars),
+			'options' => $hour_options,
+		],
+		[
+			'#type' => 'select',
+			'name' => 'endmins',
+			'value' => elgg_extract('endmins', $vars),
+			'options' => $mins_options,
+		],
+	],
 ]);
-echo '</div>';
 
 echo elgg_view_field([
 	'#type' => 'select',

views/default/object/site_announcement.php

@@ -20,6 +20,13 @@
 		'class' => [
 			"site-announcement-{$announcement_type}",
 		],
+		'link' => elgg_view('output/url', [
+			'icon' => 'delete',
+			'text' => false,
+			'title' => elgg_echo('site_announcements:menu:entity:mark'),
+			'href' => elgg_generate_action_url('site_announcements/mark', ['guid' => $entity->guid]),
+			'class' => 'site-announcements-mark',
+		]),
 	];
 
 	// error, success, warning, help, notice
@@ -39,15 +46,6 @@
 			break;
 	}
 
-	$mark = elgg_view('output/url', [
-		'icon' => 'delete',
-		'text' => false,
-		'title' => elgg_echo('site_announcements:menu:entity:mark'),
-		'href' => elgg_generate_action_url('site_announcements/mark', ['guid' => $entity->guid]),
-		'class' => 'site-announcements-mark',
-	]);
-	$content = elgg_view_image_block('', $content, ['image_alt' => $mark]);
-
 	echo elgg_view_message($message_type, $content, $message_options);
 } else {
 	$imprint = [

views/default/plugins/site_announcements/settings.php

@@ -1,6 +1,6 @@
 <?php
 
-/* @var $plugin ElggPlugin */
+/* @var $plugin \ElggPlugin */
 $plugin = elgg_extract('entity', $vars);
 
 echo elgg_view_field([
@@ -10,5 +10,4 @@
 	'name' => 'params[archive_cleanup]',
 	'value' => $plugin->archive_cleanup,
 	'min' => 0,
-	'max' => 9999,
 ]);

views/default/resources/site_announcements/edit.php

@@ -5,8 +5,9 @@
 
 // get entity
 $guid = (int) elgg_extract('guid', $vars);
-elgg_entity_gatekeeper($guid, 'object', \SiteAnnouncement::SUBTYPE);
+elgg_entity_gatekeeper($guid, 'object', \SiteAnnouncement::SUBTYPE, true);
 
+/* @var $entity \SiteAnnouncement */
 $entity = get_entity($guid);
 
 // breadcrumb

views/default/resources/site_announcements/editors.php

@@ -3,8 +3,6 @@
  * List all announcement editors
  */
 
-use Elgg\Database\QueryBuilder;
-
 // breadcrumb
 elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 

views/default/site_announcements/announcement.mjs

@@ -0,0 +1,17 @@
+import 'jquery';
+import Ajax from 'elgg/Ajax';
+
+$(document).on('click', '.site-announcements-mark', function(event) {
+	event.preventDefault();
+
+	var ajax = new Ajax(false);
+
+	var $message = $(this).closest('.elgg-message');
+	$message.slideToggle();
+
+	ajax.action($(this).attr('href'), {
+		success: function() {
+			$message.remove();
+		}
+	});
+});