Extension
class Extension implements Arrayable
Constants
| LOGO_MIMETYPES |
|
Properties
| protected string | $id | Unique Id of the extension. |
|
|
| protected string | $path | The directory of this extension. |
|
|
| protected array | $composerJson | Composer json of the package. |
|
|
| 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 | Whether the extension is installed. |
|
|
| protected string | $version | The installed version of the extension. |
|
|
| 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 119
__construct($path, array $composerJson)
at
line 126
static protected
nameToId($name)
at
line 137
protected
assignId()
Assigns the id for the extension used globally.
at
line 145
extend(Container $container)
at
line 159
__get($name)
{@inheritdoc}
at
line 167
__isset($name)
{@inheritdoc}
at
line 180
mixed
composerJsonAttribute($name)
Dot notation getter for composer.json attributes.
at
line 201
bool
isInstalled()
at
line 240
calculateDependencies($extensionSet)
Get the list of flarum extensions that this extension depends on.
at
line 262
string|null
getVersion()
at
line 272
bool
isAbandoned()
Check if the composer package is marked as abandoned.
at
line 283
bool|string
getAbandoned()
Get the abandoned status.
Returns false if not abandoned, or a string with the replacement package name if abandoned.
at
line 293
array|null
getIcon()
Loads the icon information from the composer.json.
at
line 319
string
getIconStyles()
at
line 343
enable(Container $container)
at
line 353
disable(Container $container)
at
line 365
string
getId()
The raw path of the directory under extensions.
at
line 373
string
getTitle()
at
line 381
string|null
getNamespace()
at
line 394
string
getPath()
at
line 404
array
getExtensionDependencyIds()
The IDs of all Flarum extensions that this extension depends on.
at
line 415
array
getOptionalDependencyIds()
The IDs of all Flarum extensions that this extension should be booted after if enabled.
at
line 464
getLinks()
Compile a list of links for this extension.
at
line 509
bool
hasAssets()
Tests whether the extension has assets.
at
line 517
copyAssetsTo(Filesystem $target)
at
line 538
bool
hasMigrations()
Tests whether the extension has migrations.
at
line 565
array
toArray()
Generates an array result for the object.
at
line 586
string|null
getReadme()
Gets the rendered contents of the extension README file as a HTML string.