Inheritance diagram for TaskPreProcs:

Public Member Functions
	__construct (&$CIFolder)

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

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 = 'Run Pre-Processors'

const	CONF_PREPROCS = 'PREPROCS'

Public Attributes inherited from TaskExec
const	TASK_LABEL = 'Execute external programs (abstract)'

const	EXIT_STATUS_DONE = 0
	Success! This means the task completed successfully.

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

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

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

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

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

const	EXIT_STATUS_SKIPPED = 15
	If task was skipped.

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 Attributes
	$preProcs

Protected Attributes inherited from TaskExec
	$exec

	$logFile

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).

Common task functions
	init ()

	run ()

	loadSettings ()

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

static	oncePerItem ()

static	getTaskByName ($taskName, $CIFolder)

static	getTaskClassName ($taskName)

Protected Member Functions inherited from TaskExec
	isCmdValid ($command)

	resolveCmd ($command, $arguments=null)

	runScript ($script)

	setStatusByExitcode ($exitCode)

	getCmdLogfile ($prefix=null)

	removeCmdLogfile ($logFile=null)

	writeToCmdLogfile ($msg, $logFile=null)

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 ()

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

Detailed Description

Runs pre-processor scripts, in order as configured. Requires all pre-proc scripts to run successfully to return positive status.

Author: Peter Bubestinger-Steindl (pb@av.nosp@m.-rd..nosp@m.com)

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

See also

Member Function Documentation

TaskPreProcs::init ( )

Prepare everything so it's ready for processing.

Return values

boolean True if task shall proceed. False if not.

TaskPreProcs::loadSettings ( )

protected

Load settings from config that are relevant for this task.

Return values

boolean True if everything went fine. False if not.

TaskPreProcs::run ( )

Perform the actual steps of this task.

Return values

boolean True if task shall proceed. False if not.

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

/home/pb/avrd/projects/cinbox/bin/tasks/TaskPreProcs.php

Public Member Functions

Public Attributes

Protected Attributes

Common task functions

Additional Inherited Members

Detailed Description

Member Function Documentation