Depositor Class Reference

Inheritance diagram for Depositor:

Public Member Functions
	__construct ($args)
	executeActions ()
	getName ()
Public Member Functions inherited from ScheduledTask
	addExecutionLogEntry ($message, $type=null)
	execute ()
	getHelper ()
	getProcessId ()

Data Fields
	$_plugin

Protected Member Functions
	_processHavingUpdatedContent (&$journal)
	_processNeedPackaging ($journal)
	_processNeedTransferring ($journal)
	_processNewDepositObjects ($journal)
	_processStatusUpdates ($journal)

Detailed Description

Definition at line 17 of file Depositor.inc.php.

Constructor & Destructor Documentation

__construct()

Depositor::__construct

(

$args

)

Constructor.

Parameters

$args

array task arguments

Reimplemented from ScheduledTask.

Definition at line 29 of file Depositor.inc.php.

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

Member Function Documentation

_processHavingUpdatedContent()

Depositor::_processHavingUpdatedContent ( &  $journal )

protected

Parameters

$journal

Journal Object

Go thourgh the deposits and mark them as updated if they have been

Definition at line 169 of file Depositor.inc.php.

References DAORegistry\getDAO().

Referenced by executeActions().

_processNeedPackaging()

Depositor::_processNeedPackaging (   $journal )

protected

Create packages for any deposits that don't have any or have been updated

Parameters

$journal

Journal Object

Definition at line 204 of file Depositor.inc.php.

References ScheduledTask\addExecutionLogEntry(), and DAORegistry\getDAO().

Referenced by executeActions().

_processNeedTransferring()

Depositor::_processNeedTransferring (   $journal )

protected

If a deposit hasn't been transferred, transfer it

Parameters

$journal

Journal Object

Definition at line 179 of file Depositor.inc.php.

References ScheduledTask\addExecutionLogEntry(), and DAORegistry\getDAO().

Referenced by executeActions().

_processNewDepositObjects()

Depositor::_processNewDepositObjects (   $journal )

protected

Create new deposits for deposit objects

Parameters

$journal

Journal Object

Definition at line 236 of file Depositor.inc.php.

References DAORegistry\getDAO().

Referenced by executeActions().

_processStatusUpdates()

Depositor::_processStatusUpdates (   $journal )

protected

Go through existing deposits and fetch their status from the PLN

Parameters

$journal

Journal

Definition at line 144 of file Depositor.inc.php.

References ScheduledTask\addExecutionLogEntry(), and DAORegistry\getDAO().

Referenced by executeActions().

executeActions()

Depositor::executeActions

(

)

Implement this method to execute the task actions.

Returns

boolean true iff success

Reimplemented from ScheduledTask.

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

References _processHavingUpdatedContent(), _processNeedPackaging(), _processNeedTransferring(), _processNewDepositObjects(), _processStatusUpdates(), ScheduledTask\addExecutionLogEntry(), and DAORegistry\getDAO().

getName()

Depositor::getName

(

)

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

Returns

string

Reimplemented from ScheduledTask.

Definition at line 38 of file Depositor.inc.php.

Field Documentation

$_plugin

Object Depositor::$_plugin

Definition at line 23 of file Depositor.inc.php.

---

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

• Depositor.inc.php