@flarum/cli 2.0.2 → 3.0.1

package/boilerplate/stubs/backend/handler/command.php

@@ -5,26 +5,12 @@ namespace <%= classNamespace %>;
 use Flarum\User\User;
 
 class <%= className %>
-{<% if (!['create', 'none'].includes(classType)) { %>
-    /**
-     * @var int
-     */
-    public $modelId;
+{
+    public function __construct(<% if (!['create', 'none'].includes(classType)) { %>
+        public int $modelId;
 <% } %>
-    /**
-     * @var \Flarum\User\User
-     */
-    public $actor;
-
-    /**
-     * @var array
-     */
-    public $data;
-
-    public function __construct(<%= !['create', 'none'].includes(classType) ? '$modelId, ' : '' %>User $actor, array $data)
-    {<% if (!['create', 'none'].includes(classType)) { %>
-        $this->modelId = $modelId;<% } %>
-        $this->actor = $actor;
-        $this->data = $data;
+        public User $actor;
+        public array $data;
+    ) {
     }
 }

package/boilerplate/stubs/backend/handler/handler.php

@@ -5,22 +5,14 @@ namespace <%= classNamespace %>;
 use Illuminate\Support\Arr;<% if (locals.repositoryClassName) { %>
 use <%= repositoryClass %>;<% } %><% if (locals.validatorClassName) { %>
 use <%= validatorClass %>;<% } %>
-<% const dependencies = [locals.repositoryClassName && [repositoryClassName, 'repository'] || null, locals.validatorClassName && [validatorClassName, 'validator'] || null].filter(item => item !== null) %>
+
 class <%= className %>
-{<% if (locals.repositoryClassName) { %>
-    /**
-     * @var <%= repositoryClassName %>
-     */
-    protected $repository;
+{
+    public function __construct(<% if (locals.repositoryClassName) { %>
+        protected <%= repositoryClassName %> $repository;
 <% } %><% if (locals.validatorClassName) { %>
-    /**
-     * @var <%= validatorClassName %>
-     */
-    protected $validator;
-<% } %>
-    public function __construct(<%= dependencies.map(item => `${item[0]} $${item[1]}`).join(', ') %>)
-    {
-        <%- dependencies.map(item => `$this->${item[1]} = $${item[1]};`).join("\n\t\t") %>
+        protected <%= validatorClassName %> $validator;
+<% } %>) {
     }
 
     public function handle(<%= handlerCommandClassName %> $command)

package/boilerplate/stubs/backend/integration-test.php

@@ -3,8 +3,11 @@
 namespace <%= classNamespace %>;
 
 use Carbon\Carbon;
+use Flarum\Discussion\Discussion;
 use Flarum\Testing\integration\RetrievesAuthorizedUsers;
 use Flarum\Testing\integration\TestCase;
+use Flarum\User\User;
+use PHPUnit\Framework\Attributes\Test;
 
 class <%= className %> extends TestCase
 {
@@ -17,18 +20,18 @@ class <%= className %> extends TestCase
         $this->extension('<%= extensionId %>');
 
         $this->prepareDatabase([
-            'users' => [
-                ['id' => 1, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1],
+            User::class => [
+                ['id' => 3, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1],
             ],
-            'discussions' => [
-                ['id' => 1, 'title' => __CLASS__, 'created_at' => Carbon::now(), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1],
+            Discussion::class => [
+                ['id' => 1, 'title' => __CLASS__, 'created_at' => Carbon::now(), 'last_posted_at' => Carbon::now(), 'user_id' => 3, 'first_post_id' => 1, 'comment_count' => 1],
             ],
         ]);
     }
 
-    /** @test */
-    public function test_works()
+    #[Test]
+    public function works_as_expected()
     {
-        // See https://docs.flarum.org/extend/testing.html#backend-tests for more information.
+        // See https://docs.flarum.org/2.x/extend/testing.html#backend-tests for more information.
     }
 }

package/boilerplate/stubs/backend/job.php

@@ -2,22 +2,17 @@
 
 namespace <%= classNamespace %>;
 
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\SerializesModels;
+use Flarum\Queue\AbstractJob;
 
-class <%= className %> implements ShouldQueue
+class <%= className %>
 {
-    use Queueable;
-    use SerializesModels;
-
-    public function __construct()
-    {
-        // ...
+    public function __construct(
+        //
+    ) {
     }
 
     public function handle()
     {
-        // See https://laravel.com/docs/8.x/queues for more information.
+        // See https://laravel.com/docs/11.x/queues for more information.
     }
 }

package/boilerplate/stubs/backend/mail-driver.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Settings\SettingsRepositoryInterface;
+use Illuminate\Contracts\Validation\Factory;
+use Illuminate\Support\MessageBag;
+use Symfony\Component\Mailer\Transport\Dsn;
+use Symfony\Component\Mailer\Transport\TransportInterface;
+
+class <%= className %> implements DriverInterface
+{
+    public function availableSettings(): array
+    {
+        return [
+            //
+        ];
+    }
+
+    public function validate(SettingsRepositoryInterface $settings, Factory $validator): MessageBag
+    {
+        return $validator->make($settings->all(), [
+            //
+        ])->errors();
+    }
+
+    public function canSend(): bool
+    {
+        return true;
+    }
+
+    public function buildTransport(SettingsRepositoryInterface $settings): TransportInterface
+    {
+        //
+    }
+}

package/boilerplate/stubs/backend/middleware.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Post\Exception\FloodingException;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Psr\Http\Server\MiddlewareInterface as Middleware;
+use Psr\Http\Server\RequestHandlerInterface as Handler;
+
+class <%= className %> implements Middleware
+{
+    public function process(Request $request, Handler $handler): Response
+    {
+        // do something with the request
+
+        return $handler->handle($request);
+    }
+}

package/boilerplate/stubs/backend/model.php

@@ -8,7 +8,7 @@ use Flarum\Foundation\EventGeneratorTrait;
 
 class <%= className %> extends AbstractModel
 {
-    // See https://docs.flarum.org/extend/models.html#backend-models for more information.
+    // See https://docs.flarum.org/2.x/extend/models.html#backend-models for more information.
     <% if (tableName) { %>
     protected $table = '<%= tableName %>';<% } %>
 }

package/boilerplate/stubs/backend/notification-blueprint.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Database\AbstractModel;
+use Flarum\Notification\Blueprint\BlueprintInterface;
+use Flarum\Notification\AlertableInterface;
+// use Flarum\Notification\MailableInterface;
+use Flarum\User\User;
+
+class <%= className %> implements BlueprintInterface, AlertableInterface/*, MailableInterface*/
+{
+    public function __construct(
+
+    ) {
+    }
+
+    public function getFromUser(): ?User
+    {
+        // @TODO: implement
+    }
+
+    public function getSubject(): ?AbstractModel
+    {
+        // @TODO: implement
+    }
+
+    public function getData(): array
+    {
+        return [];
+    }
+
+    public static function getType(): string
+    {
+        return '<%= type %>';
+    }
+
+    public static function getSubjectModel(): string
+    {
+        // @TODO: implement
+    }
+}

package/boilerplate/stubs/backend/notification-driver.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Notification\Blueprint\BlueprintInterface;
+use Flarum\Notification\Driver\NotificationDriverInterface;
+use Illuminate\Contracts\Queue\Queue;
+use <%= packageNamespace %>\Jobs\SendNotificationsJob;
+
+class <%= className %> implements NotificationDriverInterface
+{
+    public function __construct(
+        protected Queue $queue
+    ) {
+    }
+
+    public function send(BlueprintInterface $blueprint, array $users): void
+    {
+        // The `send` method is responsible for determining any notifications need to be sent.
+        // If not (for example, if there are no users to send to), there's no point in scheduling a job.
+        // We HIGHLY recommend that notifications are sent via a queue job for performance reasons.
+        if (count($users)) {
+            $this->queue->push(new SendNotificationsJob($blueprint, $users));
+        }
+    }
+
+    public function registerType(string $blueprintClass, array $driversEnabledByDefault): void
+    {
+        // This method is generally used to register a user preference for this notification.
+        // This is optional.
+    }
+}

package/boilerplate/stubs/backend/policy.php

@@ -10,6 +10,6 @@ class <%= className %> extends AbstractPolicy
 {
     public function can(User $actor, string $ability, <%= modelClassName %> $model)
     {
-        // See https://docs.flarum.org/extend/authorization.html#custom-policies for more information.
+        // See https://docs.flarum.org/2.x/extend/authorization.html#custom-policies for more information.
     }
 }

package/boilerplate/stubs/backend/post-type.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Carbon\Carbon;
+use Flarum\Post\AbstractEventPost;
+use Flarum\Post\MergeableInterface; // implement if a new post type can be merged into a previous one.
+use Flarum\Post\Post;
+
+class <%= className %> extends AbstractEventPost
+{
+    public static string $type = '<%= postType %>';
+
+    /*
+     * Use this method to create the new post type.
+     */
+    public static function reply(int $discussionId, int $userId): static
+    {
+        $post = new static;
+
+        $post->content = static::buildContent();
+        $post->created_at = Carbon::now();
+        $post->discussion_id = $discussionId;
+        $post->user_id = $userId;
+
+        return $post;
+    }
+
+    public static function buildContent(): array
+    {
+        return [
+            // Add the content of the post type here.
+        ];
+    }
+}

package/boilerplate/stubs/backend/repository.php

@@ -8,20 +8,12 @@ use <%= modelClass %>;
 
 class <%= className %>
 {
-    /**
-     * @return Builder
-     */
-    public function query()
+    public function query(): Builder
     {
         return <%= modelClassName %>::query();
     }
 
-    /**
-     * @param int $id
-     * @param User $actor
-     * @return <%= modelClassName %>
-     */
-    public function findOrFail($id, User $actor = null): <%= modelClassName %>
+    public function findOrFail(int|string $id, User $actor = null): <%= modelClassName %>
     {
         return <%= modelClassName %>::findOrFail($id);
     }

package/boilerplate/stubs/backend/search/driver.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Search\AbstractDriver;
+
+class <%= className %> extends AbstractDriver
+{
+    public static function name(): string
+    {
+        return '<%= driverName %>';
+    }
+}

package/boilerplate/stubs/backend/search/searcher.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace <%= classNamespace %>;
+
+use Flarum\Search\Filter\FilterManager;
+use Flarum\Search\SearchCriteria;
+use Flarum\Search\SearcherInterface;
+use Flarum\Search\SearchResults;
+use Flarum\Search\SearchState;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+
+abstract class <%= className %> implements SearcherInterface
+{
+    public function __construct(
+        protected FilterManager $filters,
+        /** @var array<callable> */
+        protected array $mutators
+    ) {
+    }
+
+    public function search(SearchCriteria $criteria): SearchResults
+    {
+        $state = new SearchState($criteria->actor, $criteria->isFulltext());
+
+        $this->filters->apply($state, $criteria->filters);
+
+        $this->applySort($state, $criteria);
+
+        foreach ($this->mutators as $mutator) {
+            $mutator($state, $criteria);
+        }
+
+        // $records = ...
+        // $totalCount = ...
+        // $areMoreResults = ...
+
+        return new SearchResults($records, $areMoreResults, fn () => $totalCount);
+    }
+}

package/boilerplate/stubs/backend/service-provider.php

@@ -9,7 +9,7 @@ class <%= className %> extends AbstractServiceProvider
 {
     public function register()
     {
-        // See https://docs.flarum.org/extend/service-provider.html#service-provider for more information.
+        // See https://docs.flarum.org/2.x/extend/service-provider.html#service-provider for more information.
     }
 
     public function boot(Container $container)

package/boilerplate/stubs/backend/validator.php

@@ -10,6 +10,6 @@ class <%= className %> extends AbstractValidator
      * {@inheritdoc}
      */
     protected $rules = [
-        // See https://laravel.com/docs/8.x/validation#available-validation-rules for more information.
+        // See https://laravel.com/docs/11.x/validation#available-validation-rules for more information.
     ];
 }

package/boilerplate/stubs/frontend/component.js

@@ -16,7 +16,7 @@ export default class <%= className %> extends Component {
   view() {
     return (
       <div className="<%= className %>">
-        // See https://docs.flarum.org/extend/frontend.html#components for more information.
+        {/* See https://docs.flarum.org/2.x/extend/frontend.html#components for more information. */}
       </div>
     );
   }

package/boilerplate/stubs/frontend/forum-page.js

@@ -0,0 +1,68 @@
+import app from 'flarum/forum/app';
+import Page from 'flarum/common/components/Page';
+import PageStructure from 'flarum/forum/components/PageStructure';
+import IndexSidebar from 'flarum/forum/components/IndexSidebar';
+import listItems from 'flarum/common/helpers/listItems';
+import ItemList from 'flarum/common/utils/ItemList';
+
+export default class <%= className %> extends Page {
+  loading = false;
+
+  oninit(vnode) {
+    super.oninit(vnode);
+
+    const title = app.translator.trans('<%= extensionId %>.forum.<%= pathName %>.title', {}, true);
+
+    app.setTitle(title);
+    app.history.push('<%= pathName %>', title);
+  }
+
+  view() {
+    return (
+      <PageStructure
+        className="<%= className %>"
+        loading={this.loading}
+        hero={this.hero.bind(this)}
+        sidebar={() => <IndexSidebar />}
+        // sidebar={this.sidebar.bind(this)}
+      >
+        {this.loading || (
+          <div className="<%= className %>-content">
+            {app.translator.trans('<%= extensionId %>.forum.<%= pathName %>.content')}
+          </div>
+        )}
+      </PageStructure>
+    );
+  }
+
+  hero() {
+    return (
+      <header className="Hero <%= className %>Hero">
+        <div className="container">
+          <div className="containerNarrow">
+            <h1 className="Hero-title">
+              {app.translator.trans('<%= extensionId %>.forum.<%= pathName %>.hero.title')}
+            </h1>
+            <div className="Hero-subtitle">
+              {app.translator.trans('<%= extensionId %>.forum.<%= pathName %>.hero.subtitle')}
+            </div>
+          </div>
+        </div>
+      </header>
+    );
+  }
+
+  // sidebar() {
+  //   return (
+  //     <nav className="<%= className %>-nav">
+  //       <ul>{listItems(this.sidebarItems().toArray())}</ul>
+  //     </nav>
+  //   );
+  // }
+  //
+  // sidebarItems() {
+  //   const items = new ItemList();
+  //
+  //   return items;
+  // }
+}

package/boilerplate/stubs/frontend/gambit/boolean.js

@@ -0,0 +1,12 @@
+import app from 'flarum/<%= frontend %>/app';
+import { BooleanGambit } from 'flarum/common/query/IGambit';
+
+export default class <%= className %> extends BooleanGambit {
+  key() {
+    return app.translator.trans('<%= extensionId %>.lib.gambits.<%= filterKey %>.key', {}, true);
+  }
+
+  filterKey() {
+    return '<%= filterKey %>';
+  }
+}

package/boilerplate/stubs/frontend/gambit/key-value.js

@@ -0,0 +1,16 @@
+import app from 'flarum/<%= frontend %>/app';
+import { KeyValueGambit } from 'flarum/common/query/IGambit';
+
+export default class <%= className %> extends KeyValueGambit {
+  key() {
+    return app.translator.trans('<%= extensionId %>.lib.gambits.<%= filterKey %>.key', {}, true);
+  }
+
+  hint() {
+    return app.translator.trans('<%= extensionId %>.lib.gambits.<%= filterKey %>.hint', {}, true);
+  }
+
+  filterKey() {
+    return '<%= filterKey %>';
+  }
+}

package/boilerplate/stubs/frontend/modal.js

@@ -12,7 +12,7 @@ export default class <%= className %> extends Modal {
   content() {
     return (
       <div className="Modal-body">
-        // See https://docs.flarum.org/extend/interactive-components.html#modals for more information.
+        // See https://docs.flarum.org/2.x/extend/interactive-components.html#modals for more information.
       </div>
     );
   }

package/boilerplate/stubs/frontend/model.js

@@ -1,7 +1,7 @@
 import Model from 'flarum/common/Model';
 
 // For more details about frontend models
-// checkout https://docs.flarum.org/extend/models.html#frontend-models
+// checkout https://docs.flarum.org/2.x/extend/models.html#frontend-models
 
 export default class <%= className %> extends Model {
   title = Model.attribute('title');

package/boilerplate/stubs/frontend/notification.js

@@ -0,0 +1,22 @@
+import app from 'flarum/forum/app';
+import Notification from 'flarum/forum/components/Notification';
+
+export default class <%= className %> extends Notification {
+  icon() {
+    // return 'fas fa-???';
+  }
+
+  href() {
+    const notification = this.attrs.notification;
+
+    // return ...;
+  }
+
+  content() {
+    return app.translator.trans('<%= extensionId %>.forum.notifications.<%= type %>_text', { user: this.attrs.notification.fromUser() });
+  }
+
+  excerpt() {
+    return null;
+  }
+}

package/boilerplate/stubs/frontend/post-type.js

@@ -0,0 +1,13 @@
+import EventPost from 'flarum/forum/components/EventPost';
+
+export default class DiscussionStickiedPost extends EventPost {
+  icon() {
+    return 'fas fa-???';
+  }
+
+  descriptionKey() {
+    const content = this.attrs.post.content();
+
+    return '<%= extensionId %>.forum.post_stream.<%= postType %>_text';
+  }
+}

package/boilerplate/stubs/migration.php

@@ -5,7 +5,7 @@ use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Schema\Builder;
 
 // HINT: you might want to use a `Flarum\Database\Migration` helper method for simplicity!
-// See https://docs.flarum.org/extend/models.html#migrations to learn more about migrations.
+// See https://docs.flarum.org/2.x/extend/models.html#migrations to learn more about migrations.
 return [
     'up' => function (Builder $schema) {
         // up migration

package/boilerplate/stubs/views/email/html/information.blade.php

@@ -0,0 +1,8 @@
+<x-mail::html.information>
+    <x-slot:body>
+        <% if (!content) { %>        <!-- Required content -->
+        <% } else { %>        <%- content %><% } %>
+    </x-slot:body>
+
+    <x-slot:preview><!-- Optional content --></x-slot:preview>
+</x-mail::html.information>

package/boilerplate/stubs/views/email/html/notification.blade.php

@@ -0,0 +1,8 @@
+<x-mail::html.notification>
+    <x-slot:body>
+<% if (!content) { %>        <!-- Required content -->
+<% } else { %>        <%- content %><% } %>
+    </x-slot:body>
+
+    <x-slot:preview><!-- Optional content --></x-slot:preview>
+</x-mail::html.notification>

package/boilerplate/stubs/views/email/plain/information.blade.php

@@ -0,0 +1,7 @@
+<x-mail::plain.information>
+<x-slot:body>
+<% if (!content) { %><!-- Required content -->
+<% } else { %><%- content %><% } %>
+</x-slot:body>
+</x-mail::plain.information>
+

package/boilerplate/stubs/views/email/plain/notification.blade.php

@@ -0,0 +1,6 @@
+<x-mail::plain.notification>
+<x-slot:body>
+<% if (!content) { %><!-- Required content -->
+<% } else { %><%- content %><% } %>
+</x-slot:body>
+</x-mail::plain.notification>