Extension
class Extension implements Arrayable
Constants
| LOGO_MIMETYPES |
|
Properties
| protected string | $id | <p>Unique Id of the extension.</p> |
|
|
| protected string | $path | <p>The directory of this extension.</p> |
|
|
| protected array | $composerJson | <p>Composer json of the package.</p> |
|
|
| protected string[] | $extensionDependencyIds | <p>The IDs of all Flarum extensions that this extension depends on.</p> |
|
|
| protected string[] | $optionalDependencyIds | <p>The IDs of all Flarum extensions that this extension should be booted after if enabled.</p> |
|
|
| protected bool | $installed | <p>Whether the extension is installed.</p> |
|
|
| protected string | $version | <p>The installed version of the extension.</p> |
|
|
| 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
<p>Get the list of flarum extensions that this extension depends on.</p>
<p>The IDs of all Flarum extensions that this extension depends on.</p>
<p>The IDs of all Flarum extensions that this extension should be booted after if enabled.</p>
<p>Gets the rendered contents of the extension README file as a HTML string.</p>
Details
at
line 111
__construct($path, array $composerJson)
at
line 118
static protected
nameToId($name)
at
line 129
protected
assignId()
<p>Assigns the id for the extension used globally.</p>
at
line 137
extend(Container $container)
at
line 151
__get($name)
<p>{@inheritdoc}</p>
at
line 159
__isset($name)
<p>{@inheritdoc}</p>
at
line 172
mixed
composerJsonAttribute($name)
<p>Dot notation getter for composer.json attributes.</p>
at
line 193
bool
isInstalled()
at
line 222
calculateDependencies($extensionSet)
<p>Get the list of flarum extensions that this extension depends on.</p>
at
line 244
string
getVersion()
at
line 254
array|null
getIcon()
<p>Loads the icon information from the composer.json.</p>
at
line 280
string
getIconStyles()
at
line 304
enable(Container $container)
at
line 314
disable(Container $container)
at
line 326
string
getId()
<p>The raw path of the directory under extensions.</p>
at
line 334
string
getTitle()
at
line 342
string
getPath()
at
line 352
array
getExtensionDependencyIds()
<p>The IDs of all Flarum extensions that this extension depends on.</p>
at
line 363
array
getOptionalDependencyIds()
<p>The IDs of all Flarum extensions that this extension should be booted after if enabled.</p>
at
line 412
getLinks()
<p>Compile a list of links for this extension.</p>
at
line 457
bool
hasAssets()
<p>Tests whether the extension has assets.</p>
at
line 465
copyAssetsTo(Filesystem $target)
at
line 486
bool
hasMigrations()
<p>Tests whether the extension has migrations.</p>
at
line 512
array
toArray()
<p>Generates an array result for the object.</p>
at
line 532
string|null
getReadme()
<p>Gets the rendered contents of the extension README file as a HTML string.</p>