Plugin

class Plugin

Package: Record

A plugin and its metadata.

property name

property active

property version

property _displayName

property _author

property _description

property _link

property _loaded

property _hasConfig

property _requiredPlugins

property _optionalPlugins

property _minimumOmekaVersion

property _testedUpToVersion

property _iniVersion

property _iniTags

_validate()

getDirectoryName()

Get the name of the directory containing the plugin.

setDirectoryName(string $name)

Set the name of the directory containing the plugin.

Parameters:

• $name (string) –

getDisplayName()

Get the human-readable name of the plugin, e.g. “Dublin Core Extended”.

If there is no human-readable name available, returns the directory name instead.

setDisplayName(string $name)

Set the human-readable name of the plugin.

Parameters:

• $name (string) –

getAuthor()

Get the author’s name.

setAuthor(string $author)

Set the author’s name.

Parameters:

• $author (string) –

getDescription()

Get the description of the plugin.

setDescription(string $description)

Set the description of the plugin.

Parameters:

• $description (string) –

getMinimumOmekaVersion()

Get the minimum version of Omeka that this plugin requires to work.

setMinimumOmekaVersion(string $version)

Set the minimum required version of Omeka.

Parameters:

• $version (string) –

getTestedUpToOmekaVersion()

Get the version of Omeka that this plugin is tested up to.

setTestedUpToOmekaVersion(string $version)

Set the version of Omeka that this plugin is tested up to.

Parameters:

• $version (string) –

getRequiredPlugins()

Get the list of plugins that are required for this plugin to work.

setRequiredPlugins($plugins)

Set the list of plugins that are required for this plugin to work.

Parameters:

• $plugins (unknown) –

getOptionalPlugins()

Get the list of plugins that can be used, but are not required by, this plugin.

setOptionalPlugins($plugins)

Set the list of optional plugins.

Parameters:

• $plugins (unknown) –

getIniTags()

Get the list of tags for this plugin (from the ini file).

setIniTags($tags)

Set the list of tags for this plugin.

Parameters:

• $tags (unknown) –

getLinkUrl()

Get the URL link from the plugin.ini.

setLinkUrl(string $link)

Set the link from the plugin.ini.

Parameters:

• $link (string) –

isInstalled()

Whether or not the Plugin has been installed.

Returns:boolean

isLoaded()

Returns:boolean

setLoaded(boolean $flag)

Parameters:

• $flag (boolean) –

isActive()

Whether or not the plugin has been activated through the UI.

setActive($flag)

Set whether or not the plugin has been activated.

Parameters:

• $flag (unknown) –

hasConfig()

Whether or not the plugin has a custom configuration hook.

setHasConfig(boolean $flag)

Set whether or not the plugin has a custom configuration hook.

Parameters:

• $flag (boolean) –

getIniVersion()

Get the version of the plugin stored in the ini file.

setIniVersion(string $version)

Set the version of the plugin that is indicated by the ini file.

Parameters:

• $version (string) –

getDbVersion()

Get the version of the plugin that is stored in the database.

setDbVersion(string $version)

Set the version of the plugin that is stored in the database.

Parameters:

• $version (string) –

hasNewVersion()

Determine whether or not there is a new version of the plugin available.

meetsOmekaMinimumVersion()

Determine whether the plugin meets the minimum version requirements for Omeka.

If the field is not set, assume that it meets the requirements. If the field is set, it must be greater than the current version of Omeka.

meetsOmekaTestedUpToVersion()

getResourceId()