Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Class for loading/storing data purposes from the DB.

Copyright: 2018 David Monllao
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 191 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

purpose:: (7 methods):
  __construct()
  define_properties()
  after_create()
  after_update()
  before_delete()
  is_used()
  get_purpose_overrides()


Class: purpose  - X-Ref

Class for loading/storing data purposes from the DB.

__construct($id = 0, stdClass $record = null)   X-Ref
Extended constructor to fetch from the cache if available.

param: int $id If set, this is the id of an existing record, used to load the data.
param: stdClass $record If set will be passed to {@link self::from_record()}.

define_properties()   X-Ref
Return the definition of the properties of this model.

return: array

after_create()   X-Ref
Adds the new record to the cache.

return: null

after_update($result)   X-Ref
Updates the cache record.

param: bool $result
return: null

before_delete()   X-Ref
Removes unnecessary stuff from db.

return: null

is_used()   X-Ref
Is this purpose used?.

return: null

get_purpose_overrides()   X-Ref
Get a list of the role purpose overrides for this purpose.

return: array