Open Journal Systems  3.3.0
MedraInfoSender Class Reference
Inheritance diagram for MedraInfoSender:
ScheduledTask

Public Member Functions

 __construct ($args)
 
 _addLogEntry ($result)
 
 _getJournals ()
 
 _registerObjects ($objects, $filter, $journal, $objectsFileNamePart)
 
 executeActions ()
 
 getName ()
 
- Public Member Functions inherited from ScheduledTask
 addExecutionLogEntry ($message, $type=null)
 
 execute ()
 
 getHelper ()
 
 getProcessId ()
 

Data Fields

 $_plugin
 

Additional Inherited Members

Detailed Description

Scheduled task to send deposits to mEDRA.

Definition at line 19 of file MedraInfoSender.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MedraInfoSender::__construct (   $args)

Constructor.

Parameters
$argvarray task arguments

Reimplemented from ScheduledTask.

Definition at line 30 of file MedraInfoSender.inc.php.

References PluginRegistry\getPlugin(), and PluginRegistry\loadCategory().

Member Function Documentation

◆ _addLogEntry()

MedraInfoSender::_addLogEntry (   $result)

Add execution log entry

Parameters
$resultarray

Definition at line 154 of file MedraInfoSender.inc.php.

References ScheduledTask\addExecutionLogEntry().

Referenced by _registerObjects().

◆ _getJournals()

MedraInfoSender::_getJournals ( )

Get all journals that meet the requirements to have their DOIs sent to mEDRA.

Returns
array

Definition at line 97 of file MedraInfoSender.inc.php.

References $_plugin, ScheduledTask\addExecutionLogEntry(), Application\getContextDAO(), and PluginRegistry\loadCategory().

Referenced by executeActions().

◆ _registerObjects()

MedraInfoSender::_registerObjects (   $objects,
  $filter,
  $journal,
  $objectsFileNamePart 
)

Register objects

Parameters
$objectsarray
$filterstring
$journalJournal
$objectsFileNamePartstring

Definition at line 132 of file MedraInfoSender.inc.php.

References $_plugin, and _addLogEntry().

Referenced by executeActions().

◆ executeActions()

MedraInfoSender::executeActions ( )

Implement this method to execute the task actions.

Returns
boolean true iff success

Reimplemented from ScheduledTask.

Definition at line 52 of file MedraInfoSender.inc.php.

References $_plugin, _getJournals(), _registerObjects(), and PluginRegistry\loadCategory().

◆ getName()

MedraInfoSender::getName ( )

Get the scheduled task name. Override to define a custom task name.

Returns
string

Reimplemented from ScheduledTask.

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

Field Documentation

◆ $_plugin

$_plugin MedraInfoSender::$_plugin

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