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/event/ -> blog_entry_created.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

Event for when a new blog entry is added..

Copyright: 2013 Ankit Agarwal
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 148 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

blog_entry_created:: (11 methods):
  init()
  set_blog_entry()
  get_blog_entry()
  get_name()
  get_description()
  get_url()
  get_legacy_eventname()
  get_legacy_eventdata()
  get_legacy_logdata()
  validate_data()
  get_objectid_mapping()


Class: blog_entry_created  - X-Ref

Class blog_entry_created

Class for event to be triggered when a blog entry is created.

init()   X-Ref
Set basic properties for the event.


set_blog_entry(\blog_entry $blogentry)   X-Ref
Set blog_entry object to be used by observers.

param: \blog_entry $blogentry A reference to the active blog_entry object.

get_blog_entry()   X-Ref
Returns created blog_entry object for event observers.

return: \blog_entry

get_name()   X-Ref
Returns localised general event name.

return: string

get_description()   X-Ref
Returns non-localised event description with id's for admin use only.

return: string

get_url()   X-Ref
Returns relevant URL.

return: \moodle_url

get_legacy_eventname()   X-Ref
Does this event replace legacy event?

return: string legacy event name

get_legacy_eventdata()   X-Ref
Legacy event data if get_legacy_eventname() is not empty.

return: \blog_entry

get_legacy_logdata()   X-Ref
Replace add_to_log() statement.

return: array of parameters to be passed to legacy add_to_log() function.

validate_data()   X-Ref
Custom validations.

return: void

get_objectid_mapping()   X-Ref
No description