Extension
class Extension implements Arrayable
Constants
| LOGO_MIMETYPES |
|
Properties
| protected string | $id | Unique ID of the extension. |
|
|
| protected string[] | $extensionDependencyIds | The IDs of all Flarum extensions that this extension depends on. |
|
|
| protected string[] | $optionalDependencyIds | The IDs of all Flarum extensions that this extension should be booted after if enabled. |
|
|
| protected bool | $installed |
|
||
| protected string | $version |
|
||
| protected bool|string | $abandoned | Whether the composer package is marked as abandoned. |
|
|
| string | $name |
|
||
| string | $description |
|
||
| string | $type |
|
||
| array | $keywords |
|
||
| string | $homepage |
|
||
| string | $time |
|
||
| string | $license |
|
||
| array | $authors |
|
||
| array | $support |
|
||
| array | $require |
|
||
| array | $requireDev |
|
||
| array | $autoload |
|
||
| array | $autoloadDev |
|
||
| array | $conflict |
|
||
| array | $replace |
|
||
| array | $provide |
|
||
| array | $suggest |
|
||
| array | $extra |
|
Methods
Get the list of flarum extensions that this extension depends on.
The IDs of all Flarum extensions that this extension should be booted after if enabled.
Details
at
line 88
__construct(string $path, array $composerJson)
at
line 95
static string
nameToId(string $name)
at
line 108
protected void
assignId()
Assigns the id for the extension used globally.
at
line 116
void
extend(Container $container)
at
line 127
mixed
__get(string $name)
at
line 132
bool
__isset(string $name)
at
line 142
mixed
composerJsonAttribute(string $name)
Dot notation getter for composer.json attributes.
at
line 157
bool
isInstalled()
at
line 192
void
calculateDependencies(array $extensionSet)
Get the list of flarum extensions that this extension depends on.
at
line 211
string|null
getVersion()
at
line 221
bool
isAbandoned()
Check if the composer package is marked as abandoned.
at
line 232
bool|string
getAbandoned()
Get the abandoned status.
Returns false if not abandoned, or a string with the replacement package name if abandoned.
at
line 237
array|null
getIcon()
at
line 263
string
getIconStyles()
at
line 287
void
enable(Container $container)
at
line 297
void
disable(Container $container)
at
line 307
string
getId()
The raw path of the directory under extensions.
at
line 312
string
getTitle()
at
line 317
string
getPath()
at
line 325
array
getExtensionDependencyIds()
The IDs of all Flarum extensions that this extension depends on.
at
line 334
array
getOptionalDependencyIds()
The IDs of all Flarum extensions that this extension should be booted after if enabled.
at
line 383
array
getLinks()
Compile a list of links for this extension.
at
line 426
bool
hasAssets()
Tests whether the extension has assets.
at
line 434
void
copyAssetsTo(Filesystem $target)
at
line 453
bool
hasMigrations()
Tests whether the extension has migrations.
at
line 479
array
toArray()
Generates an array result for the object.
at
line 498
string|null
getReadme()
Gets the rendered contents of the extension README file as a HTML string.