Inheritance diagram for GalleryPlugin:

Public Member Functions
	getCategory ()

	getContactEmail ()

	getContactInstitutionName ()

	getContactName ()

	getCurrentStatus ()

	getDate ()

	getDescription ($locale=null)

	getHomepage ()

	getInstallationInstructions ($locale=null)

	getInstalledVersion ()

	getLocalizedDescription ()

	getLocalizedInstallationInstructions ()

	getLocalizedName ($preferredLocale=null)

	getLocalizedReleaseDescription ()

	getLocalizedSummary ()

	getName ($locale=null)

	getProduct ()

	getReleaseCertifications ()

	getReleaseDescription ($locale=null)

	getReleaseMD5 ()

	getReleasePackage ()

	getSummary ($locale=null)

	getVersion ($pad=false)

	setCategory ($category)

	setContactEmail ($contactEmail)

	setContactInstitutionName ($contactInstitutionName)

	setContactName ($contactName)

	setDate ($date)

	setDescription ($description, $locale=null)

	setHomepage ($homepage)

	setInstallationInstructions ($installation, $locale=null)

	setName ($name, $locale=null)

	setProduct ($product)

	setReleaseCertifications ($certifications)

	setReleaseDescription ($releaseDescription, $locale=null)

	setReleaseMD5 ($releaseMD5)

	setReleasePackage ($releasePackage)

	setSummary ($summary, $locale=null)

	setVersion ($version)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	getMetadataFieldNames ($translated=true)

	getSetMetadataFieldNames ($translated=true)

	getSupportedExtractionAdapters ()

	getSupportedInjectionAdapters ()

	getSupportedMetadataSchemas ()

	hasData ($key, $locale=null)

	injectMetadata ($metadataDescription)

	removeSupportedMetadataAdapter ($metadataSchemaName)

	setAllData (&$data)

	setData ($key, $value, $locale=null)

	setHasLoadableAdapters ($hasLoadableAdapters)

	setId ($id)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Detailed Description

Class describing a plugin in the Plugin Gallery.

Definition at line 22 of file GalleryPlugin.inc.php.

Member Function Documentation

◆ getCategory()

GalleryPlugin::getCategory ( )

Get the category for this plugin

Returns: string

Definition at line 87 of file GalleryPlugin.inc.php.

References DataObject\getData().

Referenced by getCurrentStatus(), and getInstalledVersion().

◆ getContactEmail()

GalleryPlugin::getContactEmail ( )

Get the contact email for this plugin

Returns: string

Definition at line 175 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getContactInstitutionName()

GalleryPlugin::getContactInstitutionName ( )

Get the contact institution name for this plugin

Returns: string

Definition at line 159 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getContactName()

GalleryPlugin::getContactName ( )

Get the contact name for this plugin

Returns: string

Definition at line 143 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getCurrentStatus()

GalleryPlugin::getCurrentStatus ( )

Get the current state of the gallery plugin with respect to this installation.

Returns: int PLUGIN_GALLERY_STATE_...

Definition at line 354 of file GalleryPlugin.inc.php.

References Core\getBaseDir(), getCategory(), getInstalledVersion(), getProduct(), and getVersion().

◆ getDate()

GalleryPlugin::getDate ( )

Get the release date of this plugin

Returns: int

Definition at line 127 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getDescription()

GalleryPlugin::getDescription ( $locale = null )

Get plugin description.

Parameters

$locale string optional

Returns: string

Definition at line 210 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getHomepage()

GalleryPlugin::getHomepage ( )

Get the homepage for this plugin

Returns: string

Definition at line 55 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getInstallationInstructions()

GalleryPlugin::getInstallationInstructions ( $locale = null )

Get plugin installation instructions.

Parameters

$locale string optional

Returns: string

Definition at line 228 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getInstalledVersion()

GalleryPlugin::getInstalledVersion ( )

Determine the version of this plugin that is currently installed, if any

Returns: Version|null

Definition at line 344 of file GalleryPlugin.inc.php.

References getCategory(), DAORegistry\getDAO(), and getProduct().

Referenced by getCurrentStatus().

◆ getLocalizedDescription()

GalleryPlugin::getLocalizedDescription ( )

Get the localized description of the plugin.

Returns: string

Definition at line 327 of file GalleryPlugin.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedInstallationInstructions()

GalleryPlugin::getLocalizedInstallationInstructions ( )

Get the localized installation instructions of the plugin.

Returns: string

Definition at line 319 of file GalleryPlugin.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedName()

GalleryPlugin::getLocalizedName ( $preferredLocale = null )

Get the localized name of the plugin

Parameters

$preferredLocale string

Returns: string

Definition at line 29 of file GalleryPlugin.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedReleaseDescription()

GalleryPlugin::getLocalizedReleaseDescription ( )

Get the localized release description of the plugin.

Returns: string

Definition at line 335 of file GalleryPlugin.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedSummary()

GalleryPlugin::getLocalizedSummary ( )

Get the localized summary of the plugin.

Returns: string

Definition at line 311 of file GalleryPlugin.inc.php.

References DataObject\getLocalizedData().

◆ getName()

GalleryPlugin::getName ( $locale = null )

Get the name of the plugin

Parameters

$locale string optional

Returns: string

Definition at line 47 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getProduct()

GalleryPlugin::getProduct ( )

Get the product (symbolic name) for this plugin

Returns: string

Definition at line 71 of file GalleryPlugin.inc.php.

References DataObject\getData().

Referenced by getCurrentStatus(), and getInstalledVersion().

◆ getReleaseCertifications()

GalleryPlugin::getReleaseCertifications ( )

Get the certifications for this plugin release

Returns: array

Definition at line 279 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getReleaseDescription()

GalleryPlugin::getReleaseDescription ( $locale = null )

Get release description.

Parameters

$locale string optional

Returns: string

Definition at line 246 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getReleaseMD5()

GalleryPlugin::getReleaseMD5 ( )

Get release MD5 checksum.

Returns: string

Definition at line 263 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getReleasePackage()

GalleryPlugin::getReleasePackage ( )

Get the package URL for this plugin release

Returns: strings

Definition at line 295 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getSummary()

GalleryPlugin::getSummary ( $locale = null )

Get plugin summary.

Parameters

$locale string optional

Returns: string

Definition at line 192 of file GalleryPlugin.inc.php.

References DataObject\getData().

◆ getVersion()

GalleryPlugin::getVersion ( $pad = false )

Get the newest compatible version of this plugin

Parameters

$pad	boolean True iff returned version numbers should be padded to 4 terms, e.g. 1.0.0.0 instead of just 1.0

Returns: string

Definition at line 105 of file GalleryPlugin.inc.php.

References DataObject\getData().

Referenced by getCurrentStatus().

◆ setCategory()

GalleryPlugin::setCategory ( $category )

Set the category for this plugin

Parameters

$category string

Definition at line 95 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setContactEmail()

GalleryPlugin::setContactEmail ( $contactEmail )

Set the contact email for this plugin

Parameters

$contactEmail string

Definition at line 183 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setContactInstitutionName()

GalleryPlugin::setContactInstitutionName ( $contactInstitutionName )

Set the contact institution name for this plugin

Parameters

$contactInstitutionName string

Definition at line 167 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setContactName()

GalleryPlugin::setContactName ( $contactName )

Set the contact name for this plugin

Parameters

$contactName string

Definition at line 151 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setDate()

GalleryPlugin::setDate ( $date )

Set the release date for this plugin

Parameters

$date int

Definition at line 135 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setDescription()

GalleryPlugin::setDescription	(	$description,
		$locale = `null`
	)

Set plugin description.

Parameters

$description	string
$locale	string optional

Definition at line 219 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setHomepage()

GalleryPlugin::setHomepage ( $homepage )

Set the homepage for this plugin

Parameters

$homepage string

Definition at line 63 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setInstallationInstructions()

GalleryPlugin::setInstallationInstructions	(	$installation,
		$locale = `null`
	)

Set plugin installation instructions.

Parameters

$installation	string
$locale	string optional

Definition at line 237 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setName()

GalleryPlugin::setName	(	$name,
		$locale = `null`
	)

Set the name of the plugin

Parameters

$name	string
$locale	string optional

Definition at line 38 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setProduct()

GalleryPlugin::setProduct ( $product )

Set the product (symbolic name) for this plugin

Parameters

$product string

Definition at line 79 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setReleaseCertifications()

GalleryPlugin::setReleaseCertifications ( $certifications )

Set the certifications for this plugin release

Parameters

$certifications array

Definition at line 287 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setReleaseDescription()

GalleryPlugin::setReleaseDescription	(	$releaseDescription,
		$locale = `null`
	)

Set plugin release description.

Parameters

$releaseDescription	string
$locale	string optional

Definition at line 255 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setReleaseMD5()

GalleryPlugin::setReleaseMD5 ( $releaseMD5 )

Set plugin release MD5.

Parameters

$releaseMD5 string

Definition at line 271 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setReleasePackage()

GalleryPlugin::setReleasePackage ( $releasePackage )

Set the package URL for this plugin release

Parameters

$package string

Definition at line 303 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setSummary()

GalleryPlugin::setSummary	(	$summary,
		$locale = `null`
	)

Set plugin summary.

Parameters

$summary	string
$locale	string optional

Definition at line 201 of file GalleryPlugin.inc.php.

References DataObject\setData().

◆ setVersion()

GalleryPlugin::setVersion ( $version )

Set the version for this plugin

Parameters

$version string

Definition at line 119 of file GalleryPlugin.inc.php.

References DataObject\setData().

The documentation for this class was generated from the following file:

GalleryPlugin.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCategory()

◆ getContactEmail()

◆ getContactInstitutionName()

◆ getContactName()

◆ getCurrentStatus()

◆ getDate()

◆ getDescription()

◆ getHomepage()

◆ getInstallationInstructions()

◆ getInstalledVersion()

◆ getLocalizedDescription()

◆ getLocalizedInstallationInstructions()

◆ getLocalizedName()

◆ getLocalizedReleaseDescription()

◆ getLocalizedSummary()

◆ getName()

◆ getProduct()

◆ getReleaseCertifications()

◆ getReleaseDescription()

◆ getReleaseMD5()

◆ getReleasePackage()

◆ getSummary()

◆ getVersion()

◆ setCategory()

◆ setContactEmail()

◆ setContactInstitutionName()

◆ setContactName()

◆ setDate()

◆ setDescription()

◆ setHomepage()

◆ setInstallationInstructions()

◆ setName()

◆ setProduct()

◆ setReleaseCertifications()

◆ setReleaseDescription()

◆ setReleaseMD5()

◆ setReleasePackage()

◆ setSummary()

◆ setVersion()