Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ViewableFilePlugin Class Reference
Inheritance diagram for ViewableFilePlugin:
GenericPlugin PdfSubmissionFilePlugin

Public Member Functions

 callback ($hookName, $args)
 
 canHandle ($publishedMonograph, $submissionFile)
 
 displaySubmissionFile ($publishedMonograph, $submissionFile)
 
 getTemplateFilename ()
 
 register ($category, $path)
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getSettingMainContext ()
 
 getTemplatePath ($inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
 Plugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Public Attributes inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Abstract class for article galley plugins.

Definition at line 18 of file ViewableFilePlugin.inc.php.

Member Function Documentation

ViewableFilePlugin::callback (   $hookName,
  $args 
)

Callback that renders the galley.

Parameters
$hookNamestring
$argsarray
Returns
string

Definition at line 82 of file ViewableFilePlugin.inc.php.

References canHandle(), and displaySubmissionFile().

ViewableFilePlugin::canHandle (   $publishedMonograph,
  $submissionFile 
)

Determine whether this plugin can handle the specified content.

Parameters
$publishedMonographPublishedMonograph
$submissionFileSubmissionFile
Returns
boolean True iff the plugin can handle the content

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

Referenced by callback().

ViewableFilePlugin::displaySubmissionFile (   $publishedMonograph,
  $submissionFile 
)

Display this galley in some manner.

Parameters
$publishedMonographPublishedMonograph
$submissionFileSubmissionFile

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

References Plugin\getRequest(), and getTemplateFilename().

Referenced by callback().

ViewableFilePlugin::getTemplateFilename ( )

Get the filename of the template. (Default behavior may be overridden through some combination of this function and the displayArticleGalley function.) Returning null from this function results in an empty display.

Returns
string

Definition at line 45 of file ViewableFilePlugin.inc.php.

Referenced by displaySubmissionFile().

ViewableFilePlugin::register (   $category,
  $path 
)

Override public methods from Plugin

See Also
Plugin::register()

Definition at line 27 of file ViewableFilePlugin.inc.php.

References HookRegistry\register().


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