TaskSkeleton Class Reference

Inheritance diagram for TaskSkeleton:

List of all members.

Public Member Functions
	__construct (&$CIFolder)
Public Attributes
const	TASK_LABEL = 'Task Skeleton'
	TODO: Change the taskname.
Common task functions
	init ()
	run ()
	finalize ()
	loadSettings ()

---

Detailed Description

Skeleton to use when creating a new task. Search for the word "TODO" and follow the instructions.

Author:

Peter Bubestinger-Steindl (pb@av-rd.com)

Copyright:

Copyright 2016, Peter Bubestinger-Steindl (License: GNU General Public License (v3))

See also:

• AV-RD website
• FSFE: What is Free Software?
• The GNU General Public License

---

Member Function Documentation

TaskSkeleton::finalize

(

)

Actions to be performed *after* run() finished successfully;

Return values:

boolean

True if everything went fine, False if an error occurred.

Reimplemented from CITask.

TaskSkeleton::init

(

)

Prepare everything so it's ready for processing.

Return values:

boolean

True if task shall proceed. False if not.

Reimplemented from CITask.

TaskSkeleton::loadSettings

(

)

[protected]

Load settings from config that are relevant for this task.

Return values:

boolean

True if everything went fine, False if an error occurred.

Reimplemented from CITask.

TaskSkeleton::run

(

)

Perform the actual steps of this task.

Return values:

boolean

True if task shall proceed. False if not.

Reimplemented from CITask.

---

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

• /media/storage_700/storage/F_Drive/JobsToDo/Das-Firma/owncloud/Development/avrd.git/projects/cinbox/bin/tasks/TaskSkeleton.php