Inheritance diagram for TaskRenameTarget:

Public Member Functions
	__construct (&$CIFolder)

	run ()

	finalize ()

Public Member Functions inherited from TaskCopy
	__construct (&$CIFolder)

	init ()

	finalize ()

Public Member Functions inherited from CITask
	__construct (&$CIFolder, $label)

	getName ()

	setLabel ($label)

	getLabel ()

	setDescription ($description)

	getDescription ()

	skip ()

	skipIt ()

	setItemSubDirs ($itemSubDirs)

	getStatus ()

	statusUndefined ()

	statusRunning ()

	statusWait ()

	statusDone ()

	statusPBCT ()

	statusPBC ()

	statusSkipped ()

	statusError ()

	statusConfigError ()

	init ()

	run ()

	finalize ()

Public Attributes
const	TASK_LABEL = 'Rename target to final'

const	IS_RECURSIVE = true

Public Attributes inherited from TaskCopy
const	TASK_LABEL = 'Copy files (abstract)'

const	CONF_UPDATE_FOLDERS = 'UPDATE_FOLDERS'

const	CONF_UPDATE_FILES = 'UPDATE_FILES'

const	OPT_CREATE = 'create'

const	OPT_UPDATE = 'update'

const	OPT_CREATE_OR_UPDATE = 'create_or_update'

Public Attributes inherited from CITask
const	STATUS_UNDEFINED = 0
	Undefined. Default unless task changes it.

const	STATUS_RUNNING = 1
	Undefined, but indicates that the task is in progress.

const	STATUS_WAIT = 2
	Task decided that Item is not ready yet and shall be moved back to 'to-do'.

const	STATUS_DONE = 5
	Success! This means the task completed successfully.

const	STATUS_PBCT = 6
	There were problems, but the task may continue.

const	STATUS_PBC = 7
	There were problems, but subsequent task may continue.

const	STATUS_ERROR = 10
	An error occurred. Abort execution as soon as possible.

const	STATUS_CONFIG_ERROR = 11
	If a config option was not valid.

const	STATUS_SKIPPED = 15
	If task was skipped.

const	ONCE_PER_ITEM = false
	True: Run this task only once per item.

const	IS_RECURSIVE = false
	Default (false): one task = one folder. True: The task performs actions on subfolders too.

const	CONF_COPY_EXCLUDE = 'COPY_EXCLUDE'
	Patterns which files to exclude from copying.

const	MASK_TARGET_TEMP = 'temp_%s'

Protected Member Functions
	mergeFiles ($sourceFolder, $targetFolder)

Protected Member Functions inherited from TaskCopy
	loadSettings ()

	isValidUpdateFolders ($updateMode)

	isValidUpdateFiles ($updateMode)

	getCmdLogfile ()

	removeCmdLogfile ()

	createFolder ($folderName)

	move ($source, $target, $overwrite=false)

	checkTargetFolderCondition ($targetFolder, $updateFolders)

	checkTargetFileCondition ($targetFile, $updateFiles)

Protected Member Functions inherited from CITask
	setName ($name)

	exclude ($file, $excludePatterns)

	optionIsArray ($option, $optionName)

	resolveTargetFolderTemp ($CIFolder=null)

	setStatus ($status)

	setStatusUndefined ()

	setStatusRunning ()

	setStatusWait ()

	setStatusDone ()

	setStatusPBCT ()

	setStatusPBC ()

	setStatusSkipped ()

	setStatusError ()

	setStatusConfigError ()

	checkTempFolder ()

	getTempFolder ()

	setTempFolder ($tempFolder=null)

	loadSettings ()

Additional Inherited Members
Static Public Member Functions inherited from CITask
static	isRecursive ()

static	oncePerItem ()

static	getTaskByName ($taskName, $CIFolder)

static	getTaskClassName ($taskName)

Static Public Attributes inherited from TaskCopy
static	$OPT_UPDATE_FOLDERS

static	$OPT_UPDATE_FILES

Protected Attributes inherited from TaskCopy
	$updateFolders

	$updateFiles

Protected Attributes inherited from CITask
	$logger
	Logging handler.

	$name
	Class name of this task.

	$label
	Human readable Task label.

	$description
	Human readable description of Task's purpose/actions.

	$CIFolder
	CIFolder object that provides all information needed for this task.

	$sourceFolder
	Source folder of this task.

	$targetFolder
	Target folder of this task (read from config).

	$targetFolderTemp
	Temporary name of Target folder of this task. Used until inbox processing completed successfully.

	$itemSubDirs
	Array of Item subfolders: key=foldername, value=CIFolder (initialized with its config).

	$tempFolder
	Path of the temp folder for this task.

	$copyExclude
	Contains the value of CONF_COPY_EXCLUDE.

	$skip = false
	True: Skip execution. Default=false (=normal execution).

	$status
	Status of this task (=for current item subfolder).

Static Protected Attributes inherited from CITask
static	$statusGlobal
	Status of the sum of tasks of this type. // TODO! Implement and use this.

Detailed Description

Renames the target from temporary to final.

Copyright: Copyright 2018 AV-RD e.U. (License: GNU General Public License (v3))

See also

Member Function Documentation

TaskRenameTarget::mergeFiles	(	$sourceFolder,
		$targetFolder
	)

protected

Integrates files (not folders!) from $sourceFolder into $targetFolder. Files in source will overwrite files in target folder.

TaskRenameTarget::run ( )

Perform the actual steps of this task.

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