mirror of
https://github.com/flarum/core.git
synced 2025-07-20 16:21:18 +02:00
Update for evented API
This commit is contained in:
@@ -1,9 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// Require the extension's composer autoload file. This will enable all of our
|
|
||||||
// classes in the src directory to be autoloaded.
|
|
||||||
require __DIR__.'/vendor/autoload.php';
|
require __DIR__.'/vendor/autoload.php';
|
||||||
|
|
||||||
// Register our service provider with the Flarum application. In here we can
|
return 'Flarum\Sticky\Extension';
|
||||||
// register bindings and execute code when the application boots.
|
|
||||||
return $this->app->register('Flarum\Sticky\StickyServiceProvider');
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
var gulp = require('flarum-gulp');
|
var gulp = require('flarum-gulp');
|
||||||
|
|
||||||
gulp({
|
gulp({
|
||||||
modulePrefix: 'flarum-sticky'
|
modulePrefix: 'sticky'
|
||||||
});
|
});
|
||||||
|
81
extensions/sticky/js/bootstrap.js
vendored
81
extensions/sticky/js/bootstrap.js
vendored
@@ -1,81 +0,0 @@
|
|||||||
import { extend } from 'flarum/extension-utils';
|
|
||||||
import Model from 'flarum/model';
|
|
||||||
import Discussion from 'flarum/models/discussion';
|
|
||||||
import DiscussionPage from 'flarum/components/discussion-page';
|
|
||||||
import DiscussionList from 'flarum/components/discussion-list';
|
|
||||||
import DiscussionListItem from 'flarum/components/discussion-list-item';
|
|
||||||
import Badge from 'flarum/components/badge';
|
|
||||||
import ActionButton from 'flarum/components/action-button';
|
|
||||||
import SettingsPage from 'flarum/components/settings-page';
|
|
||||||
import icon from 'flarum/helpers/icon';
|
|
||||||
import truncate from 'flarum/utils/truncate';
|
|
||||||
import app from 'flarum/app';
|
|
||||||
|
|
||||||
import DiscussionStickiedPost from 'flarum-sticky/components/discussion-stickied-post';
|
|
||||||
import DiscussionStickiedNotification from 'flarum-sticky/components/discussion-stickied-notification';
|
|
||||||
|
|
||||||
app.initializers.add('sticky', function() {
|
|
||||||
|
|
||||||
// Register components.
|
|
||||||
app.postComponentRegistry['discussionStickied'] = DiscussionStickiedPost;
|
|
||||||
app.notificationComponentRegistry['discussionStickied'] = DiscussionStickiedNotification;
|
|
||||||
|
|
||||||
Discussion.prototype.isSticky = Model.prop('isSticky');
|
|
||||||
Discussion.prototype.canSticky = Model.prop('canSticky');
|
|
||||||
|
|
||||||
// Add a sticky badge to discussions.
|
|
||||||
extend(Discussion.prototype, 'badges', function(badges) {
|
|
||||||
if (this.isSticky()) {
|
|
||||||
badges.add('sticky', Badge.component({
|
|
||||||
label: 'Sticky',
|
|
||||||
icon: 'thumb-tack',
|
|
||||||
className: 'badge-sticky',
|
|
||||||
}), {last: true});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
function toggleSticky() {
|
|
||||||
this.save({isSticky: !this.isSticky()}).then(discussion => {
|
|
||||||
if (app.current instanceof DiscussionPage) {
|
|
||||||
app.current.stream.sync();
|
|
||||||
}
|
|
||||||
m.redraw();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add a sticky control to discussions.
|
|
||||||
extend(Discussion.prototype, 'moderationControls', function(items) {
|
|
||||||
if (this.canSticky()) {
|
|
||||||
items.add('sticky', ActionButton.component({
|
|
||||||
label: this.isSticky() ? 'Unsticky' : 'Sticky',
|
|
||||||
icon: 'thumb-tack',
|
|
||||||
onclick: toggleSticky.bind(this)
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Add a notification preference.
|
|
||||||
extend(SettingsPage.prototype, 'notificationTypes', function(items) {
|
|
||||||
items.add('discussionStickied', {
|
|
||||||
name: 'discussionStickied',
|
|
||||||
label: [icon('thumb-tack'), ' Someone stickies a discussion I started']
|
|
||||||
}, {after: 'discussionRenamed'});
|
|
||||||
});
|
|
||||||
|
|
||||||
extend(DiscussionList.prototype, 'params', function(params) {
|
|
||||||
params.include.push('startPost');
|
|
||||||
});
|
|
||||||
|
|
||||||
extend(DiscussionListItem.prototype, 'infoItems', function(items) {
|
|
||||||
var discussion = this.props.discussion;
|
|
||||||
|
|
||||||
if (discussion.isSticky()) {
|
|
||||||
var startPost = discussion.startPost();
|
|
||||||
if (startPost) {
|
|
||||||
var excerpt = m('span', truncate(startPost.contentPlain(), 200));
|
|
||||||
excerpt.wrapperClass = 'discussion-excerpt';
|
|
||||||
items.add('excerpt', excerpt, {last: true});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
15
extensions/sticky/js/src/addStickyBadge.js
Normal file
15
extensions/sticky/js/src/addStickyBadge.js
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { extend } from 'flarum/extend';
|
||||||
|
import Discussion from 'flarum/models/Discussion';
|
||||||
|
import Badge from 'flarum/components/Badge';
|
||||||
|
|
||||||
|
export default function addStickyBadge() {
|
||||||
|
extend(Discussion.prototype, 'badges', function(badges) {
|
||||||
|
if (this.isSticky()) {
|
||||||
|
badges.add('sticky', Badge.component({
|
||||||
|
type: 'sticky',
|
||||||
|
label: app.trans('sticky.stickied'),
|
||||||
|
icon: 'thumb-tack'
|
||||||
|
}), 10);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
26
extensions/sticky/js/src/addStickyControl.js
Normal file
26
extensions/sticky/js/src/addStickyControl.js
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import { extend } from 'flarum/extend';
|
||||||
|
import DiscussionControls from 'flarum/utils/DiscussionControls';
|
||||||
|
import DiscussionPage from 'flarum/components/DiscussionPage';
|
||||||
|
import Button from 'flarum/components/Button';
|
||||||
|
|
||||||
|
export default function addStickyControl() {
|
||||||
|
extend(DiscussionControls, 'moderationControls', function(items, discussion) {
|
||||||
|
if (discussion.canSticky()) {
|
||||||
|
items.add('sticky', Button.component({
|
||||||
|
children: app.trans(discussion.isSticky() ? 'sticky.unsticky' : 'sticky.sticky'),
|
||||||
|
icon: 'thumb-tack',
|
||||||
|
onclick: this.stickyAction.bind(discussion)
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
DiscussionControls.stickyAction = function() {
|
||||||
|
this.save({isSticky: !this.isSticky()}).then(() => {
|
||||||
|
if (app.current instanceof DiscussionPage) {
|
||||||
|
app.current.stream.update();
|
||||||
|
}
|
||||||
|
|
||||||
|
m.redraw();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
}
|
24
extensions/sticky/js/src/addStickyExcerpt.js
Normal file
24
extensions/sticky/js/src/addStickyExcerpt.js
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import { extend } from 'flarum/extend';
|
||||||
|
import DiscussionList from 'flarum/components/DiscussionList';
|
||||||
|
import DiscussionListItem from 'flarum/components/DiscussionListItem';
|
||||||
|
import { truncate } from 'flarum/utils/string';
|
||||||
|
|
||||||
|
export default function addStickyControl() {
|
||||||
|
extend(DiscussionList.prototype, 'requestParams', function(params) {
|
||||||
|
params.include.push('startPost');
|
||||||
|
});
|
||||||
|
|
||||||
|
extend(DiscussionListItem.prototype, 'infoItems', function(items) {
|
||||||
|
const discussion = this.props.discussion;
|
||||||
|
|
||||||
|
if (discussion.isSticky()) {
|
||||||
|
const startPost = discussion.startPost();
|
||||||
|
|
||||||
|
if (startPost) {
|
||||||
|
const excerpt = <span>{truncate(startPost.contentPlain(), 200)}</span>;
|
||||||
|
|
||||||
|
items.add('excerpt', excerpt, 100);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
@@ -0,0 +1,15 @@
|
|||||||
|
import Notification from 'flarum/components/Notification';
|
||||||
|
|
||||||
|
export default class DiscussionStickiedNotification extends Notification {
|
||||||
|
icon() {
|
||||||
|
return 'thumb-tack';
|
||||||
|
}
|
||||||
|
|
||||||
|
href() {
|
||||||
|
return app.route.discussion(notification.subject(), notification.content().postNumber);
|
||||||
|
}
|
||||||
|
|
||||||
|
content() {
|
||||||
|
return app.trans('sticky.discussion_stickied_notification', {user: this.props.notification.sender()});
|
||||||
|
}
|
||||||
|
}
|
@@ -0,0 +1,13 @@
|
|||||||
|
import EventPost from 'flarum/components/EventPost';
|
||||||
|
|
||||||
|
export default class DiscussionStickiedPost extends EventPost {
|
||||||
|
icon() {
|
||||||
|
return 'thumb-tack';
|
||||||
|
}
|
||||||
|
|
||||||
|
descriptionKey() {
|
||||||
|
return this.props.post.content().sticky
|
||||||
|
? 'sticky.discussion_stickied_post'
|
||||||
|
: 'sticky.discussion_unstickied_post';
|
||||||
|
}
|
||||||
|
}
|
@@ -1,14 +0,0 @@
|
|||||||
import Notification from 'flarum/components/notification';
|
|
||||||
import username from 'flarum/helpers/username';
|
|
||||||
|
|
||||||
export default class DiscussionStickiedNotification extends Notification {
|
|
||||||
view() {
|
|
||||||
var notification = this.props.notification;
|
|
||||||
|
|
||||||
return super.view({
|
|
||||||
href: app.route.discussion(notification.subject(), notification.content().postNumber),
|
|
||||||
icon: 'thumb-tack',
|
|
||||||
content: [username(notification.sender()), ' stickied']
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,9 +0,0 @@
|
|||||||
import EventPost from 'flarum/components/event-post';
|
|
||||||
|
|
||||||
export default class DiscussionStickiedPost extends EventPost {
|
|
||||||
view() {
|
|
||||||
var post = this.props.post;
|
|
||||||
|
|
||||||
return super.view('thumb-tack', [post.content().sticky ? 'stickied' : 'unstickied', ' the discussion.']);
|
|
||||||
}
|
|
||||||
}
|
|
29
extensions/sticky/js/src/main.js
Normal file
29
extensions/sticky/js/src/main.js
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
import { extend, notificationType } from 'flarum/extend';
|
||||||
|
import app from 'flarum/app';
|
||||||
|
import Model from 'flarum/Model';
|
||||||
|
import Discussion from 'flarum/models/Discussion';
|
||||||
|
import NotificationGrid from 'flarum/components/NotificationGrid';
|
||||||
|
|
||||||
|
import DiscussionStickiedPost from 'sticky/components/DiscussionStickiedPost';
|
||||||
|
import DiscussionStickiedNotification from 'sticky/components/DiscussionStickiedNotification';
|
||||||
|
import addStickyBadge from 'sticky/addStickyBadge';
|
||||||
|
import addStickyControl from 'sticky/addStickyControl';
|
||||||
|
import addStickyExcerpt from 'sticky/addStickyExcerpt';
|
||||||
|
|
||||||
|
app.postComponents.discussionStickied = DiscussionStickiedPost;
|
||||||
|
app.notificationComponents.discussionStickied = DiscussionStickiedNotification;
|
||||||
|
|
||||||
|
Discussion.prototype.isSticky = Model.attribute('isSticky');
|
||||||
|
Discussion.prototype.canSticky = Model.attribute('canSticky');
|
||||||
|
|
||||||
|
addStickyBadge();
|
||||||
|
addStickyControl();
|
||||||
|
addStickyExcerpt();
|
||||||
|
|
||||||
|
extend(NotificationGrid.prototype, 'notificationTypes', function(items) {
|
||||||
|
items.add('discussionStickied', {
|
||||||
|
name: 'discussionStickied',
|
||||||
|
icon: 'thumb-tack',
|
||||||
|
label: app.trans('sticky.notify_discussion_stickied')
|
||||||
|
});
|
||||||
|
});
|
26
extensions/sticky/less/extension.less
Normal file
26
extensions/sticky/less/extension.less
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
.Badge--sticky {
|
||||||
|
background: #d13e32;
|
||||||
|
}
|
||||||
|
.DiscussionStickiedPost {
|
||||||
|
& .EventPost-icon,
|
||||||
|
& .EventPost-info,
|
||||||
|
& .EventPost-info a {
|
||||||
|
color: #d13e32;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.DiscussionListItem-info .item-excerpt {
|
||||||
|
margin-top: 8px;
|
||||||
|
margin-right: 20px;
|
||||||
|
white-space: normal;
|
||||||
|
font-size: 12px;
|
||||||
|
line-height: 1.5em;
|
||||||
|
color: @muted-more-color;
|
||||||
|
display: block;
|
||||||
|
|
||||||
|
.DiscussionPage-list & {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
@media @phone {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
@@ -1,27 +0,0 @@
|
|||||||
.badge-sticky {
|
|
||||||
background: #d13e32;
|
|
||||||
}
|
|
||||||
.discussion-stickied-post {
|
|
||||||
& .post-icon, & .event-post-info, & .event-post-info a {
|
|
||||||
color: #d13e32;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.discussion-excerpt {
|
|
||||||
margin-top: 8px;
|
|
||||||
margin-right: 20px;
|
|
||||||
white-space: normal;
|
|
||||||
font-size: 12px;
|
|
||||||
line-height: 1.5em;
|
|
||||||
color: @fl-body-muted-more-color;
|
|
||||||
|
|
||||||
.discussion-summary .info > li& {
|
|
||||||
display: block;
|
|
||||||
|
|
||||||
.paned & {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
@media @phone {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
8
extensions/sticky/locale/en.yml
Normal file
8
extensions/sticky/locale/en.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
sticky:
|
||||||
|
discussion_stickied_notification: "{username} stickied"
|
||||||
|
discussion_stickied_post: "{username} stickied the discussion."
|
||||||
|
discussion_unstickied_post: "{username} unstickied the discussion."
|
||||||
|
notify_discussion_stickied: Someone stickies a discussion I started
|
||||||
|
stickied: Sticky
|
||||||
|
sticky: Sticky
|
||||||
|
unsticky: Unsticky
|
@@ -1,23 +1,23 @@
|
|||||||
<?php namespace Flarum\Sticky\Events;
|
<?php namespace Flarum\Sticky\Events;
|
||||||
|
|
||||||
use Flarum\Core\Models\Discussion;
|
use Flarum\Core\Discussions\Discussion;
|
||||||
use Flarum\Core\Models\User;
|
use Flarum\Core\Users\User;
|
||||||
|
|
||||||
class DiscussionWasStickied
|
class DiscussionWasStickied
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var \Flarum\Core\Models\Discussion
|
* @var Discussion
|
||||||
*/
|
*/
|
||||||
public $discussion;
|
public $discussion;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \Flarum\Core\Models\User
|
* @var User
|
||||||
*/
|
*/
|
||||||
public $user;
|
public $user;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \Flarum\Core\Models\Discussion $discussion
|
* @param Discussion $discussion
|
||||||
* @param \Flarum\Core\Models\User $user
|
* @param User $user
|
||||||
*/
|
*/
|
||||||
public function __construct(Discussion $discussion, User $user)
|
public function __construct(Discussion $discussion, User $user)
|
||||||
{
|
{
|
||||||
|
@@ -1,23 +1,23 @@
|
|||||||
<?php namespace Flarum\Sticky\Events;
|
<?php namespace Flarum\Sticky\Events;
|
||||||
|
|
||||||
use Flarum\Core\Models\Discussion;
|
use Flarum\Core\Discussions\Discussion;
|
||||||
use Flarum\Core\Models\User;
|
use Flarum\Core\Users\User;
|
||||||
|
|
||||||
class DiscussionWasUnstickied
|
class DiscussionWasUnstickied
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var \Flarum\Core\Models\Discussion
|
* @var Discussion
|
||||||
*/
|
*/
|
||||||
public $discussion;
|
public $discussion;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \Flarum\Core\Models\User
|
* @var User
|
||||||
*/
|
*/
|
||||||
public $user;
|
public $user;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \Flarum\Core\Models\Discussion $discussion
|
* @param Discussion $discussion
|
||||||
* @param \Flarum\Core\Models\User $user
|
* @param User $user
|
||||||
*/
|
*/
|
||||||
public function __construct(Discussion $discussion, User $user)
|
public function __construct(Discussion $discussion, User $user)
|
||||||
{
|
{
|
||||||
|
16
extensions/sticky/src/Extension.php
Normal file
16
extensions/sticky/src/Extension.php
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
<?php namespace Flarum\Sticky;
|
||||||
|
|
||||||
|
use Flarum\Support\Extension as BaseExtension;
|
||||||
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
|
|
||||||
|
class Extension extends BaseExtension
|
||||||
|
{
|
||||||
|
public function boot(Dispatcher $events)
|
||||||
|
{
|
||||||
|
$events->subscribe('Flarum\Sticky\Listeners\AddClientAssets');
|
||||||
|
$events->subscribe('Flarum\Sticky\Listeners\AddApiAttributes');
|
||||||
|
$events->subscribe('Flarum\Sticky\Listeners\PersistData');
|
||||||
|
$events->subscribe('Flarum\Sticky\Listeners\PinStickiedDiscussionsToTop');
|
||||||
|
$events->subscribe('Flarum\Sticky\Listeners\NotifyDiscussionStickied');
|
||||||
|
}
|
||||||
|
}
|
@@ -1,9 +1,9 @@
|
|||||||
<?php namespace Flarum\Sticky;
|
<?php namespace Flarum\Sticky\Gambits;
|
||||||
|
|
||||||
use Flarum\Core\Search\SearcherInterface;
|
use Flarum\Core\Search\Search;
|
||||||
use Flarum\Core\Search\GambitAbstract;
|
use Flarum\Core\Search\RegexGambit;
|
||||||
|
|
||||||
class StickyGambit extends GambitAbstract
|
class StickyGambit extends RegexGambit
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* The gambit's regex pattern.
|
* The gambit's regex pattern.
|
||||||
@@ -20,8 +20,8 @@ class StickyGambit extends GambitAbstract
|
|||||||
* @param \Flarum\Core\Search\SearcherInterface $searcher
|
* @param \Flarum\Core\Search\SearcherInterface $searcher
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
protected function conditions(SearcherInterface $searcher, array $matches, $negate)
|
protected function conditions(Search $search, array $matches, $negate)
|
||||||
{
|
{
|
||||||
$searcher->getQuery()->where('is_sticky', ! $negate);
|
$search->getQuery()->where('is_sticky', ! $negate);
|
||||||
}
|
}
|
||||||
}
|
}
|
@@ -1,58 +0,0 @@
|
|||||||
<?php namespace Flarum\Sticky\Handlers;
|
|
||||||
|
|
||||||
use Flarum\Sticky\DiscussionStickiedPost;
|
|
||||||
use Flarum\Sticky\DiscussionStickiedNotification;
|
|
||||||
use Flarum\Sticky\Events\DiscussionWasStickied;
|
|
||||||
use Flarum\Sticky\Events\DiscussionWasUnstickied;
|
|
||||||
use Flarum\Core\Notifications\NotificationSyncer;
|
|
||||||
use Flarum\Core\Models\Discussion;
|
|
||||||
use Flarum\Core\Models\User;
|
|
||||||
use Illuminate\Contracts\Events\Dispatcher;
|
|
||||||
|
|
||||||
class DiscussionStickiedNotifier
|
|
||||||
{
|
|
||||||
protected $notifications;
|
|
||||||
|
|
||||||
public function __construct(NotificationSyncer $notifications)
|
|
||||||
{
|
|
||||||
$this->notifications = $notifications;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register the listeners for the subscriber.
|
|
||||||
*
|
|
||||||
* @param \Illuminate\Contracts\Events\Dispatcher $events
|
|
||||||
*/
|
|
||||||
public function subscribe(Dispatcher $events)
|
|
||||||
{
|
|
||||||
$events->listen('Flarum\Sticky\Events\DiscussionWasStickied', __CLASS__.'@whenDiscussionWasStickied');
|
|
||||||
$events->listen('Flarum\Sticky\Events\DiscussionWasUnstickied', __CLASS__.'@whenDiscussionWasUnstickied');
|
|
||||||
}
|
|
||||||
|
|
||||||
public function whenDiscussionWasStickied(DiscussionWasStickied $event)
|
|
||||||
{
|
|
||||||
$this->stickyChanged($event->discussion, $event->user, true);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function whenDiscussionWasUnstickied(DiscussionWasUnstickied $event)
|
|
||||||
{
|
|
||||||
$this->stickyChanged($event->discussion, $event->user, false);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function stickyChanged(Discussion $discussion, User $user, $isSticky)
|
|
||||||
{
|
|
||||||
$post = DiscussionStickiedPost::reply(
|
|
||||||
$discussion->id,
|
|
||||||
$user->id,
|
|
||||||
$isSticky
|
|
||||||
);
|
|
||||||
|
|
||||||
$post = $discussion->addPost($post);
|
|
||||||
|
|
||||||
if ($discussion->start_user_id !== $user->id) {
|
|
||||||
$notification = new DiscussionStickiedNotification($post);
|
|
||||||
|
|
||||||
$this->notifications->sync($notification, $post->exists ? [$discussion->startUser] : []);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
30
extensions/sticky/src/Listeners/AddApiAttributes.php
Executable file
30
extensions/sticky/src/Listeners/AddApiAttributes.php
Executable file
@@ -0,0 +1,30 @@
|
|||||||
|
<?php namespace Flarum\Sticky\Listeners;
|
||||||
|
|
||||||
|
use Flarum\Events\ApiAttributes;
|
||||||
|
use Flarum\Events\BuildApiAction;
|
||||||
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
|
use Flarum\Api\Serializers\DiscussionSerializer;
|
||||||
|
use Flarum\Api\Actions\Discussions\IndexAction as DiscussionsIndexAction;
|
||||||
|
|
||||||
|
class AddApiAttributes
|
||||||
|
{
|
||||||
|
public function subscribe(Dispatcher $events)
|
||||||
|
{
|
||||||
|
$events->listen(ApiAttributes::class, __CLASS__.'@addAttributes');
|
||||||
|
$events->listen(BuildApiAction::class, __CLASS__.'@includeStartPost');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function addAttributes(ApiAttributes $event)
|
||||||
|
{
|
||||||
|
if ($event->serializer instanceof DiscussionSerializer) {
|
||||||
|
$event->attributes['isSticky'] = (bool) $event->model->is_sticky;
|
||||||
|
$event->attributes['canSticky'] = (bool) $event->model->can($event->actor, 'sticky');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
public function includeStartPost(BuildApiAction $event)
|
||||||
|
{
|
||||||
|
if ($event->action instanceof DiscussionsIndexAction) {
|
||||||
|
$event->addInclude('startPost');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
39
extensions/sticky/src/Listeners/AddClientAssets.php
Executable file
39
extensions/sticky/src/Listeners/AddClientAssets.php
Executable file
@@ -0,0 +1,39 @@
|
|||||||
|
<?php namespace Flarum\Sticky\Listeners;
|
||||||
|
|
||||||
|
use Flarum\Events\RegisterLocales;
|
||||||
|
use Flarum\Events\BuildClientView;
|
||||||
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
|
|
||||||
|
class AddClientAssets
|
||||||
|
{
|
||||||
|
public function subscribe(Dispatcher $events)
|
||||||
|
{
|
||||||
|
$events->listen(RegisterLocales::class, __CLASS__.'@addLocale');
|
||||||
|
$events->listen(BuildClientView::class, __CLASS__.'@addAssets');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function addLocale(RegisterLocales $event)
|
||||||
|
{
|
||||||
|
$event->addTranslations('en', __DIR__.'/../../locale/en.yml');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function addAssets(BuildClientView $event)
|
||||||
|
{
|
||||||
|
$event->forumAssets([
|
||||||
|
__DIR__.'/../../js/dist/extension.js',
|
||||||
|
__DIR__.'/../../less/extension.less'
|
||||||
|
]);
|
||||||
|
|
||||||
|
$event->forumBootstrapper('sticky/main');
|
||||||
|
|
||||||
|
$event->forumTranslations([
|
||||||
|
'sticky.discussion_stickied_notification',
|
||||||
|
'sticky.discussion_stickied_post',
|
||||||
|
'sticky.discussion_unstickied_post',
|
||||||
|
'sticky.notify_discussion_stickied',
|
||||||
|
'sticky.stickied',
|
||||||
|
'sticky.sticky',
|
||||||
|
'sticky.unsticky'
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
71
extensions/sticky/src/Listeners/NotifyDiscussionStickied.php
Executable file
71
extensions/sticky/src/Listeners/NotifyDiscussionStickied.php
Executable file
@@ -0,0 +1,71 @@
|
|||||||
|
<?php namespace Flarum\Sticky\Listeners;
|
||||||
|
|
||||||
|
use Flarum\Events\RegisterPostTypes;
|
||||||
|
use Flarum\Events\RegisterNotificationTypes;
|
||||||
|
use Flarum\Sticky\Posts\DiscussionStickiedPost;
|
||||||
|
use Flarum\Sticky\Notifications\DiscussionStickiedBlueprint;
|
||||||
|
use Flarum\Sticky\Events\DiscussionWasStickied;
|
||||||
|
use Flarum\Sticky\Events\DiscussionWasUnstickied;
|
||||||
|
use Flarum\Core\Notifications\NotificationSyncer;
|
||||||
|
use Flarum\Core\Discussions\Discussion;
|
||||||
|
use Flarum\Core\Users\User;
|
||||||
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
|
|
||||||
|
class NotifyDiscussionStickied
|
||||||
|
{
|
||||||
|
protected $notifications;
|
||||||
|
|
||||||
|
public function __construct(NotificationSyncer $notifications)
|
||||||
|
{
|
||||||
|
$this->notifications = $notifications;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function subscribe(Dispatcher $events)
|
||||||
|
{
|
||||||
|
$events->listen(RegisterPostTypes::class, __CLASS__.'@registerPostType');
|
||||||
|
$events->listen(RegisterNotificationTypes::class, __CLASS__.'@registerNotificationType');
|
||||||
|
$events->listen(DiscussionWasStickied::class, __CLASS__.'@whenDiscussionWasStickied');
|
||||||
|
$events->listen(DiscussionWasUnstickied::class, __CLASS__.'@whenDiscussionWasUnstickied');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function registerPostType(RegisterPostTypes $event)
|
||||||
|
{
|
||||||
|
$event->register('Flarum\Sticky\Posts\DiscussionStickiedPost');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function registerNotificationType(RegisterNotificationTypes $event)
|
||||||
|
{
|
||||||
|
$event->register(
|
||||||
|
'Flarum\Sticky\Notifications\DiscussionStickiedBlueprint',
|
||||||
|
'Flarum\Api\Serializers\DiscussionBasicSerializer',
|
||||||
|
['alert']
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function whenDiscussionWasStickied(DiscussionWasStickied $event)
|
||||||
|
{
|
||||||
|
$this->stickyChanged($event->discussion, $event->user, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function whenDiscussionWasUnstickied(DiscussionWasUnstickied $event)
|
||||||
|
{
|
||||||
|
$this->stickyChanged($event->discussion, $event->user, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function stickyChanged(Discussion $discussion, User $user, $isSticky)
|
||||||
|
{
|
||||||
|
$post = DiscussionStickiedPost::reply(
|
||||||
|
$discussion->id,
|
||||||
|
$user->id,
|
||||||
|
$isSticky
|
||||||
|
);
|
||||||
|
|
||||||
|
$post = $discussion->mergePost($post);
|
||||||
|
|
||||||
|
if ($discussion->start_user_id !== $user->id) {
|
||||||
|
$notification = new DiscussionStickiedBlueprint($post);
|
||||||
|
|
||||||
|
$this->notifications->sync($notification, $post->exists ? [$discussion->startUser] : []);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@@ -1,24 +1,24 @@
|
|||||||
<?php namespace Flarum\Sticky\Handlers;
|
<?php namespace Flarum\Sticky\Listeners;
|
||||||
|
|
||||||
use Flarum\Sticky\Events\DiscussionWasStickied;
|
use Flarum\Sticky\Events\DiscussionWasStickied;
|
||||||
use Flarum\Sticky\Events\DiscussionWasUnstickied;
|
use Flarum\Sticky\Events\DiscussionWasUnstickied;
|
||||||
use Flarum\Core\Events\DiscussionWillBeSaved;
|
use Flarum\Events\DiscussionWillBeSaved;
|
||||||
|
|
||||||
class StickySaver
|
class PersistData
|
||||||
{
|
{
|
||||||
public function subscribe($events)
|
public function subscribe($events)
|
||||||
{
|
{
|
||||||
$events->listen('Flarum\Core\Events\DiscussionWillBeSaved', __CLASS__.'@whenDiscussionWillBeSaved');
|
$events->listen(DiscussionWillBeSaved::class, __CLASS__.'@whenDiscussionWillBeSaved');
|
||||||
}
|
}
|
||||||
|
|
||||||
public function whenDiscussionWillBeSaved(DiscussionWillBeSaved $event)
|
public function whenDiscussionWillBeSaved(DiscussionWillBeSaved $event)
|
||||||
{
|
{
|
||||||
if (isset($event->command->data['isSticky'])) {
|
if (isset($event->data['attributes']['isSticky'])) {
|
||||||
$isSticky = (bool) $event->command->data['isSticky'];
|
$isSticky = (bool) $event->data['attributes']['isSticky'];
|
||||||
$discussion = $event->discussion;
|
$discussion = $event->discussion;
|
||||||
$user = $event->command->user;
|
$actor = $event->actor;
|
||||||
|
|
||||||
$discussion->assertCan($user, 'sticky');
|
$discussion->assertCan($actor, 'sticky');
|
||||||
|
|
||||||
if ((bool) $discussion->is_sticky === $isSticky) {
|
if ((bool) $discussion->is_sticky === $isSticky) {
|
||||||
return;
|
return;
|
||||||
@@ -28,8 +28,8 @@ class StickySaver
|
|||||||
|
|
||||||
$discussion->raise(
|
$discussion->raise(
|
||||||
$discussion->is_sticky
|
$discussion->is_sticky
|
||||||
? new DiscussionWasStickied($discussion, $user)
|
? new DiscussionWasStickied($discussion, $actor)
|
||||||
: new DiscussionWasUnstickied($discussion, $user)
|
: new DiscussionWasUnstickied($discussion, $actor)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
@@ -1,25 +1,33 @@
|
|||||||
<?php namespace Flarum\Sticky\Handlers;
|
<?php namespace Flarum\Sticky\Listeners;
|
||||||
|
|
||||||
use Flarum\Core\Events\DiscussionSearchWillBePerformed;
|
use Flarum\Events\RegisterDiscussionGambits;
|
||||||
use Flarum\Tags\TagGambit;
|
use Flarum\Events\DiscussionSearchWillBePerformed;
|
||||||
|
use Flarum\Tags\Gambits\TagGambit;
|
||||||
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
|
|
||||||
class StickySearchModifier
|
class PinStickiedDiscussionsToTop
|
||||||
{
|
{
|
||||||
public function subscribe($events)
|
public function subscribe(Dispatcher $events)
|
||||||
{
|
{
|
||||||
$events->listen('Flarum\Core\Events\DiscussionSearchWillBePerformed', __CLASS__.'@reorderSearch');
|
$events->listen(RegisterDiscussionGambits::class, __CLASS__.'@registerStickyGambit');
|
||||||
|
$events->listen(DiscussionSearchWillBePerformed::class, __CLASS__.'@reorderSearch');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function registerStickyGambit(RegisterDiscussionGambits $event)
|
||||||
|
{
|
||||||
|
$event->gambits->add('Flarum\Sticky\Gambits\StickyGambit');
|
||||||
}
|
}
|
||||||
|
|
||||||
public function reorderSearch(DiscussionSearchWillBePerformed $event)
|
public function reorderSearch(DiscussionSearchWillBePerformed $event)
|
||||||
{
|
{
|
||||||
if ($event->criteria->sort === null) {
|
if ($event->criteria->sort === null) {
|
||||||
$query = $event->searcher->getQuery();
|
$query = $event->search->getQuery();
|
||||||
|
|
||||||
if (! is_array($query->orders)) {
|
if (! is_array($query->orders)) {
|
||||||
$query->orders = [];
|
$query->orders = [];
|
||||||
}
|
}
|
||||||
|
|
||||||
foreach ($event->searcher->getActiveGambits() as $gambit) {
|
foreach ($event->search->getActiveGambits() as $gambit) {
|
||||||
if ($gambit instanceof TagGambit) {
|
if ($gambit instanceof TagGambit) {
|
||||||
array_unshift($query->orders, ['column' => 'is_sticky', 'direction' => 'desc']);
|
array_unshift($query->orders, ['column' => 'is_sticky', 'direction' => 'desc']);
|
||||||
return;
|
return;
|
||||||
@@ -29,7 +37,7 @@ class StickySearchModifier
|
|||||||
$query->leftJoin('users_discussions', function ($join) use ($event) {
|
$query->leftJoin('users_discussions', function ($join) use ($event) {
|
||||||
$join->on('users_discussions.discussion_id', '=', 'discussions.id')
|
$join->on('users_discussions.discussion_id', '=', 'discussions.id')
|
||||||
->where('discussions.is_sticky', '=', true)
|
->where('discussions.is_sticky', '=', true)
|
||||||
->where('users_discussions.user_id', '=', $event->criteria->user->id);
|
->where('users_discussions.user_id', '=', $event->search->getActor()->id);
|
||||||
});
|
});
|
||||||
// might be quicker to do a subquery in the order clause than a join?
|
// might be quicker to do a subquery in the order clause than a join?
|
||||||
array_unshift(
|
array_unshift(
|
@@ -1,8 +1,8 @@
|
|||||||
<?php namespace Flarum\Sticky;
|
<?php namespace Flarum\Sticky\Notifications;
|
||||||
|
|
||||||
use Flarum\Core\Notifications\NotificationAbstract;
|
use Flarum\Core\Notifications\Blueprint;
|
||||||
|
|
||||||
class DiscussionStickiedNotification extends NotificationAbstract
|
class DiscussionStickiedBlueprint implements Blueprint
|
||||||
{
|
{
|
||||||
protected $post;
|
protected $post;
|
||||||
|
|
||||||
@@ -11,16 +11,16 @@ class DiscussionStickiedNotification extends NotificationAbstract
|
|||||||
$this->post = $post;
|
$this->post = $post;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getSubject()
|
|
||||||
{
|
|
||||||
return $this->post->discussion;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function getSender()
|
public function getSender()
|
||||||
{
|
{
|
||||||
return $this->post->user;
|
return $this->post->user;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function getSubject()
|
||||||
|
{
|
||||||
|
return $this->post->discussion;
|
||||||
|
}
|
||||||
|
|
||||||
public function getData()
|
public function getData()
|
||||||
{
|
{
|
||||||
return ['postNumber' => (int) $this->post->number];
|
return ['postNumber' => (int) $this->post->number];
|
||||||
@@ -33,6 +33,6 @@ class DiscussionStickiedNotification extends NotificationAbstract
|
|||||||
|
|
||||||
public static function getSubjectModel()
|
public static function getSubjectModel()
|
||||||
{
|
{
|
||||||
return 'Flarum\Core\Models\Discussion';
|
return 'Flarum\Core\Discussions\Discussion';
|
||||||
}
|
}
|
||||||
}
|
}
|
@@ -1,35 +1,33 @@
|
|||||||
<?php namespace Flarum\Sticky;
|
<?php namespace Flarum\Sticky\Posts;
|
||||||
|
|
||||||
use Flarum\Core\Models\Model;
|
use Flarum\Core\Posts\Post;
|
||||||
use Flarum\Core\Models\EventPost;
|
use Flarum\Core\Posts\EventPost;
|
||||||
|
use Flarum\Core\Posts\MergeablePost;
|
||||||
|
|
||||||
class DiscussionStickiedPost extends EventPost
|
class DiscussionStickiedPost extends EventPost implements MergeablePost
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* The type of post this is, to be stored in the posts table.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
public static $type = 'discussionStickied';
|
public static $type = 'discussionStickied';
|
||||||
|
|
||||||
/**
|
public function saveAfter(Post $previous)
|
||||||
* Merge the post into another post of the same type.
|
|
||||||
*
|
|
||||||
* @param \Flarum\Core\Models\DiscussionRenamedPost $previous
|
|
||||||
* @return \Flarum\Core\Models\Model|null The final model, or null if the
|
|
||||||
* previous post was deleted.
|
|
||||||
*/
|
|
||||||
protected function mergeInto(Model $previous)
|
|
||||||
{
|
{
|
||||||
if ($this->user_id === $previous->user_id) {
|
// If the previous post is another 'discussion stickied' post, and it's
|
||||||
|
// by the same user, then we can merge this post into it. If we find
|
||||||
|
// that we've in fact reverted the sticky status, delete it. Otherwise,
|
||||||
|
// update its content.
|
||||||
|
if ($previous instanceof static && $this->user_id === $previous->user_id) {
|
||||||
if ($previous->content['sticky'] != $this->content['sticky']) {
|
if ($previous->content['sticky'] != $this->content['sticky']) {
|
||||||
return;
|
$previous->delete();
|
||||||
|
} else {
|
||||||
|
$previous->content = $this->content;
|
||||||
|
|
||||||
|
$previous->save();
|
||||||
}
|
}
|
||||||
|
|
||||||
$previous->content = $this->content;
|
|
||||||
return $previous;
|
return $previous;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$this->save();
|
||||||
|
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
@@ -1,41 +0,0 @@
|
|||||||
<?php namespace Flarum\Sticky;
|
|
||||||
|
|
||||||
use Flarum\Support\ServiceProvider;
|
|
||||||
use Flarum\Extend;
|
|
||||||
|
|
||||||
class StickyServiceProvider extends ServiceProvider
|
|
||||||
{
|
|
||||||
public function boot()
|
|
||||||
{
|
|
||||||
$this->extend(
|
|
||||||
new Extend\EventSubscriber([
|
|
||||||
'Flarum\Sticky\Handlers\StickySaver',
|
|
||||||
'Flarum\Sticky\Handlers\StickySearchModifier',
|
|
||||||
'Flarum\Sticky\Handlers\DiscussionStickiedNotifier'
|
|
||||||
]),
|
|
||||||
|
|
||||||
(new Extend\ForumClient())
|
|
||||||
->assets([
|
|
||||||
__DIR__.'/../js/dist/extension.js',
|
|
||||||
__DIR__.'/../less/sticky.less'
|
|
||||||
]),
|
|
||||||
|
|
||||||
new Extend\PostType('Flarum\Sticky\DiscussionStickiedPost'),
|
|
||||||
|
|
||||||
(new Extend\ApiSerializer('Flarum\Api\Serializers\DiscussionSerializer'))
|
|
||||||
->attributes(function (&$attributes, $model, $user) {
|
|
||||||
$attributes['isSticky'] = (bool) $model->is_sticky;
|
|
||||||
$attributes['canSticky'] = (bool) $model->can($user, 'sticky');
|
|
||||||
}),
|
|
||||||
|
|
||||||
// include discussion start posts by default
|
|
||||||
(new Extend\ApiAction('Flarum\Api\Actions\Discussions\IndexAction'))
|
|
||||||
->addInclude('startPost'),
|
|
||||||
|
|
||||||
new Extend\DiscussionGambit('Flarum\Sticky\StickyGambit'),
|
|
||||||
|
|
||||||
(new Extend\NotificationType('Flarum\Sticky\DiscussionStickiedNotification', 'Flarum\Api\Serializers\DiscussionBasicSerializer'))
|
|
||||||
->enableByDefault('alert')
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
Reference in New Issue
Block a user