ExtensionManager  

class ExtensionManager

Properties

protected $config
protected Paths $paths
protected $container
protected $migrator
protected Dispatcher $dispatcher
protected Filesystem $filesystem
protected Collection|null $extensions

Methods

__construct(SettingsRepositoryInterface $config, Paths $paths, Container $container, Migrator $migrator, Dispatcher $dispatcher, Filesystem $filesystem)

No description

Collection
getExtensions()

No description

Extension|null
getExtension(string $name)

Loads an Extension with all information.

enable(string $name)

Enables the extension.

disable(string $name)

Disables an extension.

uninstall(string $name)

Uninstalls an extension.

publishAssets(Extension $extension)

Copy the assets from an extension's assets directory into public view.

unpublishAssets(Extension $extension)

Delete an extension's assets from public view.

string
getAsset(Extension $extension, string $path)

Get the path to an extension's published asset.

Cloud
getAssetsFilesystem()

Get an instance of the assets filesystem.

void
migrate(Extension $extension, string $direction = 'up')

Runs the database migrations for the extension.

array
migrateDown(Extension $extension)

Runs the database migrations to reset the database to its old state.

Migrator
getMigrator()

The database migrator.

array|Extension[]
getEnabledExtensions()

Get only enabled extensions.

extend(Container $container)

Call on all enabled extensions to extend the Flarum application.

array
getEnabled()

The id's of the enabled extensions.

setEnabledExtensions(array $enabledExtensions)

Persist the currently enabled extensions.

bool
isEnabled($extension)

Whether the extension is enabled.

static string[]
pluckTitles(array $exts)

Returns the titles of the extensions passed.

static array
resolveExtensionOrder(Extension[] $extensionList)

Sort a list of extensions so that they are properly resolved in respect to order.

Details

at line 57
__construct(SettingsRepositoryInterface $config, Paths $paths, Container $container, Migrator $migrator, Dispatcher $dispatcher, Filesystem $filesystem)

Parameters

SettingsRepositoryInterface $config
Paths $paths
Container $container
Migrator $migrator
Dispatcher $dispatcher
Filesystem $filesystem

at line 76
Collection getExtensions()

Return Value

Collection

at line 166
Extension|null getExtension(string $name)

Loads an Extension with all information.

Parameters

string $name

Return Value

Extension|null

at line 178
enable(string $name)

Enables the extension.

Parameters

string $name

at line 220
disable(string $name)

Disables an extension.

Parameters

string $name

at line 257
uninstall(string $name)

Uninstalls an extension.

Parameters

string $name

at line 277
protected publishAssets(Extension $extension)

Copy the assets from an extension's assets directory into public view.

Parameters

Extension $extension

at line 287
protected unpublishAssets(Extension $extension)

Delete an extension's assets from public view.

Parameters

Extension $extension

at line 299
string getAsset(Extension $extension, string $path)

Get the path to an extension's published asset.

Parameters

Extension $extension
string $path

Return Value

string

at line 309
protected Cloud getAssetsFilesystem()

Get an instance of the assets filesystem.

This is resolved dynamically because Flarum's filesystem configuration might not be booted yet when the ExtensionManager singleton initializes.

Return Value

Cloud

at line 323
void migrate(Extension $extension, string $direction = 'up')

Runs the database migrations for the extension.

Parameters

Extension $extension
string $direction

Return Value

void

at line 340
array migrateDown(Extension $extension)

Runs the database migrations to reset the database to its old state.

Parameters

Extension $extension

Return Value

array Notes from the migrator.

at line 350
Migrator getMigrator()

The database migrator.

Return Value

Migrator

at line 360
array|Extension[] getEnabledExtensions()

Get only enabled extensions.

Return Value

array|Extension[]

at line 379
extend(Container $container)

Call on all enabled extensions to extend the Flarum application.

Parameters

Container $container

at line 391
array getEnabled()

The id's of the enabled extensions.

Return Value

array

at line 401
protected setEnabledExtensions(array $enabledExtensions)

Persist the currently enabled extensions.

Parameters

array $enabledExtensions

at line 418
bool isEnabled($extension)

Whether the extension is enabled.

Parameters

$extension

Return Value

bool

at line 431
static string[] pluckTitles(array $exts)

Returns the titles of the extensions passed.

Parameters

array $exts

Return Value

string[]

at line 452
static array resolveExtensionOrder(Extension[] $extensionList)

Sort a list of extensions so that they are properly resolved in respect to order.

Effectively just topological sorting.

Parameters

Extension[] $extensionList

Return Value

array with 2 keys: 'valid' points to an ordered array of \Flarum\Extension\Extension 'missingDependencies' points to an associative array of extensions that could not be resolved due to missing dependencies, in the format extension id => array of missing dependency IDs. 'circularDependencies' points to an array of extensions ids of extensions that cannot be processed due to circular dependencies