Make my extension better? (fof upload template)

datlechin

010101 Flarum and the extension can't boot

Here https://github.com/zerosonesfun/flarum-essential-audio/blob/main/composer.json#L31

Maybe you forgot the namespace

010101

datlechin Oh. This might be it. Thanks a lot! I knew namespaces were needed in other files, but I didn’t know it was that important in the composer.json file. I’ll report back later if that’s the problem.

010101

datlechin Well, I will look at this for a little bit longer, but that did not 100% get it working. That did solve my boot error, so thank you!! But, the template isn't showing in the upload extension settings. Maybe I can still push the changes later to GitHub so people can see. I'm probably missing something else very simple.

010101

Everything loads now, but Upload extension isn't detecting a new template. Here is what is in my src/Upload/AudioServiceProvider.php file (and I did try to instead put the provider part in a separate PHP file, that didn't seem to make a difference). And this works if put in the forum's local/main extend.php file instead. 🤯

<?php

namespace ZerosOnesFun\EssentialAudio\Upload;

use Flarum\Foundation\AbstractServiceProvider;
use FoF\Upload\Contracts\Template;
use FoF\Upload\File;
use FoF\Upload\Helpers\Util;

class AudioTemplate implements Template
{
    public function tag(): string
    {
        return 'aux';
    }

    public function name(): string
    {
        return 'Audio template';
    }

    public function description(): string
    {
        return 'Audio template to use with Essential Audio';
    }

    public function preview(File $file): string
    {
        return '[play]' . $file->url . '[/play]';
    }
}

class AudioServiceProvider extends AbstractServiceProvider
{
    public function register()
    {
        $this->container->make(Util::class)->addRenderTemplate($this->container->make(AudioTemplate::class));
    }
}

Extension's extend file:

<?php

namespace ZerosOnesFun\EssentialAudio;

use Flarum\Extend;
use s9e\TextFormatter\Configurator;

return [
    (new Extend\Frontend('forum'))
        ->js(__DIR__.'/js/dist/forum.js')
        ->css(__DIR__.'/resources/less/forum.less'),
    
    new Extend\Locales(__DIR__ . '/resources/locale'),

    (new Extend\Formatter)
    ->configure(function (Configurator $config) {
        $config->BBCodes->addCustom(
            '[play]{URL}[/play]',
            '<div id="player_box">
            <div>
                <div class="essential_audio" data-url="{URL}"><span class="no_js"><a href="#" onClick="window.location.href=window.location.href">refresh to play</a></span></div>
            </div>
        </div>'
        );
    }),
    (new Extend\ServiceProvider())
    ->register(Upload\AudioServiceProvider::class)
];

datlechin

010101 can u push them to your repo?

010101

datlechin Ok, done. https://github.com/zerosonesfun/flarum-essential-audio

My vision is blurry at this point. I'm seeing double. 🤪

datlechin

Are you getting this error?

Flarum encountered a boot error (Flarum\Extension\Exception\ExtensionBootError)

010101

datlechin No errors anymore. I was getting a boot error, but updating the namespace fixed that.

With no more errors, I'm really stuck because I have nothing to point me in the right direction.

I'm not going to worry about it right now. I do not need this for my forum. I was just trying to do it for the community. Many people want an audio extension that works with the upload extension.

datlechin

010101 I have a PR to your repo

datlechin

datlechin it will solve your issue

010101

datlechin Are you serious!? OMG.

First of all, thank you so much. I might cry because I spent all day yesterday on this. If it wasn't for you, I might never learn about these little composer.json issues.

But second, why did the composer gods make things so sensitive? Composer/PHP devs can't make it smart enough to not care about that?

You win my favorite person of the year award.

For anyone else, I spent a day trying to add something small to my extension. It wasn't working because of my composer.json file. I needed to fix a namespace, and then require fof/upload and flarum/bbcode.

This was the main issue (in case it helps anyone else down the road):

WRONG:

  "require": {
      "flarum/core": "^0.1.0-beta.16 || ^1.0"
  },
  "autoload": {
      "psr-4": {
          "ZerosOnesFun\\TypoHere\\": "src/"
      }

CORRECT:

  "require": {
      "flarum/core": "^0.1.0-beta.16 || ^1.0",
      "fof/upload": "*",
      "flarum/bbcode": "*"
  },
  "autoload": {
      "psr-4": {
          "ZerosOnesFun\\EssentialAudio\\": "src/"
      }

datlechin

010101 But second, why did the composer gods make things so sensitive? Composer/PHP devs can't make it smart enough to not care about that?

It cannot find fof/upload's file php source in your extension.
So you need to install fof/upload extension to use it.

use FoF\Upload\Contracts\Template;
use FoF\Upload\File;
use FoF\Upload\Helpers\Util;

I'm not very good at English, so I can't explain better.

clarkwinkelmann

I have updated the wiki page to include a note about extension requirements https://github.com/FriendsOfFlarum/upload/wiki/Custom-Templates

Don't forget to add fof/upload as either a dependency (* version is fine) or an optional dependency to your extension in composer.json, to ensure your service provider runs after FoF Upload's own service providers.

It's not absolutely necessary to use require. Flarum's optional dependency system can also be used if you don't want to force people to download (and enable!) FoF Upload.

I assume the reason nothing was happening in your situation is because if $this->container->make(Util::class) is called before FoF Upload has booted, it creates a new class that isn't a singleton, so it just adds the template to a new instance of the Util class which is then discarded immediately since it's not stored. Only after FoF Upload boots does the class becomes a singleton in the container, so calling the code adds a template to the existing global instance of the class.

luceos

010101 I know developers do not like to do this

So far every developer on discuss has been willing to assist. But none of them will proactively check your repository and provide pull requests unless there's something to gain for them. Regardless of that, if you ask people they usually are very helpful. Questions like these on the dev tag or directly asking people will usually be very fruitful. Especially these discussions are bound to gather the attention you need to get an answer; unless it's a question exceptionally hard to answer.

I'm glad you got this resolved and as @clarkwinkelmann suggest, it would probably be better to define an optional dependency, in addition to the require. Because the optional dependency enforces loading order.

We are here to help you, even if it takes more than a few hours to get back to you 💗 !

010101

luceos Thanks, understood. I think my original post comes from posting a couple times and not getting help. But, also, from asking for help at other forums in the past and not getting help. It's common for a developer to just say, read the docs. Sometimes that helps, but sometimes an average person like me reads the docs and still doesn't get it. In this case, the optional dependency thing is pretty clear.