Documentation

PluginVersion extends Model
in package

System\Models\PluginVersion

Tags
mixin

\Eloquent

Table of Contents

$author  : string
$code  : string
$created_at  : string|null
$description  : string
$disabledByConfig  : bool
$disabledBySystem  : bool
$homepage  : string
$icon  : string
$id  : int
$is_disabled  : int
$is_frozen  : int
$is_updatable  : bool
$name  : string
$orphaned  : bool
$slug  : mixed
$table  : mixed
$timestamps  : bool
$version  : string
$appends  : array<string|int, mixed>
The accessors to append to the model's array form.
$guarded  : array<string|int, mixed>
$versionCache  : array<string|int, mixed>
afterFetch()  : mixed
After the model is populated
all()  :
applyEnabled()  :
get()  :
getIsUpdatableAttribute()  : bool
Returns true if the plugin should be updated by the system.
getSlugAttribute()  : mixed
Provides the slug attribute.
getVersion()  : string
Returns the current version for a plugin
makeSlug()  : mixed
Generates a slug for the plugin.
newModelQuery()  :
newQuery()  :
query()  :
scopeApplyEnabled()  : mixed
Only include enabled plugins
whereCode()  :
whereCreatedAt()  :
whereId()  :
whereIsDisabled()  :
whereIsFrozen()  :
whereVersion()  :

Properties

$author

public string $author

Plugin author, sourced from plugin details

$description

public string $description

Plugin description, sourced from plugin details

$disabledByConfig

public bool $disabledByConfig = false

Plugin has been disabled by the user or configuration.

$disabledBySystem

public bool $disabledBySystem = false

Plugin has been disabled by a missing dependency.

$homepage

public string $homepage

Plugin homepage, sourced from plugin details

$icon

public string $icon

Plugin icon, sourced from plugin details

$name

public string $name

Plugin name, sourced from plugin details

$orphaned

public bool $orphaned = false

If true, plugin exists in the database but not the filesystem.

$timestamps

public bool $timestamps = false

Disable model timestamps.

$appends

The accessors to append to the model's array form.

protected array<string|int, mixed> $appends = ['slug']

$guarded

protected array<string|int, mixed> $guarded = ['*']

Guarded fields

$versionCache

protected static array<string|int, mixed> $versionCache

Cache store for version information

Methods

afterFetch()

After the model is populated

public afterFetch() : mixed
Return values
mixed

all()

public static all(mixed $columns) :
Parameters
$columns : mixed
Return values

applyEnabled()

public static applyEnabled() :
Return values

get()

public static get(mixed $columns) :
Parameters
$columns : mixed
Return values

getIsUpdatableAttribute()

Returns true if the plugin should be updated by the system.

public getIsUpdatableAttribute() : bool
Return values
bool

getSlugAttribute()

Provides the slug attribute.

public getSlugAttribute() : mixed
Return values
mixed

getVersion()

Returns the current version for a plugin

public static getVersion(string $pluginCode) : string
Parameters
$pluginCode : string

Plugin code. Eg: Acme.Blog

Return values
string

makeSlug()

Generates a slug for the plugin.

public static makeSlug(mixed $code) : mixed
Parameters
$code : mixed
Return values
mixed

newModelQuery()

public static newModelQuery() :
Return values

scopeApplyEnabled()

Only include enabled plugins

public scopeApplyEnabled( $query) : mixed
Parameters
$query :
Return values
mixed

whereCode()

public static whereCode(mixed $value) :
Parameters
$value : mixed
Return values

whereCreatedAt()

public static whereCreatedAt(mixed $value) :
Parameters
$value : mixed
Return values

whereId()

public static whereId(mixed $value) :
Parameters
$value : mixed
Return values

whereIsDisabled()

public static whereIsDisabled(mixed $value) :
Parameters
$value : mixed
Return values

whereIsFrozen()

public static whereIsFrozen(mixed $value) :
Parameters
$value : mixed
Return values

whereVersion()

public static whereVersion(mixed $value) :
Parameters
$value : mixed
Return values

Search results