New model

Shpionus

I have a simple task. Add a list of languages.
I created migration, seed some data to table.

I created model ;

<?php

namespace FlarpalTeam\FlarpalAuth;

use Flarum\Database\AbstractModel;

class Language extends AbstractModel
{
    /**
     * {@inheritdoc}
     */
    protected $table = 'languages';

    /**
     * Create a new language.
     *
     * @param string $name
     * @param string $code
     * @param string $alias
     * @return static
     */
    public static function build($name, $code, $alias)
    {
        $lang = new static;

        $lang->name = $name;
        $lang->code = $code;
        $lang->alias = $alias;
        return $lang;
    }
}

Serrializer

<?php

namespace FlarpalTeam\FlarpalAuth\Api\Serializer;

use Flarum\Api\Serializer\AbstractSerializer;


class LanguageSerializer extends AbstractSerializer
{
    /**
     * {@inheritdoc}
     */
    protected $type = 'languages';

    /**
     * {@inheritdoc}
     */
    protected function getDefaultAttributes($language)
    {
        $attributes = [
            'name'    => $language->name,
            'code'    => $language->code,
            'alias'   => $language->alias
        ];

        return $attributes;
    }
}

Controller

<?php

namespace FlarpalTeam\FlarpalAuth\Api\Controller;

use Flarum\Api\Controller\AbstractCollectionController;
use FlarpalTeam\FlarpalAuth\Api\Serializer\LanguageSerializer;
use FlarpalTeam\FlarpalAuth\Language;
use Psr\Http\Message\ServerRequestInterface;
use Tobscure\JsonApi\Document;

class ListLanguagesController extends AbstractCollectionController
{
    /**
     * {@inheritdoc}
     */
    public $serializer = LanguageSerializer::class;

    /**
     * @var \FlarpalTeam\FlarpalAuth\Language
     */
    protected $languages;

    /**
     * @param \FlarpalTeam\FlarpalAuth\Language $languages
     */
    public function __construct(Language $languages)
    {
        $this->languages = $languages;
    }

    /**
     * {@inheritdoc}
     */
    protected function data(ServerRequestInterface $request, Document $document)
    {
        $include = $this->extractInclude($request);
        $languages = $this->languages->all();
        return $languages->load($include);
    }
}

Added routes

<?php

namespace FlarpalTeam\FlarpalAuth\Listener;

use Flarum\Event\ConfigureApiRoutes;
use FlarpalTeam\FlarpalAuth\Api\Controller;
use Illuminate\Contracts\Events\Dispatcher;

class AddLanguagesApi
{
    public function subscribe(Dispatcher $events)
    {
        $events->listen(ConfigureApiRoutes::class, [$this, 'configureApiRoutes']);
    }

    public function configureApiRoutes(ConfigureApiRoutes $event)
    {
        $event->get('/languages', 'languages.index', Controller\ListLanguagesController::class);
    }
}

js store

import Model from 'flarum/Model';
import mixin from 'flarum/utils/mixin';

export default class Language extends mixin(Model, {
  name: Model.attribute('name'),
  code: Model.attribute('code'),
  alias: Model.attribute('alias')
}) {}

But app.store.all('languages') always empty.

Please, help, what I am doing wrong.

luceos

In javascript the app.store.all('languages') will load objects of that type from the javascript cache (store). From your code I see this cache store is not seeded with your existing models.

You could look at how the tags extension is also seeding the Forum with the existing tags:

https://github.com/flarum/flarum-ext-tags/blob/v0.1.0-beta.8/src/Listener/AddForumTagsRelationship.php#L71

Shahiem

Add this to your main.js (Don't forget to import your language model)

    app.store.models['author-languages'] = Language;

You have to make a repository class and create a relationship between your serializer and the forum serializer.
I don't have time to help now, but I'll make a boilerplate extension for you later this day.

Shpionus

Shahiem Thank you. I did this import. Just not mentioned in question.

Shpionus

luceos Thank you, I will check it later.

Shpionus

luceos I checked flarum-ext-tags.
I added AddForumLanguagesRelationship and corresponding subscribe to bootstrap.

<?php

namespace FlarpalTeam\FlarpalAuth\Listener;

use Flarum\Event\GetApiRelationship;
use Flarum\Api\Controller\ShowForumController;
use Flarum\Event\ConfigureApiController;
use FlarpalTeam\FlarpalAuth\Language;
use Illuminate\Contracts\Events\Dispatcher;
use Flarum\Event\PrepareApiData;


class AddForumLanguagesRelationship
{
    /**
     * @param Dispatcher $events
     */
    public function subscribe(Dispatcher $events)
    {
        $events->listen(GetApiRelationship::class, [$this, 'getApiRelationship']);
        $events->listen(PrepareApiData::class, [$this, 'loadLanguagesRelationship']);
        $events->listen(ConfigureApiController::class, [$this, 'includeLanguagesRelationship']);
    }

    public function getApiRelationship(GetApiRelationship $event)
    {
        if ($event->isRelationship(ForumSerializer::class, 'languages')) {
            return $event->serializer->hasMany($event->model, 'FlarpalTeam\FlarpalAuth\Api\Serializer\LanguageSerializer', 'languages');
        }
    }


    /**
     * @param PrepareApiData $event
     */
    public function loadLanguagesRelationship(PrepareApiData $event)
    {
        if ($event->isController(ShowForumController::class)) {
            $event->data['languages'] = Language::all();
        }
    }

    public function includeLanguagesRelationship(ConfigureApiController $event)
    {
        if ($event->isController(ShowForumController::class)) {
            $event->addInclude(['languages']);
        }
    }
}

But result stays same:

01:24:12.814 app.store.all('languages')
01:24:12.817 []
01:24:14.272 app.store.data
01:24:14.275 {forums: {…}, groups: {…}, tags: {…}, users: {…}}

luceos

app.forum.data.attributes

Shpionus

luceos Still does not have any languages. Both store and app.forum.data.attributes.

Shpionus

I found that I missed use Flarum\Api\Serializer\ForumSerializer; in AddForumLanguagesRelationship.php
Right now I have other error:

ReflectionException (-1)
Class FlarpalTeam\FlarpalAuth\Api\Serializer\LanguageSerializer does not exist

luceos

Shpionus you specify that serializer in your relationship listener, does it not exist?

Shpionus

luceos Serializer exists. You can find it's code in question.
I checked namespace - it is correct. So, I can't find a reason of the exception.

Shpionus

Problem is resolved. Stupid mistake in namespace: name of folder in uppercase API, but in namespace copy-past from other project Api.

Thanks.