Discussion list vault. More...

Inheritance diagram for mod_forum\local\vaults\discussion_list:

Public Member Functions
	get_from_forum_id (int $forumid, bool $includehiddendiscussions, ?int $includepostsforuser, ?int $sortorder, int $limit, int $offset)
	Get each discussion, first post, first and last post author for the given forum, considering timed posts, and pagination.

	get_from_forum_id_and_group_id (int $forumid, array $groupids, bool $includehiddendiscussions, ?int $includepostsforuser, ?int $sortorder, int $limit, int $offset)
	Get each discussion, first post, first and last post author for the given forum, and the set of groups to display considering timed posts, and pagination.

	get_from_id (int $id)
	Get the entity for the given id.

	get_from_ids (array $ids)
	Get the list of entities for the given ids.

	get_total_discussion_count_from_forum_id (int $forumid, bool $includehiddendiscussions, ?int $includepostsforuser)
	Count the number of discussions in the forum.

	get_total_discussion_count_from_forum_id_and_group_id (int $forumid, array $groupids, bool $includehiddendiscussions, ?int $includepostsforuser)
	Count the number of discussions in all groups and the list of groups provided.

Public Attributes
const	PAGESIZE_DEFAULT = 100
	Default limit.

const	SORTORDER_CREATED_ASC = 4
	Sort by created asc.

const	SORTORDER_CREATED_DESC = 3
	Sort by created desc.

const	SORTORDER_DISCUSSION_ASC = 8
	Sort by discussion name asc.

const	SORTORDER_DISCUSSION_DESC = 7
	Sort by discussion name desc.

const	SORTORDER_GROUP_ASC = 12
	Sort by group name asc.

const	SORTORDER_GROUP_DESC = 11
	Sort by group name desc.

const	SORTORDER_LASTPOST_ASC = 2
	Sort by oldest first.

const	SORTORDER_LASTPOST_DESC = 1
	Sort by newest first.

const	SORTORDER_REPLIES_ASC = 6
	Sort by number of replies desc.

const	SORTORDER_REPLIES_DESC = 5
	Sort by number of replies desc.

const	SORTORDER_STARTER_ASC = 10
	Sort by discussion starter's name asc.

const	SORTORDER_STARTER_DESC = 9
	Sort by discussion starter's name desc.

Protected Member Functions
	from_db_records (array $results)
	Convert the DB records into discussion list entities.

	generate_count_records_sql (string $wheresql=null)
	Build the SQL to be used in count_records_sql.

	generate_get_records_sql (string $wheresql=null, string $sortsql=null, ?int $userid=null)
	Build the SQL to be used in get_records_sql.

	generate_get_records_sql (string $wheresql=null, ?string $sortsql=null, ?int $userid=null)
	Build the SQL to be used in get_records_sql.

	get_db ()
	Get the moodle database.

	get_entity_factory ()
	Get the entity factory.

	get_favourite_alias ()
	Get the favourite table alias.

	get_hidden_post_sql (bool $includehiddendiscussions, ?int $includepostsforuser)
	Fetch any required SQL to respect timed posts.

	get_keyfield (?int $sortmethod)
	Get the field to sort by.

	get_legacy_factory ()
	Get the legacy factory.

	get_preprocessors ()
	Get a list of preprocessors to execute on the DB results before being converted into entities.

	get_sort_direction (?int $sortmethod)
	Get the sort direction.

	get_table_alias ()
	Get the table alias.

	transform_db_records_to_entities (array $records)
	Execute the defined preprocessors on the DB record results and then convert them into entities.

Detailed Description

Discussion list vault.

This should be the only place that accessed the database.

This uses the repository pattern. See: https://designpatternsphp.readthedocs.io/en/latest/More/Repository/README.html

Copyright: 2019 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

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

Member Function Documentation

◆ from_db_records()

mod_forum\local\vaults\discussion_list::from_db_records ( array $results )

protected

Convert the DB records into discussion list entities.

Parameters

array $results The DB records

Return values

discussion_list[]

Reimplemented from mod_forum\local\vaults\db_table_vault.

◆ generate_count_records_sql()

mod_forum\local\vaults\discussion_list::generate_count_records_sql ( string $wheresql = null )

protected

Build the SQL to be used in count_records_sql.

Parameters

string | null $wheresql Where conditions for the SQL

Return values

string

◆ generate_get_records_sql() [1/2]

mod_forum\local\vaults\db_table_vault::generate_get_records_sql	(	string	$wheresql = null,
		string	$sortsql = null,
		?int	$userid = null )

abstractprotectedinherited

Build the SQL to be used in get_records_sql.

Parameters

string \| null	$wheresql	Where conditions for the SQL
string \| null	$sortsql	Order by conditions for the SQL
object \| null	$user	The user object

Return values

string

Reimplemented in mod_forum\local\vaults\author, mod_forum\local\vaults\discussion, mod_forum\local\vaults\forum, mod_forum\local\vaults\post, and mod_forum\local\vaults\post_read_receipt_collection.

◆ generate_get_records_sql() [2/2]

mod_forum\local\vaults\discussion_list::generate_get_records_sql	(	string	$wheresql = null,
		?string	$sortsql = null,
		?int	$userid = null )

protected

Build the SQL to be used in get_records_sql.

Parameters

string \| null	$wheresql	Where conditions for the SQL
string \| null	$sortsql	Order by conditions for the SQL
int \| null	$userid	The ID of the user we are performing this query for

Return values

string

◆ get_db()

mod_forum\local\vaults\db_table_vault::get_db ( )

protectedinherited

Get the moodle database.

Return values

moodle_database

◆ get_entity_factory()

mod_forum\local\vaults\db_table_vault::get_entity_factory ( )

protectedinherited

Get the entity factory.

Return values

entity_factory

◆ get_favourite_alias()

mod_forum\local\vaults\discussion_list::get_favourite_alias ( )

protected

Get the favourite table alias.

Return values

string

◆ get_from_forum_id()

mod_forum\local\vaults\discussion_list::get_from_forum_id	(	int	$forumid,
		bool	$includehiddendiscussions,
		?int	$includepostsforuser,
		?int	$sortorder,
		int	$limit,
		int	$offset )

Get each discussion, first post, first and last post author for the given forum, considering timed posts, and pagination.

Parameters

int	$forumid	The forum to fetch the discussion set for
bool	$includehiddendiscussions	Whether to include hidden discussions or not
int \| null	$includepostsforuser	Which user to include posts for, if any
int	$sortorder	The sort order to use
int	$limit	The number of discussions to fetch
int	$offset	The record offset

Return values

array The set of data fetched

◆ get_from_forum_id_and_group_id()

mod_forum\local\vaults\discussion_list::get_from_forum_id_and_group_id	(	int	$forumid,
		array	$groupids,
		bool	$includehiddendiscussions,
		?int	$includepostsforuser,
		?int	$sortorder,
		int	$limit,
		int	$offset )

Get each discussion, first post, first and last post author for the given forum, and the set of groups to display considering timed posts, and pagination.

Parameters

int	$forumid	The forum to fetch the discussion set for
int[]	$groupids	The list of real groups to filter on
bool	$includehiddendiscussions	Whether to include hidden discussions or not
int \| null	$includepostsforuser	Which user to include posts for, if any
int	$sortorder	The sort order to use
int	$limit	The number of discussions to fetch
int	$offset	The record offset

Return values

array The set of data fetched

◆ get_from_id()

mod_forum\local\vaults\db_table_vault::get_from_id ( int $id )

inherited

Get the entity for the given id.

Parameters

int $id Identifier for the entity

Return values

object|null

◆ get_from_ids()

mod_forum\local\vaults\db_table_vault::get_from_ids ( array $ids )

inherited

Get the list of entities for the given ids.

Parameters

int[] $ids Identifiers

Return values

array

◆ get_hidden_post_sql()

mod_forum\local\vaults\discussion_list::get_hidden_post_sql	(	bool	$includehiddendiscussions,
		?int	$includepostsforuser )

protected

Fetch any required SQL to respect timed posts.

Parameters

bool	$includehiddendiscussions	Whether to include hidden discussions or not
int \| null	$includepostsforuser	Which user to include posts for, if any

Return values

array The SQL and parameters to include

◆ get_keyfield()

mod_forum\local\vaults\discussion_list::get_keyfield ( ?int $sortmethod )

protected

Get the field to sort by.

Parameters

int | null $sortmethod

Return values

string

◆ get_legacy_factory()

mod_forum\local\vaults\db_table_vault::get_legacy_factory ( )

protectedinherited

Get the legacy factory.

Return values

object

◆ get_preprocessors()

mod_forum\local\vaults\discussion_list::get_preprocessors ( )

protected

Get a list of preprocessors to execute on the DB results before being converted into entities.

Return values

array

Reimplemented from mod_forum\local\vaults\db_table_vault.

◆ get_sort_direction()

mod_forum\local\vaults\discussion_list::get_sort_direction ( ?int $sortmethod )

protected

Get the sort direction.

Parameters

int | null $sortmethod

Return values

string

◆ get_table_alias()

mod_forum\local\vaults\discussion_list::get_table_alias ( )

protected

Get the table alias.

Return values

string

Reimplemented from mod_forum\local\vaults\db_table_vault.

◆ get_total_discussion_count_from_forum_id()

mod_forum\local\vaults\discussion_list::get_total_discussion_count_from_forum_id	(	int	$forumid,
		bool	$includehiddendiscussions,
		?int	$includepostsforuser )

Count the number of discussions in the forum.

Parameters

int	$forumid	Id of the forum to count discussions in
bool	$includehiddendiscussions	Include hidden dicussions in the count?
int \| null	$includepostsforuser	Include discussions created by this user in the count (only works if not including hidden discussions).

Return values

int

◆ get_total_discussion_count_from_forum_id_and_group_id()

mod_forum\local\vaults\discussion_list::get_total_discussion_count_from_forum_id_and_group_id	(	int	$forumid,
		array	$groupids,
		bool	$includehiddendiscussions,
		?int	$includepostsforuser )

Count the number of discussions in all groups and the list of groups provided.

Parameters

int	$forumid	Id of the forum to count discussions in
int[]	$groupids	List of group ids to include in the count (discussions in all groups will always be counted)
bool	$includehiddendiscussions	Include hidden dicussions in the count?
int \| null	$includepostsforuser	Include discussions created by this user in the count (only works if not including hidden discussions).

Return values

int

◆ transform_db_records_to_entities()

mod_forum\local\vaults\db_table_vault::transform_db_records_to_entities ( array $records )

protectedinherited

Execute the defined preprocessors on the DB record results and then convert them into entities.

Parameters

stdClass[] $records List of DB results

Return values

array

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

mod/forum/classes/local/vaults/discussion_list.php

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ from_db_records()

◆ generate_count_records_sql()

◆ generate_get_records_sql() [1/2]

◆ generate_get_records_sql() [2/2]

◆ get_db()

◆ get_entity_factory()

◆ get_favourite_alias()

◆ get_from_forum_id()

◆ get_from_forum_id_and_group_id()

◆ get_from_id()

◆ get_from_ids()

◆ get_hidden_post_sql()

◆ get_keyfield()

◆ get_legacy_factory()

◆ get_preprocessors()

◆ get_sort_direction()

◆ get_table_alias()

◆ get_total_discussion_count_from_forum_id()

◆ get_total_discussion_count_from_forum_id_and_group_id()

◆ transform_db_records_to_entities()