Function Hook_import_smf2->get_role_value

Definitions

sources/hooks/modules/admin_import/smf2.php

  • Gets the role value for permissions of group.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$gid integer No No required parameter N/A N/A Group ID to use
$pid integer No No required parameter N/A N/A Profile ID to use
$db object No No required parameter N/A N/A The database connector to import from
$table_prefix string No No required parameter N/A N/A The table prefix the target prefix is using

Returns

  • The role value
  • Type: integer
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Gets the role value for permissions of group.
 *
 * @param  integer $gid Group ID to use
 * @param  integer $pid Profile ID to use
 * @param  object $db The database connector to import from
 * @param  string $table_prefix The table prefix the target prefix is using
 * @return integer The role value
 */

public function get_role_value(int $gid, int $pid, object $db, string $table_prefix) : int