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 DataCite.
Definition at line 19 of file DataciteInfoSender.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| DataciteInfoSender::__construct | ( | $args | ) |
Constructor.
- Parameters
-
$argv array task arguments
Reimplemented from ScheduledTask.
Definition at line 30 of file DataciteInfoSender.inc.php.
References PluginRegistry\getPlugin(), and PluginRegistry\loadCategory().
Member Function Documentation
◆ _addLogEntry()
| DataciteInfoSender::_addLogEntry | ( | $result | ) |
Add execution log entry
- Parameters
-
$result array
Definition at line 158 of file DataciteInfoSender.inc.php.
References ScheduledTask\addExecutionLogEntry().
Referenced by _registerObjects().
◆ _getJournals()
| DataciteInfoSender::_getJournals | ( | ) |
Get all journals that meet the requirements to have their DOIs sent to DataCite.
- Returns
- array
Definition at line 97 of file DataciteInfoSender.inc.php.
References $_plugin, ScheduledTask\addExecutionLogEntry(), Application\getContextDAO(), and PluginRegistry\loadCategory().
Referenced by executeActions().
◆ _registerObjects()
| DataciteInfoSender::_registerObjects | ( | $objects, | |
| $filter, | |||
| $journal, | |||
| $objectsFileNamePart | |||
| ) |
Register objects
- Parameters
-
$objects array $filter string $journal Journal $objectsFileNamePart string
Definition at line 132 of file DataciteInfoSender.inc.php.
References $_plugin, and _addLogEntry().
Referenced by executeActions().
◆ executeActions()
| DataciteInfoSender::executeActions | ( | ) |
Implement this method to execute the task actions.
- Returns
- boolean true iff success
Reimplemented from ScheduledTask.
Definition at line 52 of file DataciteInfoSender.inc.php.
References $_plugin, _getJournals(), _registerObjects(), and PluginRegistry\loadCategory().
◆ getName()
| DataciteInfoSender::getName | ( | ) |
Get the scheduled task name. Override to define a custom task name.
- Returns
- string
Reimplemented from ScheduledTask.
Definition at line 45 of file DataciteInfoSender.inc.php.
Field Documentation
◆ $_plugin
| $_plugin DataciteInfoSender::$_plugin |
Definition at line 24 of file DataciteInfoSender.inc.php.
Referenced by _getJournals(), _registerObjects(), and executeActions().
The documentation for this class was generated from the following file:
