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.
/lib/classes/message/inbound/ -> manager.php (source)

[Source view]

Variable Envelope Return Path management.

Copyright: 2014 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 258 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

manager:: (9 methods):
  is_enabled()
  update_handlers_for_component()
  load_default_handlers_for_component()
  create_missing_messageinbound_handlers_for_component()
  remove_messageinbound_handler()
  record_from_handler()
  handler_from_record()
  get_handler()
  get_handler_from_id()


Class: manager  - X-Ref

Variable Envelope Return Path manager class.

is_enabled()   X-Ref
Whether the Inbound Message interface is enabled.

return: bool

update_handlers_for_component($componentname)   X-Ref
Update the database to create, update, and remove handlers.

param: string $componentname - The frankenstyle component name.

load_default_handlers_for_component($componentname)   X-Ref
Load handler instances for all of the handlers defined in db/messageinbound_handlers.php for the specified component.

param: string $componentname - The name of the component to fetch the handlers for.
return: \core\message\inbound\handler[] - List of handlers for this component.

create_missing_messageinbound_handlers_for_component($componentname)   X-Ref
Update the database to contain a list of handlers for a component,
adding any handlers which do not exist in the database.

param: string $componentname - The frankenstyle component name.

remove_messageinbound_handler($handler)   X-Ref
Remove the specified handler.

param: \core\message\inbound\handler $handler The handler to remove

record_from_handler($handler)   X-Ref
Create a flat stdClass for the handler, appropriate for inserting
into the database.

param: \core\message\inbound\handler $handler The handler to retrieve the record for.
return: \stdClass

handler_from_record($record)   X-Ref
Load the Inbound Message handler details for a given record.

param: \stdClass $record The record to retrieve the handler for.
return: \core\message\inbound\handler or false

get_handler($classname)   X-Ref
Load the Inbound Message handler details for a given classname.

param: string $classname The name of the class for the handler.
return: \core\message\inbound\handler or false

get_handler_from_id($id)   X-Ref
Load the Inbound Message handler with a given ID

param: int $id
return: \core\message\inbound\handler or false