Extension
class Extension implements Arrayable
Constants
| LOGO_MIMETYPES |
|
Properties
| protected | $id | <p>Unique ID of the extension.</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 | $installed |
|
||
| protected | $version |
|
||
| 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 80
__construct(string $path, array $composerJson)
at
line 87
static protected string
nameToId(string $name)
at
line 98
protected void
assignId()
<p>Assigns the id for the extension used globally.</p>
at
line 106
void
extend(Container $container)
at
line 117
mixed
__get(string $name)
at
line 122
bool
__isset(string $name)
at
line 132
mixed
composerJsonAttribute(string $name)
<p>Dot notation getter for composer.json attributes.</p>
at
line 150
bool
isInstalled()
at
line 173
void
calculateDependencies(array $extensionSet)
<p>Get the list of flarum extensions that this extension depends on.</p>
at
line 192
string|null
getVersion()
at
line 197
array|null
getIcon()
at
line 223
string
getIconStyles()
at
line 247
void
enable(Container $container)
at
line 257
void
disable(Container $container)
at
line 269
string
getId()
<p>The raw path of the directory under extensions.</p>
at
line 277
string
getTitle()
at
line 285
string
getPath()
at
line 295
array
getExtensionDependencyIds()
<p>The IDs of all Flarum extensions that this extension depends on.</p>
at
line 306
array
getOptionalDependencyIds()
<p>The IDs of all Flarum extensions that this extension should be booted after if enabled.</p>
at
line 355
array
getLinks()
<p>Compile a list of links for this extension.</p>
at
line 398
bool
hasAssets()
<p>Tests whether the extension has assets.</p>
at
line 406
void
copyAssetsTo(Filesystem $target)
at
line 425
bool
hasMigrations()
<p>Tests whether the extension has migrations.</p>
at
line 453
array
toArray()
<p>Generates an array result for the object.</p>
at
line 473
string|null
getReadme()
<p>Gets the rendered contents of the extension README file as a HTML string.</p>