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.

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 $app)

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($extensionList)

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

Details

at line 56
__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 75
Collection getExtensions()

Return Value

Collection

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

Loads an Extension with all information.

Parameters

string $name

Return Value

Extension|null

at line 157
enable(string $name)

Enables the extension.

Parameters

string $name

at line 197
disable(string $name)

Disables an extension.

Parameters

string $name

at line 233
uninstall(string $name)

Uninstalls an extension.

Parameters

string $name

at line 253
protected publishAssets(Extension $extension)

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

Parameters

Extension $extension

at line 268
protected unpublishAssets(Extension $extension)

Delete an extension's assets from public view.

Parameters

Extension $extension

at line 280
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 292
void migrate(Extension $extension, string $direction = 'up')

Runs the database migrations for the extension.

Parameters

Extension $extension
string $direction

Return Value

void

at line 307
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 317
Migrator getMigrator()

The database migrator.

Return Value

Migrator

at line 327
array|Extension[] getEnabledExtensions()

Get only enabled extensions.

Return Value

array|Extension[]

at line 346
extend(Container $app)

Call on all enabled extensions to extend the Flarum application.

Parameters

Container $app

at line 358
array getEnabled()

The id's of the enabled extensions.

Return Value

array

at line 368
protected setEnabledExtensions(array $enabledExtensions)

Persist the currently enabled extensions.

Parameters

array $enabledExtensions

at line 385
bool isEnabled($extension)

Whether the extension is enabled.

Parameters

$extension

Return Value

bool

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

Returns the titles of the extensions passed.

Parameters

array $exts

Return Value

string[]

at line 417
static array resolveExtensionOrder($extensionList)

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

Effectively just topological sorting.

Parameters

$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