CInbox (Common-Inbox)  0.1
Common functionality for ingesting files for archiving.
Static Public Member Functions | Public Attributes | Protected Member Functions
TaskCopyRsync Class Reference
Inheritance diagram for TaskCopyRsync:
TaskCopy CITask TaskCopyToTarget

List of all members.

Static Public Member Functions

static getRsyncErrorMessage ($exitCode=null)

Public Attributes

const TASK_LABEL = 'Copy files using RSync (abstract)'
const BIN_RSYNC = 'rsync'
const CMD_COPY_MASK = 'rsync --progress --times --copy-links --inplace --log-file="[@LOGFILE@]" "[@FILE_IN@]" "[@FILE_OUT@]"'
const CMD_COPY_MASK_DEBUG = 'rsync --dry-run -v --progress --times --copy-links --inplace --log-file="[@LOGFILE@]" "[@FILE_IN@]" "[@FILE_OUT@]"'

Protected Member Functions

 copyFile ($sourceFile, $targetFile)

Detailed Description

This abstract task is used as base for tasks using Rsync as copy tool.

The actual file transfer process is done by 'rsync' to ensure reliable data transfer.

Author:
Peter Bubestinger-Steindl (pb@av-rd.com)
See also:

Member Function Documentation

TaskCopyRsync::copyFile ( sourceFile,
targetFile 
) [protected]

Copies a single file from A to B. Uses external command to do this.

See also:
self::CMD_COPY_MASK
static TaskCopyRsync::getRsyncErrorMessage ( exitCode = null) [static]

Returns a human readable error message for a given rsync exit code value. If $exitcode=null, it returns an array with all messages (and exit code as key).

Error messages are based on documentation of "exit values" found in: http://www.samba.org/ftp/rsync/rsync.html


The documentation for this class was generated from the following file:
 All Classes Functions Variables