tce_functions_user_select.php

Functions to display and select registered user.

- Nicola Asuni

Table of contents

Source: admin/code/tce_functions_user_select.php

Functions to display and select registered user.

Functions

F_get_user_groups()

Returns an array containing groups IDs to which the specified user belongs

function F_get_user_groups(mixed $user_id): array

Parameters:

  • $user_id (mixed): (int) user ID

Returns: array: containing user’s groups IDs

Source: admin/code/tce_functions_user_select.php:990

F_getUIDfromRegnum()

Return the user ID from registration number.

function F_getUIDfromRegnum(mixed $regnum): int

Parameters:

  • $regnum (mixed)

Returns: int: User ID or 0 in case of error.

Source: admin/code/tce_functions_user_select.php:1015

F_isAuthorizedEditorForGroup()

Return true if the current user is an administrator or belongs to the group, false otherwise

function F_isAuthorizedEditorForGroup(mixed $group_id): bool

Parameters:

  • $group_id (mixed): (int) group ID

Returns: bool: true/false

Source: admin/code/tce_functions_user_select.php:867

F_isAuthorizedEditorForUser()

Return true if the current user is authorized to edit the specified user

function F_isAuthorizedEditorForUser(mixed $user_id): bool

Parameters:

  • $user_id (mixed): (int) user ID

Returns: bool: true/false

Source: admin/code/tce_functions_user_select.php:885

F_isTestOnGroup()

Return true if the selected test is active for the selected group

function F_isTestOnGroup(mixed $test_id, mixed $group_id): bool

Parameters:

  • $test_id (mixed): (int) test ID
  • $group_id (mixed): (int) group ID

Returns: bool: true/false

Source: admin/code/tce_functions_user_select.php:824

F_isUserOnGroup()

Return true if the selected user belongs to the selected group

function F_isUserOnGroup(mixed $user_id, mixed $group_id): bool

Parameters:

  • $user_id (mixed): (int) user ID
  • $group_id (mixed): (int) group ID

Returns: bool: true/false

Source: admin/code/tce_functions_user_select.php:846

F_select_user()

Display user selection for using F_show_select_user function.

function F_select_user(
    mixed $order_field,
    mixed $orderdir,
    mixed $firstrow,
    mixed $rowsperpage,
    mixed $group_id = 0,
    mixed $andwhere = '',
    mixed $searchterms = ''
): true

Parameters:

  • $order_field (mixed): (string) order by column name
  • $orderdir (mixed): (string) oreder direction
  • $firstrow (mixed): (string) number of first row to display
  • $rowsperpage (mixed): (string) number of rows per page
  • $group_id (mixed): (int) id of the group (default = 0 = no specific group selected)
  • $andwhere (mixed): (string) additional SQL WHERE query conditions
  • $searchterms (mixed): (string) search terms

Returns: true

Source: admin/code/tce_functions_user_select.php:36

F_show_select_user()

Display user selection XHTML table.

function F_show_select_user(
    mixed $order_field,
    mixed $orderdir,
    mixed $firstrow,
    mixed $rowsperpage,
    mixed $group_id = 0,
    mixed $andwhere = '',
    mixed $searchterms = ''
): false

Parameters:

  • $order_field (mixed): (string) Order by column name.
  • $orderdir (mixed): (int) Order direction.
  • $firstrow (mixed): (int) Number of first row to display.
  • $rowsperpage (mixed): (int) Number of rows per page.
  • $group_id (mixed): (int) ID of the group (default = 0 = no specific group selected).
  • $andwhere (mixed): (string) Additional SQL WHERE query conditions.
  • $searchterms (mixed): (string) Search terms.

Returns: false: in case of empty database, true otherwise

Source: admin/code/tce_functions_user_select.php:64

F_show_select_user_popup()

Display user selection XHTML table (popup mode).

function F_show_select_user_popup(
    mixed $order_field,
    mixed $orderdir,
    mixed $firstrow,
    mixed $rowsperpage,
    mixed $group_id = 0,
    mixed $andwhere = '',
    mixed $searchterms = '',
    string $cid = 0
): false

Parameters:

  • $order_field (mixed): (string) Order by column name.
  • $orderdir (mixed): (int) Order direction.
  • $firstrow (mixed): (int) Number of first row to display.
  • $rowsperpage (mixed): (int) Number of rows per page.
  • $group_id (mixed): (int) ID of the group (default = 0 = no specific group selected).
  • $andwhere (mixed): (string) Additional SQL WHERE query conditions.
  • $searchterms (mixed): (string) Search terms.
  • $cid (string): ID of the calling form field.

Returns: false: in case of empty database, true otherwise

Source: admin/code/tce_functions_user_select.php:489

F_user_group_select()

Display select box for user groups

function F_user_group_select(mixed $name = 'group_id'): table

Parameters:

  • $name (mixed): (string) name of the select field

Returns: table: header element string

Source: admin/code/tce_functions_user_select.php:950

F_user_group_select_sql()

Return the SQL selection query for user groups

function F_user_group_select_sql(mixed $where = ''): sql

Parameters:

  • $where (mixed): (string) filters to add on WHERE clause

Returns: sql: selection string

Source: admin/code/tce_functions_user_select.php:923