Merge pull request #68 from humhub/enh/67-activity-wording

Update text for activity and notification of shared contents

Events.php

@@ -8,8 +8,10 @@
 
 namespace humhub\modules\sharebetween;
 
+use humhub\modules\activity\models\Activity;
 use humhub\modules\content\components\ContentActiveRecord;
 use humhub\modules\content\events\ContentEvent;
+use humhub\modules\notification\models\Notification;
 use humhub\modules\sharebetween\models\Share;
 use yii\base\BaseObject;
 
@@ -53,4 +55,25 @@ public static function onWallEntryLinksInit($event)
         $stackWidget->addWidget(widgets\ShareLink::class, ['record' => $record]);
     }
 
+    public static function onActivityAfterFind($event)
+    {
+        /* @var Activity $activity */
+        $activity = $event->sender;
+
+        if ($activity->object_model === Share::class) {
+            // Switch to render specific text for the shared content activity
+            $activity->class = activities\SharedContentCreated::class;
+        }
+    }
+
+    public static function onNotificationAfterFind($event)
+    {
+        /* @var Notification $activity */
+        $notification = $event->sender;
+
+        if ($notification->source_class === Share::class) {
+            // Switch to render specific text for the shared content notification
+            $notification->class = notifications\SharedContentCreated::class;
+        }
+    }
 }

activities/SharedContentCreated.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * @link https://www.humhub.org/
+ * @copyright Copyright (c) HumHub GmbH & Co. KG
+ * @license https://www.humhub.com/licences
+ */
+
+namespace humhub\modules\sharebetween\activities;
+
+use humhub\modules\content\activities\ContentCreated;
+
+class SharedContentCreated extends ContentCreated
+{
+    /**
+     * @inheritdoc
+     */
+    public $viewName = 'shared';
+}

activities/views/shared.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * @link https://www.humhub.org/
+ * @copyright Copyright (c) HumHub GmbH & Co. KG
+ * @license https://www.humhub.com/licences
+ */
+
+use humhub\modules\sharebetween\models\Share;
+use humhub\modules\user\models\User;
+use yii\helpers\Html;
+
+/* @var User $originator */
+/* @var Share $source */
+
+echo Yii::t('SharebetweenModule.base', '{user} shared something interesting from Space {space}.', [
+    '{user}' => '<strong>' . Html::encode($originator->displayName) . '</strong>',
+    '{space}' => '<strong>' . Html::encode($source->sharedContent->container->displayName) . '</strong>',
+]);

assets/Assets.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @link https://www.humhub.org/
  * @copyright Copyright (c) 2023 HumHub GmbH & Co. KG

config.php

@@ -1,16 +1,21 @@
 <?php
 
+use humhub\modules\activity\models\Activity;
 use humhub\modules\content\components\ContentActiveRecord;
 use humhub\modules\content\models\Content;
 use humhub\modules\content\widgets\WallEntryLinks;
+use humhub\modules\notification\models\Notification;
+use humhub\modules\sharebetween\Events;
 
 return [
     'id' => 'sharebetween',
     'class' => 'humhub\modules\sharebetween\Module',
     'namespace' => 'humhub\modules\sharebetween',
     'events' => [
-        [Content::class, Content::EVENT_AFTER_SOFT_DELETE, ['humhub\modules\sharebetween\Events', 'onContentAfterSoftDelete']],
-        [ContentActiveRecord::class, ContentActiveRecord::EVENT_BEFORE_DELETE, ['humhub\modules\sharebetween\Events', 'onContentDelete']],
-        [WallEntryLinks::class, WallEntryLinks::EVENT_INIT, ['humhub\modules\sharebetween\Events', 'onWallEntryLinksInit']],
+        [Content::class, Content::EVENT_AFTER_SOFT_DELETE, [Events::class, 'onContentAfterSoftDelete']],
+        [ContentActiveRecord::class, ContentActiveRecord::EVENT_BEFORE_DELETE, [Events::class, 'onContentDelete']],
+        [WallEntryLinks::class, WallEntryLinks::EVENT_INIT, [Events::class, 'onWallEntryLinksInit']],
+        [Activity::class, Activity::EVENT_AFTER_FIND, [Events::class, 'onActivityAfterFind']],
+        [Notification::class, Notification::EVENT_AFTER_FIND, [Events::class, 'onNotificationAfterFind']],
     ],
 ];

docs/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+1.0.8 (Unreleased)
+-------------------------
+- Enh #67: Update text for activity and notification of shared contents
+
 1.0.7 (November 14, 2024)
 -------------------------
 - Enh #65: Use PHP CS Fixer

models/Share.php

@@ -7,11 +7,14 @@
 use humhub\modules\sharebetween\services\ShareService;
 use humhub\modules\sharebetween\widgets\WallEntry;
 use Yii;
+use yii\db\ActiveQuery;
 use yii\web\IdentityInterface;
 
 /**
+ * Class for shared content record between spaces or users
  *
- * @property $content_id int
+ * @property int $content_id
+ * @property-read Content $sharedContent
  */
 class Share extends ContentActiveRecord
 {
@@ -20,19 +23,25 @@ class Share extends ContentActiveRecord
      */
     public $wallEntryClass = WallEntry::class;
 
+    /**
+     * @inheritdoc
+     */
     public static function tableName()
     {
         return 'sharebetween_share';
     }
 
+    /**
+     * @inheritdoc
+     */
     public function rules()
     {
         return [
             [['content_id'], 'required'],
         ];
     }
 
-    public function getSharedContent()
+    public function getSharedContent(): ActiveQuery
     {
         return $this->hasOne(Content::class, ['id' => 'content_id']);
     }
@@ -42,8 +51,7 @@ public function getContentRecord(): ContentActiveRecord
         return $this->sharedContent->getModel();
     }
 
-
-    public function getShareService(?IdentityInterface $user)
+    public function getShareService(?IdentityInterface $user): ShareService
     {
         if ($user === null) {
             /** @var IdentityInterface $user */
@@ -53,6 +61,9 @@ public function getShareService(?IdentityInterface $user)
         return new ShareService($this->getContentRecord(), $user);
     }
 
+    /**
+     * @inheritdoc
+     */
     public function getIcon()
     {
         return 'fa-share-alt';
@@ -66,4 +77,11 @@ public function getContentName()
         return Yii::t('SharebetweenModule.base', 'Shared content');
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getContentDescription()
+    {
+        return $this->sharedContent->getContentDescription();
+    }
 }

module.json

@@ -3,7 +3,7 @@
     "name": "Share content",
     "description": "Share content between Spaces in the simplest way possible.",
     "keywords": ["share", "between", "content"],
-    "version": "1.0.7",
+    "version": "1.0.8",
     "humhub": {
         "minVersion": "1.14"
     },

notifications/SharedContentCreated.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @link https://www.humhub.org/
+ * @copyright Copyright (c) HumHub GmbH & Co. KG
+ * @license https://www.humhub.com/licences
+ */
+
+namespace humhub\modules\sharebetween\notifications;
+
+use humhub\modules\content\notifications\ContentCreated;
+use humhub\modules\sharebetween\models\Share;
+use Yii;
+use yii\bootstrap\Html;
+
+class SharedContentCreated extends ContentCreated
+{
+    /**
+     * @inheritdoc
+     * @var Share
+     */
+    public $source;
+
+    /**
+     * @inheritdoc
+     */
+    public function html()
+    {
+        return Yii::t('SharebetweenModule.base', '{user} shared something interesting from Space {space}.', [
+            'user' => Html::tag('strong', Html::encode($this->originator->displayName)),
+            'space' => Html::tag('strong', Html::encode($this->source->sharedContent->container->displayName)),
+        ]);
+    }
+}

tests/codeception/_bootstrap.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @link https://www.humhub.org/
  * @copyright Copyright (c) 2015 HumHub GmbH & Co. KG

tests/codeception/acceptance/_bootstrap.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Initialize the HumHub Application for functional testing. The default application configuration for this suite can be overwritten
  * in @tests/config/functional.php

tests/codeception/fixtures/ShareFixture.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @link https://www.humhub.org/
  * @copyright Copyright (c) 2023 HumHub GmbH & Co. KG

tests/codeception/fixtures/data/share.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @link https://www.humhub.org/
  * @copyright Copyright (c) 2023 HumHub GmbH & Co. KG

tests/codeception/functional/_bootstrap.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Initialize the HumHub Application for functional testing. The default application configuration for this suite can be overwritten
  * in @tests/config/functional.php

tests/codeception/unit/_bootstrap.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Initialize the HumHub Application for functional testing. The default application configuration for this suite can be overwritten
  * in @tests/config/functional.php

tests/config/common.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This config is shared by all suites (unit/functional/acceptance) and can be overwritten by a suite config (e.g. functional.php)
  */

tests/config/functional.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Here you can overwrite the default config for the functional suite. The default config resides in @humhubTests/codeception/config/config.php
  */

tests/config/unit.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Here you can overwrite your functional humhub config. The default config resiedes in @humhubTests/codeception/config/config.php
  */