changed: updated for Elgg 5.1

ColdTrick · Oct 30, 2023 · d5acafa · d5acafa
1 parent e97e1bc
commit d5acafa
Show file tree

Hide file tree

Showing 15 changed files with 30 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 Site announcements
 ==================
 
-![Elgg 5.0](https://img.shields.io/badge/Elgg-5.0-green.svg)
+![Elgg 5.1](https://img.shields.io/badge/Elgg-5.1-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)

diff --git a/classes/ColdTrick/SiteAnnouncements/Cron.php b/classes/ColdTrick/SiteAnnouncements/Cron.php
@@ -21,9 +21,6 @@ public static function cleanupExpiredAnnouncements(\Elgg\Event $event): void {
 			return;
 		}
 
-		echo 'Starting SiteAnnouncements cleanup' . PHP_EOL;
-		elgg_log('Starting SiteAnnouncements cleanup', 'NOTICE');
-
 		$time = (int) $event->getParam('time', time());
 
 		$options = [
@@ -52,8 +49,5 @@ public static function cleanupExpiredAnnouncements(\Elgg\Event $event): void {
 				}
 			}
 		});
-
-		echo 'Done with SiteAnnouncements cleanup' . PHP_EOL;
-		elgg_log('Done with SiteAnnouncements cleanup', 'NOTICE');
 	}
 }
diff --git a/classes/ColdTrick/SiteAnnouncements/Gatekeeper.php b/classes/ColdTrick/SiteAnnouncements/Gatekeeper.php
@@ -2,13 +2,15 @@
 
 namespace ColdTrick\SiteAnnouncements;
 
-use Elgg\Request;
+use Elgg\Exceptions\HttpException;
 use Elgg\Exceptions\Http\GatekeeperException;
+use Elgg\Request;
+use Elgg\Router\Middleware\Gatekeeper as CoreGatekeeper;
 
 /**
  * Site announcement editor gatekeeper
  */
-class Gatekeeper {
+class Gatekeeper extends CoreGatekeeper {
 
 	/**
 	 * Only site announcement editors can access this part
@@ -17,9 +19,10 @@ class Gatekeeper {
 	 *
 	 * @return void
 	 * @throws GatekeeperException
+	 * @throws HttpException
 	 */
-	public function __invoke(Request $request) {
-		$request->elgg()->gatekeeper->assertAuthenticatedUser();
+	public function __invoke(Request $request): void {
+		parent::__invoke($request);
 
 		if (!self::isEditor()) {
 			throw new GatekeeperException(elgg_echo('limited_access'));
@@ -34,12 +37,11 @@ public function __invoke(Request $request) {
 	 * @return bool
 	 */
 	public static function isEditor(\ElggUser $user = null): bool {
-
 		if (!$user instanceof \ElggUser) {
 			$user = elgg_get_logged_in_user_entity();
 		}
 
-		if (empty($user)) {
+		if (!$user instanceof \ElggUser) {
 			return false;
 		}
 

diff --git a/classes/ColdTrick/SiteAnnouncements/Menus/AdminHeader.php b/classes/ColdTrick/SiteAnnouncements/Menus/AdminHeader.php
@@ -29,7 +29,7 @@ public static function register(\Elgg\Event $event): ?MenuItems {
 			'text' => elgg_echo('site_announcements'),
 			'href' => elgg_generate_url('collection:object:site_announcement:all'),
 			'is_trusted' => true,
-			'parent_name' => 'administer_utilities',
+			'parent_name' => 'administer',
 		]);
 
 		return $returnvalue;

diff --git a/classes/ColdTrick/SiteAnnouncements/Seeder.php b/classes/ColdTrick/SiteAnnouncements/Seeder.php
@@ -88,6 +88,13 @@ public static function getType(): string {
 		return \SiteAnnouncement::SUBTYPE;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	public static function getDefaultLimit(): int {
+		return 5;
+	}
+
 	/**
 	 * {@inheritDoc}
 	 */

diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
 		"composer/installers": "^1.0.8"
 	},
 	"conflict": {
-		"elgg/elgg": "<5.0"
+		"elgg/elgg": "<5.1"
 	},
 	"config": {
 		"allow-plugins": {

diff --git a/composer.lock b/composer.lock
diff --git a/views/default/js/site_announcements/announcement.js b/views/default/js/site_announcements/announcement.js
@@ -1,9 +1,8 @@
 define(['jquery', 'elgg/Ajax'], function($, Ajax) {
 
-	var mark_as_read = function(event) {
+	function mark_as_read(event) {
 		event.preventDefault();
 
-		var guid = $(this).attr('rel');
 		var ajax = new Ajax(false);
 
 		$message = $(this).closest('.elgg-message');
@@ -14,7 +13,7 @@ define(['jquery', 'elgg/Ajax'], function($, Ajax) {
 				$message.remove();
 			}
 		});
-	};
+	}
 
 	$(document).on('click', '.site-announcements-mark', mark_as_read);
 });
diff --git a/views/default/object/site_announcement.php b/views/default/object/site_announcement.php
@@ -42,9 +42,9 @@
 	$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',
-		'title' => elgg_echo('site_announcements:menu:entity:mark'),
 	]);
 	$content = elgg_view_image_block('', $content, ['image_alt' => $mark]);
 
@@ -78,6 +78,7 @@
 		'access' => false,
 		'byline' => false,
 		'time' => false,
+		'title' => false,
 		'imprint' => $imprint,
 	];
 	$params = $params + $vars;

diff --git a/views/default/resources/site_announcements/add.php b/views/default/resources/site_announcements/add.php
@@ -4,7 +4,7 @@
  */
 
 // breadcrumb
-elgg_push_collection_breadcrumbs('object', SiteAnnouncement::SUBTYPE);
+elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 
 // draw page
 echo elgg_view_page(elgg_echo('site_announcements:add:title'), [

diff --git a/views/default/resources/site_announcements/all.php b/views/default/resources/site_announcements/all.php
@@ -6,7 +6,7 @@
 use ColdTrick\SiteAnnouncements\Gatekeeper;
 
 // breadcrumb
-elgg_push_collection_breadcrumbs('object', SiteAnnouncement::SUBTYPE);
+elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 
 // add button
 if (Gatekeeper::isEditor()) {

diff --git a/views/default/resources/site_announcements/archive.php b/views/default/resources/site_announcements/archive.php
@@ -6,7 +6,7 @@
 use ColdTrick\SiteAnnouncements\Gatekeeper;
 
 // breadcrumb
-elgg_push_collection_breadcrumbs('object', SiteAnnouncement::SUBTYPE);
+elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 
 // add button
 if (Gatekeeper::isEditor()) {

diff --git a/views/default/resources/site_announcements/edit.php b/views/default/resources/site_announcements/edit.php
@@ -10,7 +10,7 @@
 $entity = get_entity($guid);
 
 // breadcrumb
-elgg_push_collection_breadcrumbs('object', SiteAnnouncement::SUBTYPE);
+elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 
 // draw page
 echo elgg_view_page(elgg_echo('site_announcements:edit:title'), [

diff --git a/views/default/resources/site_announcements/editors.php b/views/default/resources/site_announcements/editors.php
@@ -6,7 +6,7 @@
 use Elgg\Database\QueryBuilder;
 
 // breadcrumb
-elgg_push_collection_breadcrumbs('object', SiteAnnouncement::SUBTYPE);
+elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 
 // add button
 elgg_register_title_button('add', 'object', \SiteAnnouncement::SUBTYPE);

diff --git a/views/default/resources/site_announcements/scheduled.php b/views/default/resources/site_announcements/scheduled.php
@@ -4,7 +4,7 @@
  */
 
 // breadcrumb
-elgg_push_collection_breadcrumbs('object', SiteAnnouncement::SUBTYPE);
+elgg_push_collection_breadcrumbs('object', \SiteAnnouncement::SUBTYPE);
 
 // add button
 elgg_register_title_button('add', 'object', \SiteAnnouncement::SUBTYPE);