Class for loading/storing plans from the DB. More...

Inheritance diagram for core_competency\plan:

Public Member Functions
	__call ($method, $arguments)
	Magic method to capture getters and setters. More...

	can_be_edited ()
	Check if plan can be edited. More...

	can_comment ()
	Whether the current user can comment on this plan. More...

	can_manage ()
	Whether the current user can manage the plan. More...

	can_read ()
	Whether the current user can read the plan. More...

	can_read_comments ()
	Whether the current user can read comments on this plan. More...

	can_request_review ()
	Whether the current user can request a review of the plan. More...

	can_review ()
	Whether the current user can review the plan. More...

	create ()
	Insert a record in the DB. More...

	delete ()
	Delete an entry from the database. More...

	from_record (stdClass $record)
	Populate this class with data from a DB record. More...

	get ($property)
	Data getter. More...

	get_comment_object ()
	Get the comment object. More...

	get_competencies ()
	Get the competencies in this plan. More...

	get_competency ($competencyid)
	Get a single competency from this plan. More...

	get_context ()
	Get the context in which the plan is attached. More...

	get_errors ()
	Returns the validation errors. More...

	get_statusname ()
	Human readable status name. More...

	get_template ()
	Get the plan template. More...

	is_based_on_template ()
	Check if a template is associated to the plan. More...

	is_draft ()
	Is the plan in draft mode? More...

	is_valid ()
	Returns whether or not the model is valid. More...

	read ()
	Load the data from the DB. More...

	save ()
	Saves the record to the database. More...

	set ($property, $value)
	Data setter. More...

	to_record ()
	Create a DB record from this class. More...

	update ()
	Update the existing record in the DB. More...

	validate ()
	Validates the data. More...

Static Public Member Functions
static	can_comment_user ($planuserid)
	Can the current user comment on a user's plan? More...

static	can_manage_user ($planuserid)
	Can the current user manage a user's plan? More...

static	can_manage_user_draft ($planuserid)
	Can the current user manage a user's draft plan? More...

static	can_read_comments_user ($planuserid)
	Can the current user read the comments on a user's plan? More...

static	can_read_user ($planuserid)
	Can the current user view a user's plan? More...

static	can_read_user_draft ($planuserid)
	Can the current user view a user's draft plan? More...

static	can_request_review_user ($planuserid)
	Can the current user request the draft to be reviewed. More...

static	can_review_user ($planuserid)
	Can the current user review the plan. More...

static	count_records (array $conditions=array())
	Count a list of records. More...

static	count_records_for_template ($templateid, $status)
	Count the number of plans for a template, optionally filtering by status. More...

static	count_records_select ($select, $params=null)
	Count a list of records. More...

static	extract_record ($row, $prefix=null)
	Extract a record from a row of data. More...

static	get_by_user_and_competency ($userid, $competencyid)
	Get the plans of a user containing a specific competency. More...

static	get_draft_statuses ()
	Get the list of draft statuses. More...

static	get_formatted_properties ()
	Gets all the formatted properties. More...

static	get_record ($filters=array())
	Load a single record. More...

static	get_records ($filters=array(), $sort='', $order='ASC', $skip=0, $limit=0)
	Load a list of records. More...

static	get_records_for_template ($templateid, $status=0, $skip=0, $limit=100)
	Get the plans for a template, optionally filtering by status. More...

static	get_records_select ($select, $params=null, $sort='', $fields=' *', $limitfrom=0, $limitnum=0)
	Load a list of records based on a select query. More...

static	get_recordset_for_due_and_incomplete ()
	Get the recordset of the plans that are due, incomplete and not draft. More...

static	get_sql_fields ($alias, $prefix=null)
	Return the list of fields for use in a SELECT clause. More...

static	get_status_list ($userid)
	Return a list of status depending on capabilities. More...

static	has_property ($property)
	Returns whether or not a property was defined. More...

static	has_records_for_template ($templateid)
	Checks if a template has user plan records. More...

static	is_property_required ($property)
	Returns whether or not a property is required. More...

static	properties_definition ()
	Get the properties definition of this model. More...

static	record_exists ($id)
	Check if a record exists by ID. More...

static	record_exists_select ($select, array $params=null)
	Check if a records exists. More...

static	update_multiple_from_template (template $template)
	Update from template. More...

Public Attributes
const	DUEDATE_THRESHOLD = 600
	10 minutes threshold

const	STATUS_ACTIVE = 1
	Active status.

const	STATUS_COMPLETE = 2
	Complete status.

const	STATUS_DRAFT = 0
	Draft status.

const	STATUS_IN_REVIEW = 4
	In review.

const	STATUS_WAITING_FOR_REVIEW = 3
	Waiting for review.

const	TABLE = 'competency_plan'

Protected Member Functions
	after_create ()
	Hook to execute after a create. More...

	after_delete ($result)
	Hook to execute after a delete. More...

	after_update ($result)
	Hook to execute after an update. More...

	before_create ()
	Hook to execute before a create. More...

	before_delete ()
	Hook to execute before a delete. More...

	before_update ()
	Hook to execute before an update. More...

	before_validate ()
	Hook to execute before validate. More...

	raw_get ($property)
	Internal Data getter. More...

	raw_set ($property, $value)
	Data setter. More...

	validate_duedate ($value)
	Validate the due date. More...

	validate_templateid ($value)
	Validate the template ID. More...

	validate_userid ($value)
	Validate the user ID. More...

	verify_protected_methods ()
	This function is used to verify that custom getters and setters are declared as protected. More...

Static Protected Member Functions
static	define_properties ()
	Return the definition of the properties of this model. More...

static	get_property_default_value ($property)
	Gets the default value for a property. More...

static	get_property_error_message ($property)
	Gets the error message for a property. More...

Protected Attributes
plan	$beforeupdate = null
	object before update.

Detailed Description

Class for loading/storing plans from the DB.

Copyright: 2015 David Monllao

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

Member Function Documentation

◆ __call()

core_competency\persistent::__call	(	$method,
		$arguments
	)

finalinherited

Magic method to capture getters and setters.

This is only available for competency persistents for backwards compatibility. It is recommended to use get('propertyname') and set('propertyname', 'value') directly.

Parameters

string	$method	Callee.
array	$arguments	List of arguments.

Return values

mixed

◆ after_create()

core\persistent::after_create ( )

protectedinherited

Hook to execute after a create.

This is only intended to be used by child classes, do not put any logic here!

Return values

void

Reimplemented in tool_dataprivacy\purpose_override, tool_dataprivacy\purpose, and tool_dataprivacy\contextlevel.

◆ after_delete()

core\persistent::after_delete ( $result )

protectedinherited

Hook to execute after a delete.

This is only intended to be used by child classes, do not put any logic here!

Parameters

bool $result Whether or not the delete was successful.

Return values

void

Reimplemented in core_competency\template_competency, core_competency\plan_competency, core_competency\course_module_competency, core_competency\course_competency, core_competency\competency, and tool_policy\policy_version.

◆ after_update()

core\persistent::after_update ( $result )

protectedinherited

Hook to execute after an update.

This is only intended to be used by child classes, do not put any logic here!

Parameters

bool $result Whether or not the update was successful.

Return values

void

Reimplemented in core_competency\template, core_competency\competency, tool_policy\policy_version, tool_dataprivacy\purpose_override, tool_dataprivacy\purpose, and tool_dataprivacy\contextlevel.

◆ before_create()

core\persistent::before_create ( )

protectedinherited

Hook to execute before a create.

Please note that at this stage the data has already been validated and therefore any new data being set will not be validated before it is sent to the database.

This is only intended to be used by child classes, do not put any logic here!

Return values

void

◆ before_delete()

core\persistent::before_delete ( )

protectedinherited

Hook to execute before a delete.

This is only intended to be used by child classes, do not put any logic here!

Return values

void

Reimplemented in tool_dataprivacy\purpose_override, tool_dataprivacy\purpose, and tool_dataprivacy\contextlevel.

◆ before_update()

core\persistent::before_update ( )

protectedinherited

Hook to execute before an update.

Please note that at this stage the data has already been validated and therefore any new data being set will not be validated before it is sent to the database.

This is only intended to be used by child classes, do not put any logic here!

Return values

void

◆ before_validate()

core_competency\plan::before_validate ( )

protected

Hook to execute before validate.

Return values

void

Reimplemented from core\persistent.

◆ can_be_edited()

core_competency\plan::can_be_edited ( )

Check if plan can be edited.

Return values

bool

◆ can_comment()

core_competency\plan::can_comment ( )

Whether the current user can comment on this plan.

Return values

bool

◆ can_comment_user()

static core_competency\plan::can_comment_user ( $planuserid )

static

Can the current user comment on a user's plan?

Parameters

int $planuserid The user ID the plan belongs to.

Return values

bool

◆ can_manage()

core_competency\plan::can_manage ( )

Whether the current user can manage the plan.

Return values

bool

◆ can_manage_user()

static core_competency\plan::can_manage_user ( $planuserid )

static

Can the current user manage a user's plan?

Parameters

int $planuserid The user to whom the plan would belong.

Return values

bool

◆ can_manage_user_draft()

static core_competency\plan::can_manage_user_draft ( $planuserid )

static

Can the current user manage a user's draft plan?

Parameters

int $planuserid The user to whom the plan would belong.

Return values

bool

◆ can_read()

core_competency\plan::can_read ( )

Whether the current user can read the plan.

Return values

bool

◆ can_read_comments()

core_competency\plan::can_read_comments ( )

Whether the current user can read comments on this plan.

Return values

bool

◆ can_read_comments_user()

static core_competency\plan::can_read_comments_user ( $planuserid )

static

Can the current user read the comments on a user's plan?

Parameters

int $planuserid The user ID the plan belongs to.

Return values

bool

◆ can_read_user()

static core_competency\plan::can_read_user ( $planuserid )

static

Can the current user view a user's plan?

Parameters

int $planuserid The user to whom the plan would belong.

Return values

bool

◆ can_read_user_draft()

static core_competency\plan::can_read_user_draft ( $planuserid )

static

Can the current user view a user's draft plan?

Parameters

int $planuserid The user to whom the plan would belong.

Return values

bool

◆ can_request_review()

core_competency\plan::can_request_review ( )

Whether the current user can request a review of the plan.

Return values

bool

◆ can_request_review_user()

static core_competency\plan::can_request_review_user ( $planuserid )

static

Can the current user request the draft to be reviewed.

Parameters

int $planuserid The user to whom the plan would belong.

Return values

bool

◆ can_review()

core_competency\plan::can_review ( )

Whether the current user can review the plan.

Return values

bool

◆ can_review_user()

static core_competency\plan::can_review_user ( $planuserid )

static

Can the current user review the plan.

This means being able to send the plan from draft to active, and vice versa.

Parameters

int $planuserid The user to whom the plan would belong.

Return values

bool

◆ count_records()

static core\persistent::count_records ( array $conditions = array() )

staticinherited

Count a list of records.

Parameters

array $conditions An array of conditions.

Return values

int

◆ count_records_for_template()

static core_competency\plan::count_records_for_template	(	$templateid,
		$status
	)

static

Count the number of plans for a template, optionally filtering by status.

Parameters

int	$templateid	The template ID
int	$status	The plan status. 0 means all statuses.

Return values

int

◆ count_records_select()

static core\persistent::count_records_select	(	$select,
		$params = `null`
	)

staticinherited

Count a list of records.

Parameters

string	$select
array	$params

Return values

int

◆ create()

core\persistent::create ( )

finalinherited

Insert a record in the DB.

Return values

static

◆ define_properties()

static core_competency\plan::define_properties ( )

staticprotected

Return the definition of the properties of this model.

Return values

array

Reimplemented from core\persistent.

◆ delete()

core\persistent::delete ( )

finalinherited

Delete an entry from the database.

Return values

bool	True on success.

◆ extract_record()

static core\persistent::extract_record	(	$row,
		$prefix = `null`
	)

staticinherited

Extract a record from a row of data.

Most likely used in combination with self::get_sql_fields(). This method is simple enough to be used by non-persistent classes, keep that in mind when modifying it.

e.g. persistent::extract_record($row, 'user'); should work.

Parameters

stdClass	$row	The row of data.
string	$prefix	The prefix the data fields are prefixed with, defaults to the table name followed by underscore.

Return values

stdClass The extracted data.

◆ from_record()

core\persistent::from_record ( stdClass $record )

finalinherited

Populate this class with data from a DB record.

Note that this does not use any custom setter because the data here is intended to represent what is stored in the database.

Parameters

stdClass $record A DB record.

Return values

static

◆ get()

core\persistent::get ( $property )

finalinherited

Data getter.

This is the main getter for all the properties. Developers can implement their own getters (get_propertyname) and they will be called by this function. Custom getters can use raw_get to get the raw value. Internally this is not used by } or * self::from_record() because the data is not expected to be validated or changed when reading/writing raw records from the DB.

Parameters

string $property The property name.

Return values

mixed

◆ get_by_user_and_competency()

static core_competency\plan::get_by_user_and_competency	(	$userid,
		$competencyid
	)

static

Get the plans of a user containing a specific competency.

Parameters

int	$userid	The user ID.
int	$competencyid	The competency ID.

Return values

plans[]

◆ get_comment_object()

core_competency\plan::get_comment_object ( )

Get the comment object.

Return values

comment

◆ get_competencies()

core_competency\plan::get_competencies ( )

Get the competencies in this plan.

Return values

competency[]

◆ get_competency()

core_competency\plan::get_competency ( $competencyid )

Get a single competency from this plan.

This will throw an exception if the competency does not belong to the plan.

Parameters

int $competencyid The competency ID.

Return values

competency

◆ get_context()

core_competency\plan::get_context ( )

Get the context in which the plan is attached.

Return values

context_user

◆ get_draft_statuses()

static core_competency\plan::get_draft_statuses ( )

static

Get the list of draft statuses.

Return values

array Contains the status constants.

◆ get_errors()

core\persistent::get_errors ( )

finalinherited

Returns the validation errors.

Return values

array

◆ get_formatted_properties()

static core\persistent::get_formatted_properties ( )

staticfinalinherited

Gets all the formatted properties.

Formatted properties are properties which have a format associated with them.

Return values

array Keys are property names, values are property format names.

◆ get_property_default_value()

static core\persistent::get_property_default_value ( $property )

staticfinalprotectedinherited

Gets the default value for a property.

This assumes that the property exists.

Parameters

string $property The property name.

Return values

mixed

◆ get_property_error_message()

static core\persistent::get_property_error_message ( $property )

staticfinalprotectedinherited

Gets the error message for a property.

This assumes that the property exists.

Parameters

string $property The property name.

Return values

lang_string

◆ get_record()

static core\persistent::get_record ( $filters = array() )

staticinherited

Load a single record.

Parameters

array $filters Filters to apply.

Return values

false|static

◆ get_records()

static core\persistent::get_records	(	$filters = `array()`,
		$sort = `''`,
		$order = `'ASC'`,
		$skip = `0`,
		$limit = `0`
	)

staticinherited

Load a list of records.

Parameters

array	$filters	Filters to apply.
string	$sort	Field to sort by.
string	$order	Sort order.
int	$skip	Limitstart.
int	$limit	Number of rows to return.

Return values

static[]

◆ get_records_for_template()

static core_competency\plan::get_records_for_template	(	$templateid,
		$status = `0`,
		$skip = `0`,
		$limit = `100`
	)

static

Get the plans for a template, optionally filtering by status.

Parameters

int	$templateid	The template ID
int	$status	The plan status. 0 means all statuses.
int	$skip	The number of plans to skip
int	$limit	The max number of plans to return

Return values

int

◆ get_records_select()

static core\persistent::get_records_select	(	$select,
		$params = `null`,
		$sort = `''`,
		$fields = `'*'`,
		$limitfrom = `0`,
		$limitnum = `0`
	)

staticinherited

Load a list of records based on a select query.

Parameters

string	$select
array	$params
string	$sort
string	$fields
int	$limitfrom
int	$limitnum

Return values

static[]

◆ get_recordset_for_due_and_incomplete()

static core_competency\plan::get_recordset_for_due_and_incomplete ( )

static

Get the recordset of the plans that are due, incomplete and not draft.

Return values

moodle_recordset

◆ get_sql_fields()

static core\persistent::get_sql_fields	(	$alias,
		$prefix = `null`
	)

staticinherited

Return the list of fields for use in a SELECT clause.

Having the complete list of fields prefixed allows for multiple persistents to be fetched in a single query. Use self::extract_record() to extract the records from the query result.

Parameters

string	$alias	The alias used for the table.
string	$prefix	The prefix to use for each field, defaults to the table name followed by underscore.

Return values

string The SQL fragment.

◆ get_status_list()

static core_competency\plan::get_status_list ( $userid )

static

Return a list of status depending on capabilities.

Parameters

int $userid The user to whom the plan would belong.

Return values

array

◆ get_statusname()

core_competency\plan::get_statusname ( )

Human readable status name.

Return values

string

◆ get_template()

core_competency\plan::get_template ( )

Get the plan template.

Return values

template|null

◆ has_property()

static core\persistent::has_property ( $property )

staticfinalinherited

Returns whether or not a property was defined.

Parameters

string $property The property name.

Return values

boolean

◆ has_records_for_template()

static core_competency\plan::has_records_for_template ( $templateid )

static

Checks if a template has user plan records.

Parameters

int $templateid The template ID

Return values

boolean

◆ is_based_on_template()

core_competency\plan::is_based_on_template ( )

Check if a template is associated to the plan.

Return values

bool

◆ is_draft()

core_competency\plan::is_draft ( )

Is the plan in draft mode?

This method is convenient to know if the plan is a draft because whilst a draft is being reviewed its status is not "draft" any more, but it still is a draft nonetheless.

Return values

boolean

◆ is_property_required()

static core\persistent::is_property_required ( $property )

staticfinalinherited

Returns whether or not a property is required.

By definition a property with a default value is not required.

Parameters

string $property The property name.

Return values

boolean

◆ is_valid()

core\persistent::is_valid ( )

finalinherited

Returns whether or not the model is valid.

Return values

boolean True when it is.

◆ properties_definition()

static core\persistent::properties_definition ( )

staticfinalinherited

Get the properties definition of this model.

Return values

array

◆ raw_get()

core\persistent::raw_get ( $property )

finalprotectedinherited

Internal Data getter.

This is the main getter for all the properties. Developers can implement their own getters but they should be calling self::get() in order to retrieve the value. Essentially the getters defined by the developers would only ever be used as helper methods and will not be called internally at this stage. In other words, do not expect } or * self::from_record() to use them.

This is protected because it is only for raw low level access to the data fields. Note this function is named raw_get and not get_raw to avoid naming clashes with a property named raw.

Parameters

string $property The property name.

Return values

mixed

◆ raw_set()

core\persistent::raw_set	(	$property,
		$value
	)

finalprotectedinherited

Data setter.

This is the main setter for all the properties. Developers can implement their own setters but they should always be calling self::set() in order to set the value. Essentially the setters defined by the developers are helper methods and will not be called internally at this stage. In other words do not expect } or * self::from_record() to use them.

This is protected because it is only for raw low level access to the data fields.

Parameters

string	$property	The property name.
mixed	$value	The value.

Return values

$this

◆ read()

core\persistent::read ( )

finalinherited

Load the data from the DB.

Return values

static

◆ record_exists()

static core\persistent::record_exists ( $id )

staticinherited

Check if a record exists by ID.

Parameters

int $id Record ID.

Return values

bool

◆ record_exists_select()

static core\persistent::record_exists_select	(		$select,
		array	$params = `null`
	)

staticinherited

Check if a records exists.

Parameters

string	$select
array	$params

Return values

bool

◆ save()

core\persistent::save ( )

finalinherited

Saves the record to the database.

If this record has an ID, then } is called, otherwise self::create() is called. Before and after hooks for create() or update() will be called appropriately.

Return values

void

◆ set()

core\persistent::set	(	$property,
		$value
	)

finalinherited

Data setter.

This is the main setter for all the properties. Developers can implement their own setters (set_propertyname) and they will be called by this function. Custom setters should call internal_set() to finally set the value. Internally this is not used } or * self::from_record() because the data is not expected to be validated or changed when reading/writing raw records from the DB.

Parameters

string $property The property name.

Return values

$this

◆ to_record()

core\persistent::to_record ( )

finalinherited

Create a DB record from this class.

Note that this does not use any custom getter because the data here is intended to represent what is stored in the database.

Return values

stdClass

◆ update()

core\persistent::update ( )

finalinherited

Update the existing record in the DB.

Return values

bool	True on success.

◆ update_multiple_from_template()

static core_competency\plan::update_multiple_from_template ( template $template )

static

Update from template.

Bulk update a lot of plans from a template

Parameters

template $template

Return values

bool

◆ validate()

core\persistent::validate ( )

finalinherited

Validates the data.

Developers can implement addition validation by defining a method as follows. Note that the method MUST return a lang_string() when there is an error, and true when the data is valid.

protected function validate_propertyname($value) { if ($value !== 'My expected value') { return new lang_string('invaliddata', 'error'); } return true }

It is OK to use other properties in your custom validation methods when you need to, however note they might not have been validated yet, so try not to rely on them too much.

Note that the validation methods should be protected. Validating just one field is not recommended because of the possible dependencies between one field and another,also the field ID can be used to check whether the object is being updated or created.

When validating foreign keys the persistent should only check that the associated model exists. The validation methods should not be used to check for a change in that relationship. The API method setting the attributes on the model should be responsible for that. E.g. On a course model, the method validate_categoryid will check that the category exists. However, if a course can never be moved outside of its category it would be up to the calling code to ensure that the category ID will not be altered.

Return values

array|true Returns true when the validation passed, or an array of properties with errors.

◆ validate_duedate()

core_competency\plan::validate_duedate ( $value )

protected

Validate the due date.

When setting a due date it must not exceed the DUEDATE_THRESHOLD.

Parameters

int $value The due date.

Return values

bool|lang_string

◆ validate_templateid()

core_competency\plan::validate_templateid ( $value )

protected

Validate the template ID.

Parameters

mixed $value The value.

Return values

true|lang_string

◆ validate_userid()

core_competency\plan::validate_userid ( $value )

protected

Validate the user ID.

Parameters

int $value

Return values

true|lang_string

◆ verify_protected_methods()

core\persistent::verify_protected_methods ( )

finalprotectedinherited

This function is used to verify that custom getters and setters are declared as protected.

Persistent properties should always be accessed via get('property') and set('property', 'value') which will call the custom getter or setter if it exists. We do not want to allow inconsistent access to the properties.

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

competency/classes/plan.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ after_create()

◆ after_delete()

◆ after_update()

◆ before_create()

◆ before_delete()

◆ before_update()

◆ before_validate()

◆ can_be_edited()

◆ can_comment()

◆ can_comment_user()

◆ can_manage()

◆ can_manage_user()

◆ can_manage_user_draft()

◆ can_read()

◆ can_read_comments()

◆ can_read_comments_user()

◆ can_read_user()

◆ can_read_user_draft()

◆ can_request_review()

◆ can_request_review_user()

◆ can_review()

◆ can_review_user()

◆ count_records()

◆ count_records_for_template()

◆ count_records_select()

◆ create()

◆ define_properties()

◆ delete()

◆ extract_record()

◆ from_record()

◆ get()

◆ get_by_user_and_competency()

◆ get_comment_object()

◆ get_competencies()

◆ get_competency()

◆ get_context()

◆ get_draft_statuses()

◆ get_errors()

◆ get_formatted_properties()

◆ get_property_default_value()

◆ get_property_error_message()

◆ get_record()

◆ get_records()

◆ get_records_for_template()

◆ get_records_select()

◆ get_recordset_for_due_and_incomplete()

◆ get_sql_fields()

◆ get_status_list()

◆ get_statusname()

◆ get_template()

◆ has_property()

◆ has_records_for_template()

◆ is_based_on_template()

◆ is_draft()

◆ is_property_required()

◆ is_valid()

◆ properties_definition()

◆ raw_get()

◆ raw_set()

◆ read()

◆ record_exists()

◆ record_exists_select()

◆ save()

◆ set()

◆ to_record()

◆ update()

◆ update_multiple_from_template()

◆ validate()

◆ validate_duedate()

◆ validate_templateid()

◆ validate_userid()