github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2025-05-25 16:19:57 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rework extension bootstrapping

Browse Source 
System JS modules don't execute when they're registered, so we need to
import them explicitly. While we're at it, we may as well make the
locale bootstrapper a module too.
This commit is contained in:
Toby Zerner
2015-07-20 18:08:28 +09:30
parent 19fe138770
commit 6b7cf1b6bf
12 changed files with 130 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
js/forum/Gulpfile.js
View File

@ -30,7 +30,6 @@ gulp({
'src/**/*.js', 'src/**/*.js',
'../lib/**/*.js' '../lib/**/*.js'
], ],
bootstrapFiles: [],
modulePrefix: 'flarum', modulePrefix: 'flarum',
externalHelpers: true, externalHelpers: true,
outputFile: 'dist/app.js' outputFile: 'dist/app.js'

31
src/Events/BuildClientView.php
View File

@ -2,23 +2,24 @@
use Flarum\Support\ClientAction; use Flarum\Support\ClientAction;
use Flarum\Support\ClientView; use Flarum\Support\ClientView;
use Flarum\Forum\Actions\ClientAction as ForumClientAction;
class BuildClientView class BuildClientView
{ {
/** /**
* @var ClientAction * @var ClientAction
*/ */
protected $action; public $action;
/** /**
* @var ClientView * @var ClientView
*/ */
protected $view; public $view;
/** /**
* @var array * @var array
*/ */
protected $keys; public $keys;
/** /**
* @param ClientAction $action * @param ClientAction $action
@ -31,4 +32,26 @@ class BuildClientView
$this->view = $view; $this->view = $view;
$this->keys = &$keys; $this->keys = &$keys;
} }
}
public function forumAssets($files)
{
if ($this->action instanceof ForumClientAction) {
$this->view->getAssets()->addFiles((array) $files);
}
}
public function forumBootstrapper($bootstrapper)
{
if ($this->action instanceof ForumClientAction) {
$this->view->addBootstrapper($bootstrapper);
}
}
public function forumTranslations(array $keys)
{
if ($this->action instanceof ForumClientAction) {
foreach ($keys as $key) {
$this->keys[] = $key;
}
}
}}

5
src/Events/RegisterLocales.php
View File

@ -16,4 +16,9 @@ class RegisterLocales
{ {
$this->manager = $manager; $this->manager = $manager;
} }
public function addTranslations($locale, $file)
{
$this->manager->addTranslations($locale, $file);
}
} }

10
src/Locale/JsCompiler.php
View File

@ -13,14 +13,18 @@ class JsCompiler extends RevisionCompiler
public function compile() public function compile()
{ {
$output = "var initLocale = function(app) { $output = "System.register('locale', [], function() {
app.translator.translations = ".json_encode($this->translations).";"; return {
execute: function() {
app.translator.translations = ".json_encode($this->translations).";\n";
foreach ($this->files as $filename) { foreach ($this->files as $filename) {
$output .= file_get_contents($filename); $output .= file_get_contents($filename);
} }
$output .= "};"; $output .= "}
};
});";
return $output; return $output;
} }

18
src/Support/ClientView.php
View File

@ -47,6 +47,13 @@ class ClientView implements Renderable
*/ */
protected $layout; protected $layout;
/**
* An array of JS modules to import before booting the app.
*
* @var array
*/
protected $bootstrappers = ['locale'];
/** /**
* An array of strings to append to the page's <head>. * An array of strings to append to the page's <head>.
* *
@ -156,6 +163,16 @@ class ClientView implements Renderable
$this->footStrings[] = $string; $this->footStrings[] = $string;
} }
/**
* Add a JavaScript module to be imported before the app is booted.
*
* @param string $string
*/
public function addBootstrapper($string)
{
$this->bootstrappers[] = $string;
}
/** /**
* Get the view's asset manager. * Get the view's asset manager.
* *
@ -196,6 +213,7 @@ class ClientView implements Renderable
$view->head = implode("\n", $this->headStrings); $view->head = implode("\n", $this->headStrings);
$view->foot = implode("\n", $this->footStrings); $view->foot = implode("\n", $this->footStrings);
$view->bootstrappers = $this->bootstrappers;
return $view->render(); return $view->render();
} }

7
stubs/extension/bootstrap.php
View File

@ -4,6 +4,7 @@
// classes in the src directory to be autoloaded. // 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 the name of our Extension class. Flarum will register it as a service
// register bindings and execute code when the application boots. // provider, allowing it to register bindings and execute code when the
return $this->app->register('{{namespace}}\{{classPrefix}}ServiceProvider'); // application boots.
return '{{namespace}}\Extension';

8
stubs/extension/js/bootstrap.js vendored
View File

@ -1,8 +0,0 @@
import { extend, override } from 'flarum/extension-utils';
import app from 'flarum/app';
app.initializers.add('{{name}}', function() {
// @todo
});

4
stubs/extension/js/src/main.js Normal file
View File

@ -0,0 +1,4 @@
import { extend } from 'flarum/extend';
import app from 'flarum/app';
// TODO

27
stubs/extension/src/Extension.php Normal file
View File

@ -0,0 +1,27 @@
<?php namespace {{namespace}};
use Flarum\Support\Extension;
use Illuminate\Events\Dispatcher;
class Extension extends BaseExtension
{
/**
* Bootstrap the application events.
*
* @return void
*/
public function boot(Dispatcher $events)
{
$events->subscribe('{{namespace}}\Listeners\AddClientAssets');
}
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
//
}
}

33
stubs/extension/src/Listeners/AddClientAssets.php Executable file
View File

@ -0,0 +1,33 @@
<?php namespace {{namespace}}\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('{{name}}/main');
$event->forumTranslations([
// '{{name}}.hello_world'
]);
}
}

39
stubs/extension/src/ServiceProvider.php
View File

@ -1,39 +0,0 @@
<?php namespace {{namespace}};
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
class {{classPrefix}}ServiceProvider extends ServiceProvider
{
/**
* Bootstrap the application events.
*
* @return void
*/
public function boot()
{
$this->extend([
(new Extend\Locale('en'))->translations(__DIR__.'/../locale/en.yml'),
(new Extend\ForumClient())
->assets([
__DIR__.'/../js/dist/extension.js',
__DIR__.'/../less/extension.less'
])
->translations([
// Add the keys of translations you would like to be available
// for use by the JS client application.
])
]);
}
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
//
}
}

6
views/app.blade.php
View File

@ -35,7 +35,11 @@
document: {!! json_encode($document) !!}, document: {!! json_encode($document) !!},
session: {!! json_encode($session) !!} session: {!! json_encode($session) !!}
}; };
initLocale(app);
@foreach ($bootstrappers as $bootstrapper)
System.import('{{ $bootstrapper }}');
@endforeach
app.boot(); app.boot();
} catch (e) { } catch (e) {
document.write('<div class="container">Something went wrong.</div>'); document.write('<div class="container">Something went wrong.</div>');