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)

<p>Loads an Extension with all information.</p>

enable(string $name)

<p>Enables the extension.</p>

disable(string $name)

<p>Disables an extension.</p>

uninstall(string $name)

<p>Uninstalls an extension.</p>

publishAssets(Extension $extension)

<p>Copy the assets from an extension's assets directory into public view.</p>

unpublishAssets(Extension $extension)

<p>Delete an extension's assets from public view.</p>

string
getAsset(Extension $extension, string $path)

<p>Get the path to an extension's published asset.</p>

Cloud
getAssetsFilesystem()

<p>Get an instance of the assets filesystem.</p>

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

<p>Runs the database migrations for the extension.</p>

array
migrateDown(Extension $extension)

<p>Runs the database migrations to reset the database to its old state.</p>

Migrator
getMigrator()

<p>The database migrator.</p>

array|Extension[]
getEnabledExtensions()

<p>Get only enabled extensions.</p>

extend(Container $container)

<p>Call on all enabled extensions to extend the Flarum application.</p>

array
getEnabled()

<p>The id's of the enabled extensions.</p>

setEnabledExtensions(array $enabledExtensions)

<p>Persist the currently enabled extensions.</p>

bool
isEnabled($extension)

<p>Whether the extension is enabled.</p>

static string[]
pluckTitles(array $exts)

<p>Returns the titles of the extensions passed.</p>

static array
resolveExtensionOrder(Extension[] $extensionList)

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

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)

<p>Loads an Extension with all information.</p>

Parameters

string $name

Return Value

Extension|null

at line 178
enable(string $name)

<p>Enables the extension.</p>

Parameters

string $name

at line 220
disable(string $name)

<p>Disables an extension.</p>

Parameters

string $name

at line 257
uninstall(string $name)

<p>Uninstalls an extension.</p>

Parameters

string $name

at line 277
protected publishAssets(Extension $extension)

<p>Copy the assets from an extension's assets directory into public view.</p>

Parameters

Extension $extension

at line 287
protected unpublishAssets(Extension $extension)

<p>Delete an extension's assets from public view.</p>

Parameters

Extension $extension

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

<p>Get the path to an extension's published asset.</p>

Parameters

Extension $extension
string $path

Return Value

string

at line 309
protected Cloud getAssetsFilesystem()

<p>Get an instance of the assets filesystem.</p>

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

Return Value

Cloud

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

<p>Runs the database migrations for the extension.</p>

Parameters

Extension $extension
string $direction

Return Value

void

at line 340
array migrateDown(Extension $extension)

<p>Runs the database migrations to reset the database to its old state.</p>

Parameters

Extension $extension

Return Value

array <p>Notes from the migrator.</p>

at line 350
Migrator getMigrator()

<p>The database migrator.</p>

Return Value

Migrator

at line 360
array|Extension[] getEnabledExtensions()

<p>Get only enabled extensions.</p>

Return Value

array|Extension[]

at line 379
extend(Container $container)

<p>Call on all enabled extensions to extend the Flarum application.</p>

Parameters

Container $container

at line 391
array getEnabled()

<p>The id's of the enabled extensions.</p>

Return Value

array

at line 401
protected setEnabledExtensions(array $enabledExtensions)

<p>Persist the currently enabled extensions.</p>

Parameters

array $enabledExtensions

at line 418
bool isEnabled($extension)

<p>Whether the extension is enabled.</p>

Parameters

$extension

Return Value

bool

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

<p>Returns the titles of the extensions passed.</p>

Parameters

array $exts

Return Value

string[]

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

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

<p>Effectively just topological sorting.</p>

Parameters

Extension[] $extensionList

Return Value

array <p>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 =&gt; array of missing dependency IDs. 'circularDependencies' points to an array of extensions ids of extensions that cannot be processed due to circular dependencies</p>