OAIMetadataFormatPlugin Class Reference
[Plugins]

Abstract class for OAI Metadata format plugins. More...

Inheritance diagram for OAIMetadataFormatPlugin:

List of all members.

Public Member Functions
	callback_formatRequest ($hookName, $args)
	getDescription ()
	getDisplayName ()
	getFormatClass ()
	getMetadataPrefix ()
	getName ()
	getNamespace ()
	getSchema ()
	OAIMetadataFormatPlugin ()
	register ($category, $path)

---

Detailed Description

Abstract class for OAI Metadata format plugins.

Definition at line 21 of file OAIMetadataFormatPlugin.inc.php.

---

Member Function Documentation

OAIMetadataFormatPlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented in OAIMetadataFormatPlugin_DC, OAIMetadataFormatPlugin_MARC, OAIMetadataFormatPlugin_MARC21, and OAIMetadataFormatPlugin_RFC1807.

Definition at line 61 of file OAIMetadataFormatPlugin.inc.php.

OAIMetadataFormatPlugin.getDisplayName

(

)

Get the display name for this plugin.

Reimplemented in OAIMetadataFormatPlugin_DC, OAIMetadataFormatPlugin_MARC, OAIMetadataFormatPlugin_MARC21, and OAIMetadataFormatPlugin_RFC1807.

Definition at line 54 of file OAIMetadataFormatPlugin.inc.php.

OAIMetadataFormatPlugin.getFormatClass

(

)

Get a hold of the class that does the formatting.

Reimplemented in OAIMetadataFormatPlugin_DC, OAIMetadataFormatPlugin_MARC, OAIMetadataFormatPlugin_MARC21, and OAIMetadataFormatPlugin_RFC1807.

Definition at line 83 of file OAIMetadataFormatPlugin.inc.php.

Referenced by callback_formatRequest().

OAIMetadataFormatPlugin.getMetadataPrefix

(

)

Get the metadata prefix for this plugin's format.

Reimplemented in OAIMetadataFormatPlugin_DC, OAIMetadataFormatPlugin_MARC, OAIMetadataFormatPlugin_MARC21, and OAIMetadataFormatPlugin_RFC1807.

Definition at line 68 of file OAIMetadataFormatPlugin.inc.php.

Referenced by callback_formatRequest().

OAIMetadataFormatPlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns:

String name of plugin

Reimplemented in OAIMetadataFormatPlugin_DC, OAIMetadataFormatPlugin_MARC, OAIMetadataFormatPlugin_MARC21, and OAIMetadataFormatPlugin_RFC1807.

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

OAIMetadataFormatPlugin.register	(	$	category,
		$	path
	)

Called as a plugin is registered to the registry

Parameters:

$category

String Name of category plugin was registered to

Returns:

boolean True if plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

Definition at line 32 of file OAIMetadataFormatPlugin.inc.php.

References callback_formatRequest().

---

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

• classes/plugins/OAIMetadataFormatPlugin.inc.php

---