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 106
protected void
assignId()
Assigns the id for the extension used globally.
at
line 114
void
extend(Container $container)
at
line 125
mixed
__get(string $name)
at
line 130
bool
__isset(string $name)
at
line 140
mixed
composerJsonAttribute(string $name)
Dot notation getter for composer.json attributes.
at
line 155
bool
isInstalled()
at
line 190
void
calculateDependencies(array $extensionSet)
Get the list of flarum extensions that this extension depends on.
at
line 209
string|null
getVersion()
at
line 219
bool
isAbandoned()
Check if the composer package is marked as abandoned.
at
line 230
bool|string
getAbandoned()
Get the abandoned status.
Returns false if not abandoned, or a string with the replacement package name if abandoned.
at
line 235
array|null
getIcon()
at
line 261
string
getIconStyles()
at
line 285
void
enable(Container $container)
at
line 295
void
disable(Container $container)
at
line 305
string
getId()
The raw path of the directory under extensions.
at
line 310
string
getTitle()
at
line 315
string
getPath()
at
line 323
array
getExtensionDependencyIds()
The IDs of all Flarum extensions that this extension depends on.
at
line 332
array
getOptionalDependencyIds()
The IDs of all Flarum extensions that this extension should be booted after if enabled.
at
line 381
array
getLinks()
Compile a list of links for this extension.
at
line 424
bool
hasAssets()
Tests whether the extension has assets.
at
line 432
void
copyAssetsTo(Filesystem $target)
at
line 451
bool
hasMigrations()
Tests whether the extension has migrations.
at
line 477
array
toArray()
Generates an array result for the object.
at
line 496
string|null
getReadme()
Gets the rendered contents of the extension README file as a HTML string.