Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/reportbuilder/classes/local/helpers/ -> user_profile_fields.php (source)

[Source view]

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

(no description)

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

Defines 1 class

user_profile_fields:: (10 methods):
  __construct()
  get_user_profile_fields()
  add_join()
  add_joins()
  get_joins()
  get_table_alias()
  get_table_join()
  get_columns()
  get_filters()
  get_user_field_type()


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.

param: string $join
return: self

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

param: array $joins
return: self

get_joins()   X-Ref
Return joins

return: string[]

get_table_alias(profile_field_base $profilefield)   X-Ref
Generate table alias for given profile field

The entity name is used to ensure the alias differs when the entity is used multiple times within the same report, each
having their own table alias/join

param: profile_field_base $profilefield
return: string

get_table_join(profile_field_base $profilefield)   X-Ref
Generate table join for given profile field

param: profile_field_base $profilefield
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.

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