2.0 development

Justoverclock

Ho, in trying to start to familiarize with Flarum 2.0, but ive noticed that the beta has some error with all’ flarum base extension.

“Cant find undefined app”. Is this normal for now?

Sami (SychO)

Explain further. What steps did you take to get to where you are so far? What's the complete error including the trace.

Justoverclock

1- Installed Flarum 2.0 beta
2- prepared workbench folder for development
3- forked one of my extension to start the upgrade to 2.0

i've commented ALL the frontend and refactored the admin part following the docs

import Extend from 'flarum/common/extenders';
import app from 'flarum/admin/app';

return [
  new Extend.Admin()
    .setting(
      () => ({
        setting: 'acme-interstellar.coordinates', // This is the key the settings will be saved under in the settings table in the database.
        label: app.translator.trans('acme-interstellar.admin.coordinates_label', {}, true), // The label to be shown letting the admin know what the setting does.
        help: app.translator.trans('acme-interstellar.admin.coordinates_help', {}, true), // Optional help text where a longer explanation of the setting can go.
        type: 'boolean', // What type of setting this is, valid options are: boolean, text (or any other <input> tag type), and select. 
      }),
      30 // Optional: Priority
    )
];

And i see this error

i also get this error if i try to edit an user from dashboard (with all extension disabled)

Sami (SychO)

Justoverclock read the last bullet point here about lazy loaded modules: https://docs.flarum.org/2.x/extend/update-2_0/#importing-modules

And the code splitting docs about how to extend lazy loaded core modules: https://docs.flarum.org/2.x/extend/code-splitting/#importing-split-modules-from-core-or-other-extensions

And why not use the automated upgrade command? https://docs.flarum.org/2.x/extend/update-2_0/#upgrade-automation

Justoverclock

Sami (SychO) yes this step is done, but i need to understand how to refactor admin settings

my old code is:

import app from 'flarum/admin/app';


app.initializers.add('ext', () => {
  app.extensionData
    .for('my-extension')
    .registerSetting({

i've refactored with

import app from 'flarum/admin/app';
import Extend from 'flarum/common/extenders';

export { default as extend } from './extend';

app.initializers.add('ext', () => {
  new Extend.Admin()
    .setting(() => ({
      setting: 'ext',
      name: 'ext',
      type: 'number',
      label: app.translator.trans('ext'),
      help: app.translator.trans('ext'),
    }))
    .setting(() => ({
   //...more settings
});

but nothing works, no settings are visible in the extension

it works if i use app.registry, but i do not understand ho to use the extender

Sami (SychO)

the admin settings look fine, the errors you show aren't related to it though, can you upload all your code and link to it?

Justoverclock

Sami (SychO) unfortunately is a private extension, for now i've resolved by using this..

app.initializers.add('my-ext', () => {
  app.registry
    .for('my-ext')
    .registerSetting({

and works fine...not work if i use


import app from 'flarum/admin/app';
import Extend from "flarum/common/extenders";

app.initializers.add('justoverclock/related-discussions', () => {
  new Extend.Admin()
    .setting(() => ({
      setting: 'my-ext',
      name: 'my-ext',
      type: 'number',
      label: app.translator.trans('ext'),
      help: app.translator.trans('ext'),
    }))
});

so something is wrong, no settings are showed with the second method....all works fine with app.registry. (no error in console)

clarkwinkelmann

Justoverclock I have not tried the 2.0 developer API yet, but if it's anything like the discreet JS API that already exists in 1.x and the PHP API, you need to return the extender instances in an array somewhere. Your code is just creating an extender object and doing nothing with it, which I assume is not correct. In 1.x the JS extender API is completely separate from initializers and I assume it's still the case.

Sami (SychO)

Oh I didn't even notice that. Exactly as Clark is saying

Check an example here:

SychO9/gamificationblob/sm%2F2.0/js%2Fsrc%2Fadmin%2Fextend.ts

Justoverclock

oh, thats why...

@Sami (SychO) where can i find some example code to make a controller in the new version of Flarum, i'm trying to do a query to search discussions with the AbstractDatabaseResource (i suppose this is the correct one)

but even following the docs i cant understand well how to use it....here what i have so far

class Example extends AbstractDatabaseResource
{
    public function scope(Builder $query, Context|\Tobyz\JsonApiServer\Context $context): void
    {
        $actor = $context->getActor();

        $title = $context->getParam('q', '');
        if ($title) {
            $query->where('title', 'like', '%' . $title . '%');
        }

        $discussionId = $context->getParam('discussionId', null);

        if ($discussionId) {
            $query->where('id', '!=', $discussionId);
        }
    }

    public function model(): string
    {
        return Discussion::class;
    }

    public function type(): string
    {
        return 'my_discussion_type';
    }
    
    public function endpoints() :array
    {
        return [
            // here i do not know what to import
        ];
    }
}

Sami (SychO)

Upgrade Guide fro the API code: https://docs.flarum.org/2.x/extend/update-2_0-api

Bundled extensions 2.0 code example: flarum/frameworktree/2.x/extensions
Gamification 2.0 code example: SychO9/gamificationtree/sm/2.0
Drafts 2.0 code example: SychO9/byobutree/sm/2.x
Reactions 2.0 code example: SychO9/reactionstree/sm/2.0
Best Answer 2.0 code example: SychO9/best-answertree/sm/2.0

Hope this helps

luceos

Justoverclock i find some example code to make a controller

Remember flarum-cli also has the ability to generate controllers.

Sami (SychO)

Justoverclock also if what you're trying to do is add filters, the right way to do that is to use the search system: https://docs.flarum.org/2.x/extend/search#adding-a-filter--mutator-for-a-searchable-model

Example: flarum/frameworkblob/2.x/extensions/nicknames/src/NicknameFullTextFilter.php

Justoverclock

if i use the cli to make a backend controller, it use the

class MyClass implements RequestHandlerInterface

and not the new AbstractDatabaseResource, is this correcT?

so what i need to know is what is (And how) the best way to make a query to the discussion model into a custom endpoint.

Sami (SychO)

API controllers have been replaced with API Resources:

https://docs.flarum.org/2.x/extend/api/#api-resources

Justoverclock so what i need to know is what is (And how) the best way to make a query to the discussion model into a custom endpoint.

Are you trying to add custom filtering of the discussions? If so you can add a filterer without adding any new endpoints/resource classes.

You can then just use your filter from the js side using the logic:

app.store.find('discussions', { filter: { 'customFilter': true } })