Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/reportbuilder/classes/local/helpers/ -> user_profile_fields.php (source)

[Source view]

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

(no description)

File Size: 268 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

user_profile_fields:: (9 methods):
  __construct()
  get_user_profile_fields()
  add_join()
  add_joins()
  get_joins()
  get_columns()
  get_filters()
  get_user_field_type()
  format_profile_field()


Class: user_profile_fields  - X-Ref

Helper class for user profile fields.

__construct(string $usertablefieldalias, string $entityname)   X-Ref
Class userprofilefields constructor.

param: string $usertablefieldalias The user table/field alias used when adding columns and filters.
param: string $entityname The entity name used when adding columns and filters.

get_user_profile_fields()   X-Ref
Retrieves the list of available/visible user profile fields

return: profile_field_base[]

add_join(string $join)   X-Ref
Additional join that is needed.

return: self
param: string $join

add_joins(array $joins)   X-Ref
Additional joins that are needed.

return: self
param: array $joins

get_joins()   X-Ref
Return joins

return: string[]

get_columns()   X-Ref
Return the user profile fields visible columns.

return: column[]

get_filters()   X-Ref
Get custom user profile fields filters.

return: filter[]

get_user_field_type(string $userfield)   X-Ref
Get user profile field type for report.

return: int the constant equivalent to this custom field type.
param: string $userfield user field.

format_profile_field($value, stdClass $row, profile_field_base $field)   X-Ref
Formatter for a profile field. It formats the field according to its type.

return: string
param: mixed $value
param: stdClass $row
param: profile_field_base $field