Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/forum/classes/local/vaults/ -> post_read_receipt_collection.php (source)

[Source view]

Post read receipt collection class.

Copyright: 2018 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 121 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

post_read_receipt_collection:: (5 methods):
  get_table_alias()
  generate_get_records_sql()
  from_db_records()
  get_from_user_id_and_post_ids()
  get_from_user_and_posts()


Class: post_read_receipt_collection  - X-Ref

Post read receipt collection class.

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

get_table_alias()   X-Ref
Get the table alias.

return: string

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

param: string|null $wheresql Where conditions for the SQL
param: string|null $sortsql Order by conditions for the SQL
param: int|null $userid The user ID
return: string

from_db_records(array $results)   X-Ref
Convert the DB records into post_read_receipt_collection entities.

param: array $results The DB records
return: post_read_receipt_collection

get_from_user_id_and_post_ids(int $userid, array $postids)   X-Ref
Load the post_read_receipt_collection for the given user and set
of posts.

param: int $userid Id of the user to load receipts for
param: int[] $postids List of post ids to load receipts for
return: post_read_receipt_collection

get_from_user_and_posts(stdClass $user, array $posts)   X-Ref
Load the post_read_receipt_collection for the given user and set
of posts.

param: stdClass $user The user to load receipts for
param: post_entity[] $posts List of posts to load receipts for
return: post_read_receipt_collection