Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
tool_dataprivacy\contextlevel Class Reference

Class for loading/storing context level data from the DB. More...

Inheritance diagram for tool_dataprivacy\contextlevel:
core\persistent

Public Member Functions

 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_errors ()
 Returns the validation errors. 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 count_records (array $conditions=array())
 Count a list of records. 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_formatted_properties ()
 Gets all the formatted properties. More...
 
static get_record ($filters=array())
 Load a single record. More...
 
static get_record_by_contextlevel ($contextlevel, $exception=true)
 Returns an instance by contextlevel. More...
 
static get_records ($filters=array(), $sort='', $order='ASC', $skip=0, $limit=0)
 Load a list of records. 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_sql_fields ($alias, $prefix=null)
 Return the list of fields for use in a SELECT clause. More...
 
static has_property ($property)
 Returns whether or not a property was defined. More...
 
static is_category_used ($categoryid)
 Is the provided category used by any contextlevel? More...
 
static is_property_required ($property)
 Returns whether or not a property is required. More...
 
static is_purpose_used ($purposeid)
 Is the provided purpose used by any contextlevel? 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...
 

Public Attributes

const TABLE = 'tool_dataprivacy_ctxlevel'
 Database table.
 

Protected Member Functions

 after_create ()
 Adds the new record to the cache. More...
 
 after_delete ($result)
 Hook to execute after a delete. More...
 
 after_update ($result)
 Updates the cache record. More...
 
 before_create ()
 Hook to execute before a create. More...
 
 before_delete ()
 Removes unnecessary stuff from db. More...
 
 before_update ()
 Hook to execute before an update. More...
 
 before_validate ()
 Hook to execute before the validation. More...
 
 raw_get ($property)
 Internal Data getter. More...
 
 raw_set ($property, $value)
 Data setter. 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...
 

Detailed Description

Class for loading/storing context level data from the DB.

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

Member Function Documentation

◆ after_create()

tool_dataprivacy\contextlevel::after_create ( )
protected

Adds the new record to the cache.

Return values
null

Reimplemented from core\persistent.

◆ 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$resultWhether 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()

tool_dataprivacy\contextlevel::after_update (   $result)
protected

Updates the cache record.

Parameters
bool$result
Return values
null

Reimplemented from core\persistent.

◆ 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()

tool_dataprivacy\contextlevel::before_delete ( )
protected

Removes unnecessary stuff from db.

Return values
null

Reimplemented from core\persistent.

◆ 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\persistent::before_validate ( )
protectedinherited

Hook to execute before the validation.

This hook will not affect the validation results in any way but is useful to internally set properties which will need to be validated.

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

Return values
void

Reimplemented in core\oauth2\issuer, core_competency\template_competency, core_competency\template, core_competency\plan_competency, core_competency\plan, core_competency\course_module_competency, core_competency\course_competency, core_competency\competency_framework, and core_competency\competency.

◆ count_records()

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

Count a list of records.

Parameters
array$conditionsAn array of conditions.
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 tool_dataprivacy\contextlevel::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
boolTrue 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$rowThe row of data.
string$prefixThe prefix the data fields are prefixed with, defaults to the table name followed by underscore.
Return values
stdClassThe 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$recordA 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$propertyThe property name.
Return values
mixed

◆ 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
arrayKeys 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$propertyThe 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$propertyThe property name.
Return values
lang_string

◆ get_record()

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

Load a single record.

Parameters
array$filtersFilters to apply.
Return values
false|static

◆ get_record_by_contextlevel()

static tool_dataprivacy\contextlevel::get_record_by_contextlevel (   $contextlevel,
  $exception = true 
)
static

Returns an instance by contextlevel.

Parameters
mixed$contextlevel
mixed$exception
Return values
null

◆ get_records()

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

Load a list of records.

Parameters
array$filtersFilters to apply.
string$sortField to sort by.
string$orderSort order.
int$skipLimitstart.
int$limitNumber of rows to return.
Return values
static[]

◆ 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_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$aliasThe alias used for the table.
string$prefixThe prefix to use for each field, defaults to the table name followed by underscore.
Return values
stringThe SQL fragment.

◆ has_property()

static core\persistent::has_property (   $property)
staticfinalinherited

Returns whether or not a property was defined.

Parameters
string$propertyThe property name.
Return values
boolean

◆ is_category_used()

static tool_dataprivacy\contextlevel::is_category_used (   $categoryid)
static

Is the provided category used by any contextlevel?

Parameters
int$categoryid
Return values
bool

◆ 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$propertyThe property name.
Return values
boolean

◆ is_purpose_used()

static tool_dataprivacy\contextlevel::is_purpose_used (   $purposeid)
static

Is the provided purpose used by any contextlevel?

Parameters
int$purposeid
Return values
bool

◆ is_valid()

core\persistent::is_valid ( )
finalinherited

Returns whether or not the model is valid.

Return values
booleanTrue 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$propertyThe 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$propertyThe property name.
mixed$valueThe 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$idRecord 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$propertyThe 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
boolTrue on success.

◆ 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|trueReturns true when the validation passed, or an array of properties with errors.

◆ 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: