core_competency\competency_rule Class Reference

Competency rule base abstract class. More...

Inheritance diagram for core_competency\competency_rule:

Public Member Functions
	__construct (competency $competency)
	Constructor.
	matches (user_competency $usercompetency)
	Whether or not the rule is matched.
	validate_config ($value)
	Validate the rule config.

Static Public Member Functions
static	get_name ()
	The name of the rule.
static	migrate_config ($config, $mappings)
	Migrate rule config from one set of competencies to another.

Protected Member Functions
	get_config ()
	Get the rule config.

Protected Attributes
competency	$competency
	The competency.

Detailed Description

Competency rule base abstract class.

Rules are attached to a competency and then tested against a user competency to determine whether or not it matches.

Copyright

2015 Frédéric Massart - FMCorz.net

License

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

Constructor & Destructor Documentation

__construct()

core_competency\competency_rule::__construct

(

competency

$competency

)

Constructor.

Parameters

competency

$competency

The competency.

Member Function Documentation

get_config()

core_competency\competency_rule::get_config ( )

protected

Get the rule config.

Return values

mixed

Reimplemented in core_competency\competency_rule_points.

get_name()

static core_competency\competency_rule::get_name ( )

static

The name of the rule.

Return values

lang_string

Reimplemented in core_competency\competency_rule_all, and core_competency\competency_rule_points.

matches()

core_competency\competency_rule::matches ( user_competency $usercompetency )

abstract

Whether or not the rule is matched.

Parameters

user_competency

$usercompetency

The user competency to test against.

Return values

bool

Reimplemented in core_competency\competency_rule_all, and core_competency\competency_rule_points.

migrate_config()

static core_competency\competency_rule::migrate_config ( $config, $mappings )

static

Migrate rule config from one set of competencies to another.

Exceptions should be thrown when the migration can not be performed.

Parameters

string	$config	Original config rule of a competency.
array	$mappings	Array that matches the original competency IDs with the new competencies objects.

Return values

string

New configuration.

Exceptions

Exception

Reimplemented in core_competency\competency_rule_points.

validate_config()

core_competency\competency_rule::validate_config ( $value )

abstract

Validate the rule config.

Parameters

string

$value

The value to validate.

Return values

bool

Reimplemented in core_competency\competency_rule_all, and core_competency\competency_rule_points.

---

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

• competency/classes/competency_rule.php