tool_generator_backend Class Reference

Backend generic code for all tool_generator commands. More...

Inheritance diagram for tool_generator_backend:

Public Member Functions
	__construct ($size, $fixeddataset=false, $filesizelimit=false, $progress=true)
	Generic generator class.
	dot (int $number, int $total)
	Outputs dots.
	end_log ()
	Ends a log string that was started using log function with $leaveopen.
	log (string $langstring, $a=null, bool $leaveopen=false, string $module='tool_generator')
	Displays information as part of progress.

Static Public Member Functions
static	size_for_name ($sizename)
	Converts a size name into the numeric constant.

Public Attributes
int const	DEFAULT_SIZE = 3
	Default size index.
int const	MAX_SIZE = 5
	Highest (largest) size index.
int const	MIN_SIZE = 0
	Lowest (smallest) size index.

Protected Attributes
int bool	$filesizelimit
	Maximum number of bytes for file.
bool	$fixeddataset
	True if we want a fixed dataset or false to generate random data.
int	$lastdot
	Epoch time at which last dot was displayed.
int	$lastpercentage
	Epoch time at which last percentage was displayed.
bool	$progress
	True if displaying progress.
int	$size
	Size code (index in the above arrays)
int	$starttime
	Epoch time at which current step (current set of dots) started.

Detailed Description

Backend generic code for all tool_generator commands.

@abstract

Copyright

2013 The Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

tool_generator_backend::__construct	(		$size,
			$fixeddataset = false,
			$filesizelimit = false,
			$progress = true )

Generic generator class.

Parameters

int	$size	Size as numeric index
bool	$fixeddataset	To use fixed or random data
int | bool	$filesizelimit	The max number of bytes for a generated file
bool	$progress	True if progress information should be displayed

Exceptions

coding_exception

If parameters are invalid

Member Function Documentation

dot()

tool_generator_backend::dot	(	int	$number,
		int	$total )

Outputs dots.

There is up to one dot per second. Once a minute, it displays a percentage.

Parameters

int	$number	Number of completed items
int	$total	Total number of items to complete

log()

tool_generator_backend::log	(	string	$langstring,
			$a = null,
		bool	$leaveopen = false,
		string	$module = 'tool_generator' )

Displays information as part of progress.

Parameters

string	$langstring	Part of langstring (after progress_)
mixed	$a	Optional lang string parameters
bool	$leaveopen	If true, doesn't close LI tag (ready for dots)
string	$module	module for language string

size_for_name()

static tool_generator_backend::size_for_name ( $sizename )

static

Converts a size name into the numeric constant.

Parameters

string

$sizename

Size name e.g. 'L'

Return values

int	Numeric version

Exceptions

coding_exception

If the size name is not known

---

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

• admin/tool/generator/classes/backend.php