DOAJPlugin Class Reference

DOAJ import/export plugin. More...

Inheritance diagram for DOAJPlugin:

ImportExportPlugin Plugin

List of all members.

Public Member Functions

 compareToCurDate ($journalId)
 display (&$args)
 emailRep (&$journal, $send=false)
 exportJournal (&$journal, $outputFile=null)
 getArticlesPerIssue ($journalId)
 getDescription ()
 getDisplayName ()
 getInstallDataFile ()
 getName ()
 register ($category, $path)


Detailed Description

DOAJ import/export plugin.

Definition at line 24 of file DOAJPlugin.inc.php.


Member Function Documentation

DOAJPlugin.compareToCurDate ( journalId  ) 

See if the most recent issue was more than a year old. If so, return false. Else return true. (No published issues returns false.)

Parameters:
$journalId int
Returns:
boolean

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

References DAORegistry.getDAO().

Referenced by emailRep().

DOAJPlugin.display ( &$  args  ) 

Display the plugin

Parameters:
$args array

Reimplemented from ImportExportPlugin.

Definition at line 74 of file DOAJPlugin.inc.php.

References emailRep(), exportJournal(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), and ImportExportPlugin.setBreadcrumbs().

DOAJPlugin.emailRep ( &$  journal,
send = false 
)

Send the request email to DOAJ.

Parameters:
$journal object

Definition at line 123 of file DOAJPlugin.inc.php.

References compareToCurDate(), getArticlesPerIssue(), Locale.getLocale(), getName(), Request.getUser(), Request.redirect(), and Request.url().

Referenced by display().

DOAJPlugin.exportJournal ( &$  journal,
outputFile = null 
)

Export a journal's content

Parameters:
$journal object
$outputFile string

Definition at line 99 of file DOAJPlugin.inc.php.

References XMLCustomWriter.createDocument(), and DOAJExportDom.generateJournalDom().

Referenced by display().

DOAJPlugin.getArticlesPerIssue ( journalId  ) 

Get the number of articles per issue.

Parameters:
$journalId int
Returns:
int

Definition at line 174 of file DOAJPlugin.inc.php.

References DAORegistry.getDAO().

Referenced by emailRep().

DOAJPlugin.getDescription (  ) 

Get the description of this plugin

Returns:
string

Reimplemented from ImportExportPlugin.

Definition at line 58 of file DOAJPlugin.inc.php.

References Locale.translate().

DOAJPlugin.getDisplayName (  ) 

Get the display name for this plugin

Returns:
string

Reimplemented from ImportExportPlugin.

Definition at line 50 of file DOAJPlugin.inc.php.

References Locale.translate().

DOAJPlugin.getInstallDataFile (  ) 

Get the filename for the data file to be installed with this plugin

Returns:
string

Reimplemented from Plugin.

Definition at line 66 of file DOAJPlugin.inc.php.

References Plugin.getPluginPath().

DOAJPlugin.getName (  ) 

Get the name of this plugin. The name must be unique within its category.

Returns:
String name of plugin

Reimplemented from ImportExportPlugin.

Definition at line 42 of file DOAJPlugin.inc.php.

Referenced by emailRep().

DOAJPlugin.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 iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

Definition at line 31 of file DOAJPlugin.inc.php.

References Plugin.addLocaleData().


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

Generated on Mon Jul 14 10:55:41 2008 for Open Journal Systems by  doxygen 1.5.6