Merge pull request #502 from WoltLab/6.2-recent-activity-image

Document image support in recent activities

Author: BurntimeX

docs/migration/wsc61/php.md

@@ -0,0 +1,26 @@
+# Migrating from WoltLab Suite 6.1 - PHP
+
+## User Activity Events
+
+User activity events can optionally be provided with an image.
+The `setImage()` method expects an object of type `wcf\system\file\processor\ImageData` as a parameter.
+
+Classes that implement the interface `wcf\system\file\processor\IImageDataProvider` provide the `getImageData()` method,
+that returns a suitable `ImageData` object.
+
+#### Example
+
+```php
+$object = new FooBarObject(1);
+$event->setTitle(WCF::getLanguage()->getDynamicVariable('com.foo.bar', [
+    // variables
+]));
+$event->setDescription(
+    StringUtil::encodeHTML(
+        StringUtil::truncate($object->getPlainTextMessage(), 500)
+    ),
+    true
+);
+$event->setLink($object->getLink());
+$event->setImage(new ImageData('image_src', 800, 600));
+```

docs/php/api/user_activity_events.md

@@ -27,6 +27,7 @@ use wcf\data\user\activity\event\ViewableUserActivityEvent;
 use wcf\system\user\activity\event\IUserActivityEvent;
 use wcf\system\WCF;
 use wcf\util\StringUtil;
+use wcf\system\file\processor\ImageData;
 
 final class FooUserActivityEvent implements IUserActivityEvent
 {
@@ -57,6 +58,8 @@ final class FooUserActivityEvent implements IUserActivityEvent
             true
         );
         $event->setLink($foo->getLink());
+        // Optionally set an image.
+        $event->setImage(new ImageData('image_src', 800, 600));
     }
 }
 ```

mkdocs.yml

@@ -130,6 +130,7 @@ nav:
   - 'Migration':
       - 'From WoltLab Suite 6.1':
           - 'Deprecations and Removals': 'migration/wsc61/deprecations_removals.md'
+          - 'PHP API': 'migration/wsc61/php.md'
           - 'Templates': 'migration/wsc61/templates.md'
           - 'Quotes': 'migration/wsc61/quotes.md'
       - 'From WoltLab Suite 6.0':