completion_criteria_completion Class Reference

Completion data for a specific user, course and critieria. More...

Inheritance diagram for completion_criteria_completion:

Public Member Functions
	attach_criteria (completion_criteria $criteria)
	Attach a preloaded criteria object to this object.
	delete ()
	Deletes this object from the database.
	get_criteria ()
	Return the associated criteria with this completion If nothing attached, load from the db.
	get_record_data ()
	Returns object with fields and values that are defined in database.
	get_status ()
	Return criteria status text for display in reports completion_criteria::get_status().
	insert ()
	Records this object in the Database, sets its id to the returned value, and returns that value.
	is_complete ()
	Return status of this criteria completion.
	load_optional_fields ()
	Makes sure all the optional fields are loaded.
	mark_complete ($timecompleted=null)
	Mark this criteria complete for the associated user.
	notify_changed ($deleted)
	Called immediately after the object data has been inserted, updated, or deleted in the database.
	update ()
	Updates this object in the Database, based on its object variables.
	update_from_db ()
	Using this object's id field, fetches the matching record in the DB, and looks at each variable in turn.

Static Public Member Functions
static	fetch ($params)
	Finds and returns a data_object instance based on params.
static	fetch_all ($params)
	Finds and returns all data_object instances based on params.
static	fetch_all_helper ($table, $classname, $params)
	Factory method - uses the parameters to retrieve all matching instances from the DB.
static	set_properties (&$instance, $params)
	Given an associated array or object, cycles through each key/variable and assigns the value to the corresponding variable in this object.

Public Attributes
int	$completedself
	completed status.
int	$course
int	$criteriaid
float	$gradefinal
int	$id
array	$optional_fields = array()
	Array of optional fields with default values - usually long text information that is not always needed.
array	$required_fields = array('id', 'userid', 'course', 'criteriaid', 'gradefinal', 'rpl', 'unenroled', 'timecompleted')
string	$rpl
string	$table = 'course_completion_crit_compl'
int	$timecompleted
int	$unenroled
array	$unique_fields = array('userid', 'course', 'criteriaid')
int	$userid

Static Protected Member Functions
static	fetch_helper ($table, $classname, $params)
	Factory method - uses the parameters to retrieve matching instance from the DB.

Detailed Description

Completion data for a specific user, course and critieria.

Copyright

2009 Catalyst IT Ltd

Author

Aaron Barnes aaron.nosp@m.b@ca.nosp@m.talys.nosp@m.t.ne.nosp@m.t.nz

License

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

Member Function Documentation

attach_criteria()

completion_criteria_completion::attach_criteria

(

completion_criteria

$criteria

)

Attach a preloaded criteria object to this object.

Parameters

$criteria

object completion_criteria

delete()

data_object::delete ( )

inherited

Deletes this object from the database.

Return values

bool

success

fetch()

static completion_criteria_completion::fetch ( $params )

static

Finds and returns a data_object instance based on params.

Parameters

array

$params

associative arrays varname=>value

Return values

data_object

instance of data_object or false if none found.

Reimplemented from data_object.

fetch_all()

static completion_criteria_completion::fetch_all ( $params )

static

Finds and returns all data_object instances based on params.

Parameters

array

$params

associative arrays varname=>value

Return values

array

array of data_object insatnces or false if none found.

Reimplemented from data_object.

fetch_all_helper()

static data_object::fetch_all_helper ( $table, $classname, $params )

staticinherited

Factory method - uses the parameters to retrieve all matching instances from the DB.

@final

Parameters

string	$table	The table name to fetch from
string	$classname	The class that you want the result instantiated as
array	$params	Any params required to select the desired row

Return values

mixed

array of object instances or false if not found

fetch_helper()

static data_object::fetch_helper ( $table, $classname, $params )

staticprotectedinherited

Factory method - uses the parameters to retrieve matching instance from the DB.

@final

Parameters

string	$table	The table name to fetch from
string	$classname	The class that you want the result instantiated as
array	$params	Any params required to select the desired row

Return values

object

Instance of $classname or false.

get_criteria()

completion_criteria_completion::get_criteria

(

)

Return the associated criteria with this completion If nothing attached, load from the db.

Return values

completion_criteria

get_record_data()

data_object::get_record_data ( )

inherited

Returns object with fields and values that are defined in database.

Return values

stdClass

get_status()

completion_criteria_completion::get_status

(

)

Return criteria status text for display in reports completion_criteria::get_status().

Return values

string

insert()

data_object::insert ( )

inherited

Records this object in the Database, sets its id to the returned value, and returns that value.

If successful this function also fetches the new object data from database and stores it in object properties.

Return values

int	PK ID if successful, false otherwise

is_complete()

completion_criteria_completion::is_complete

(

)

Return status of this criteria completion.

Return values

bool

load_optional_fields()

data_object::load_optional_fields ( )

inherited

Makes sure all the optional fields are loaded.

If id present (==instance exists in db) fetches data from db. Defaults are used for new instances.

mark_complete()

completion_criteria_completion::mark_complete

(

$timecompleted = null

)

Mark this criteria complete for the associated user.

This method creates a course_completion_crit_compl record

Parameters

int

$timecompleted

Time completed (optional).

Return values

int	id of completion record.

notify_changed()

data_object::notify_changed ( $deleted )

inherited

Called immediately after the object data has been inserted, updated, or deleted in the database.

Default does nothing, can be overridden to hook in special behaviour.

Parameters

bool

$deleted

Set this to true if it has been deleted.

set_properties()

static data_object::set_properties ( & $instance, $params )

staticinherited

Given an associated array or object, cycles through each key/variable and assigns the value to the corresponding variable in this object.

@final

Parameters

data_object	$instance
array	$params

update()

data_object::update ( )

inherited

Updates this object in the Database, based on its object variables.

ID must be set.

Return values

bool

success

update_from_db()

data_object::update_from_db ( )

inherited

Using this object's id field, fetches the matching record in the DB, and looks at each variable in turn.

If the DB has different data, the db's data is used to update the object. This is different from the update() function, which acts on the DB record based on the object.

Return values

bool	True for success, false otherwise.

Member Data Documentation

$optional_fields

array data_object::$optional_fields = array()

inherited

Array of optional fields with default values - usually long text information that is not always needed.

If you want to create an instance without optional fields use: new data_object($only_required_fields, false);

---

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

• completion/completion_criteria_completion.php