mod_forum\event\discussion_pinned Class Reference

The mod_forum discussion pinned event. More...

Inheritance diagram for mod_forum\event\discussion_pinned:

Public Member Functions
	__get ($name)
	Magic getter for read only access. More...
	__isset ($name)
	Is data property set? More...
	__set ($name, $value)
	Magic setter. More...
	add_record_snapshot ($tablename, $record)
	Add cached data that will be most probably used in event observers. More...
	can_view ($user_or_id=null)
	This method was originally intended for granular access control on the event level, unfortunately the proper implementation would be too expensive in many cases. More...
	get_context ()
	Returns event context. More...
	get_data ()
	Return standardised event data as array. More...
	get_description ()
	Returns description of what happened. More...
	get_logextra ()
	Return auxiliary data that was stored in logs. More...
	get_record_snapshot ($tablename, $id)
	Returns cached record or fetches data from database if not cached. More...
	get_url ()
	Get URL related to the action. More...
	getIterator ()
	Create an iterator because magic vars can't be seen by 'foreach'. More...
	is_dispatched ()
	Used from event manager to prevent direct access. More...
	is_restored ()
	Was this event restored? More...
	is_triggered ()
	Was this event already triggered? More...
	trigger ()
	Trigger event.

Static Public Member Functions
static	create (array $data=null)
	Create new event. More...
static	get_explanation ()
	Get an explanation of what the class does. More...
static	get_legacy_eventname ()
	Does this event replace legacy event? More...
static	get_name ()
	Return localised event name. More...
static	get_name_with_info ()
	Returns the event name complete with metadata information. More...
static	get_objectid_mapping ()
	Forum discussion object id mappings. More...
static	get_other_mapping ()
	Forum id mappings. More...
static	get_static_info ()
	Get static information about an event. More...
static	is_deprecated ()
	Whether this event has been marked as deprecated. More...
static	restore (array $data, array $logextra)
	Restore event from existing historic data. More...
static	restore_legacy ($legacy)
	Create fake event from legacy log data. More...

Public Attributes
const	LEVEL_OTHER = 0
	Other level.
const	LEVEL_PARTICIPATING = 2
	Participating level. More...
const	LEVEL_TEACHING = 1
	Teaching level. More...
const	NOT_FOUND = -31338
	The value used when an id can not be found during a restore.
const	NOT_MAPPED = -31337
	The value used when an id can not be mapped during a restore.
const	USER_NOTLOGGEDIN = 0
	User id to use when the user is not logged in.
const	USER_OTHER = -1
	User id to use when actor is not an actual user but system, cli or cron.

Protected Member Functions
	get_legacy_eventdata ()
	Legacy event data if get_legacy_eventname() is not empty. More...
	get_legacy_logdata ()
	Return the legacy event log data. More...
	init ()
	Init method. More...
	validate_before_trigger ()
	Validate all properties right before triggering the event. More...
	validate_data ()
	Custom validation. More...

Static Protected Member Functions
static	restore_unknown (array $data, array $logextra)
	Restore unknown event. More...

Protected Attributes
context	$context
	of this event
array	$data
	event data
array	$logextra
	the format is standardised by logging API

Detailed Description

The mod_forum discussion pinned event.

Copyright

2014 Charles Fulton fulto.nosp@m.nc@l.nosp@m.afaye.nosp@m.tte..nosp@m.edu

License

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

Member Function Documentation

__get()

core\event\base::__get (   $name )

inherited

Magic getter for read only access.

Parameters

string

$name

Return values

mixed

__isset()

core\event\base::__isset (   $name )

inherited

Is data property set?

Parameters

string

$name

Return values

bool

__set()

core\event\base::__set (   $name,   $value  )

inherited

Magic setter.

Note: we must not allow modification of data from outside, after trigger() the data MUST NOT CHANGE!!!

Parameters

string	$name
mixed	$value

Exceptions

coding_exception

add_record_snapshot()

core\event\base::add_record_snapshot (   $tablename,   $record  )

finalinherited

Add cached data that will be most probably used in event observers.

This is used to improve performance, but it is required for data that was just deleted.

Parameters

string	$tablename
stdClass	$record

Exceptions

coding_exception

if used after ::trigger()

can_view()

core\event\base::can_view (   $user_or_id = null )

inherited

This method was originally intended for granular access control on the event level, unfortunately the proper implementation would be too expensive in many cases.

Deprecated:

since 2.7

Parameters

int | stdClass

$user_or_id

ID of the user.

Return values

bool	True if the user can view the event, false otherwise.

Reimplemented in mod_feedback\event\course_module_viewed, mod_feedback\event\response_deleted, and mod_feedback\event\response_submitted.

create()

static core\event\base::create ( array  $data = null )

staticfinalinherited

Create new event.

The optional data keys as: 1/ objectid - the id of the object specified in class name 2/ context - the context of this event 3/ other - the other data describing the event, can not contain objects 4/ relateduserid - the id of user which is somehow related to this event

Parameters

array

$data

Return values

core::event::base

returns instance of new event

Exceptions

coding_exception

get_context()

core\event\base::get_context ( )

inherited

Returns event context.

Return values

context

get_data()

core\event\base::get_data ( )

inherited

Return standardised event data as array.

Return values

array

All elements are scalars except the 'other' field which is array.

get_description()

mod_forum\event\discussion_pinned::get_description

(

)

Returns description of what happened.

Return values

string

Reimplemented from core\event\base.

get_explanation()

static core\event\base::get_explanation ( )

staticinherited

Get an explanation of what the class does.

By default returns the phpdocs from the child event class. Ideally this should be overridden to return a translatable get_string style markdown. e.g. return new lang_string('eventyourspecialevent', 'plugin_type');

Return values

string

An explanation of the event formatted in markdown style.

get_legacy_eventdata()

core\event\base::get_legacy_eventdata ( )

protectedinherited

Legacy event data if get_legacy_eventname() is not empty.

Note: do not use directly!

Return values

mixed

Reimplemented in core\event\blog_entry_created, core\event\blog_entry_deleted, core\event\blog_entry_updated, core\event\cohort_created, core\event\cohort_deleted, core\event\cohort_member_added, core\event\cohort_member_removed, core\event\cohort_updated, core\event\course_category_deleted, core\event\course_completed, core\event\course_content_deleted, core\event\course_created, core\event\course_deleted, core\event\course_module_completion_updated, core\event\course_module_created, core\event\course_module_deleted, core\event\course_module_updated, core\event\course_restored, core\event\course_updated, core\event\group_created, core\event\group_deleted, core\event\group_member_added, core\event\group_member_removed, core\event\group_updated, core\event\grouping_created, core\event\grouping_deleted, core\event\grouping_updated, core\event\role_assigned, core\event\role_unassigned, core\event\user_created, core\event\user_deleted, core\event\user_enrolment_created, core\event\user_enrolment_deleted, core\event\user_enrolment_updated, core\event\user_loggedout, core\event\user_updated, mod_assign\event\assessable_submitted, assignsubmission_file\event\assessable_uploaded, assignsubmission_onlinetext\event\assessable_uploaded, mod_forum\event\assessable_uploaded, mod_lti\event\unknown_service_api_called, mod_quiz\event\attempt_abandoned, mod_quiz\event\attempt_becameoverdue, mod_quiz\event\attempt_started, mod_quiz\event\attempt_submitted, mod_workshop\event\assessable_uploaded, and mod_workshop\event\course_module_viewed.

get_legacy_eventname()

static core\event\base::get_legacy_eventname ( )

staticinherited

Does this event replace legacy event?

Note: do not use directly!

Return values

null|string

legacy event name

Reimplemented in core_h5p\event\h5p_deleted, core_h5p\event\h5p_viewed, core\event\blog_entry_created, core\event\blog_entry_deleted, core\event\blog_entry_updated, core\event\cohort_created, core\event\cohort_deleted, core\event\cohort_member_added, core\event\cohort_member_removed, core\event\cohort_updated, core\event\course_category_deleted, core\event\course_completed, core\event\course_content_deleted, core\event\course_created, core\event\course_deleted, core\event\course_module_completion_updated, core\event\course_module_created, core\event\course_module_deleted, core\event\course_module_updated, core\event\course_restored, core\event\course_updated, core\event\group_created, core\event\group_deleted, core\event\group_member_added, core\event\group_member_removed, core\event\group_updated, core\event\grouping_created, core\event\grouping_deleted, core\event\grouping_updated, core\event\role_assigned, core\event\role_unassigned, core\event\user_created, core\event\user_deleted, core\event\user_enrolment_created, core\event\user_enrolment_deleted, core\event\user_enrolment_updated, core\event\user_loggedout, core\event\user_updated, mod_assign\event\assessable_submitted, assignsubmission_file\event\assessable_uploaded, assignsubmission_onlinetext\event\assessable_uploaded, mod_forum\event\assessable_uploaded, mod_lti\event\unknown_service_api_called, mod_quiz\event\attempt_abandoned, mod_quiz\event\attempt_becameoverdue, mod_quiz\event\attempt_started, mod_quiz\event\attempt_submitted, mod_workshop\event\assessable_uploaded, and mod_workshop\event\course_module_viewed.

get_legacy_logdata()

mod_forum\event\discussion_pinned::get_legacy_logdata ( )

protected

Return the legacy event log data.

Return values

array|null

Reimplemented from core\event\base.

get_logextra()

core\event\base::get_logextra ( )

inherited

Return auxiliary data that was stored in logs.

List of standard properties:

• origin: IP number, cli,cron
• realuserid: id of the user when logged-in-as

Return values

array

the format is standardised by logging API

get_name()

static mod_forum\event\discussion_pinned::get_name ( )

static

Return localised event name.

Return values

string

Reimplemented from core\event\base.

get_name_with_info()

static core\event\base::get_name_with_info ( )

staticinherited

Returns the event name complete with metadata information.

This includes information about whether the event has been deprecated so should not be used in all situations - for example within reports themselves.

If overriding this function, please ensure that you call the parent version too.

Return values

string

get_objectid_mapping()

static mod_forum\event\discussion_pinned::get_objectid_mapping ( )

static

Forum discussion object id mappings.

Return values

array

Reimplemented from core\event\base.

get_other_mapping()

static mod_forum\event\discussion_pinned::get_other_mapping ( )

static

Forum id mappings.

Return values

array

Reimplemented from core\event\base.

get_record_snapshot()

core\event\base::get_record_snapshot (   $tablename,   $id  )

finalinherited

Returns cached record or fetches data from database if not cached.

Parameters

string	$tablename
int	$id

Return values

stdClass

Exceptions

coding_exception

if used after ::restore()

get_static_info()

static core\event\base::get_static_info ( )

staticfinalinherited

Get static information about an event.

This is used in reports and is not for general use.

Return values

array

Static information about the event.

get_url()

mod_forum\event\discussion_pinned::get_url

(

)

Get URL related to the action.

Return values

moodle_url

Reimplemented from core\event\base.

getIterator()

core\event\base::getIterator ( )

inherited

Create an iterator because magic vars can't be seen by 'foreach'.

Return values

ArrayIterator

init()

mod_forum\event\discussion_pinned::init ( )

protected

Init method.

Return values

void

Reimplemented from core\event\base.

is_deprecated()

static core\event\base::is_deprecated ( )

staticinherited

Whether this event has been marked as deprecated.

Events cannot be deprecated in the normal fashion as they must remain to support historical data. Once they are deprecated, there is no way to trigger the event, so it does not make sense to list it in some parts of the UI (e.g. Event Monitor).

Return values

boolean

Reimplemented in core\event\content_viewed, core\event\course_module_instances_list_viewed, core\event\message_contact_blocked, core\event\message_contact_unblocked, core\event\mnet_access_control_updated, core\event\role_capabilities_updated, mod_choice\event\answer_submitted, and mod_choice\event\answer_updated.

is_dispatched()

core\event\base::is_dispatched ( )

finalinherited

Used from event manager to prevent direct access.

Return values

bool

is_restored()

core\event\base::is_restored ( )

finalinherited

Was this event restored?

Return values

bool

is_triggered()

core\event\base::is_triggered ( )

finalinherited

Was this event already triggered?

Return values

bool

restore()

static core\event\base::restore ( array  $data, array  $logextra  )

staticfinalinherited

Restore event from existing historic data.

Parameters

array	$data
array	$logextra	the format is standardised by logging API

Return values

bool|core::event::base

restore_legacy()

static core\event\base::restore_legacy (   $legacy )

staticfinalinherited

Create fake event from legacy log data.

Parameters

stdClass

$legacy

Return values

base

restore_unknown()

static core\event\base::restore_unknown ( array  $data, array  $logextra  )

staticfinalprotectedinherited

Restore unknown event.

Parameters

array	$data
array	$logextra

Return values

unknown_logged

validate_before_trigger()

core\event\base::validate_before_trigger ( )

finalprotectedinherited

Validate all properties right before triggering the event.

This throws coding exceptions for fatal problems and debugging for minor problems.

Exceptions

coding_exception

validate_data()

mod_forum\event\discussion_pinned::validate_data ( )

protected

Custom validation.

Exceptions

coding_exception

Return values

void

Reimplemented from core\event\base.

Member Data Documentation

LEVEL_PARTICIPATING

const core\event\base::LEVEL_PARTICIPATING = 2

inherited

Participating level.

Any event that is performed by a user, and is related (or could be related) to his learning experience.

LEVEL_TEACHING

const core\event\base::LEVEL_TEACHING = 1

inherited

Teaching level.

Any event that is performed by someone (typically a teacher) and has a teaching value, anything that is affecting the learning experience/environment of the students.

---

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

• mod/forum/classes/event/discussion_pinned.php