Function Resource_fs_base->get_resource_privileges__members

Definitions

sources/resource_fs_base_class.php

  • Get the resource privileges for all members that have custom privileges on the resource.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$filename ?ID_TEXT No No required parameter N/A N/A Resource filename (assumed to be of a folder type) (null: $resource_type & $category specified instead)
$resource_type ?ID_TEXT No No Null N/A N/A The resource type (null: $filename specified instead)
$category ?ID_TEXT No No Null N/A N/A The resource ID (null: $filename specified instead)

Returns

  • A map between member ID, and a map of privilege to setting
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the resource privileges for all members that have custom privileges on the resource.
 *
 * @param  ?ID_TEXT $filename Resource filename (assumed to be of a folder type) (null: $resource_type & $category specified instead)
 * @param  ?ID_TEXT $resource_type The resource type (null: $filename specified instead)
 * @param  ?ID_TEXT $category The resource ID (null: $filename specified instead)
 * @return array A map between member ID, and a map of privilege to setting
 */
public function get_resource_privileges__members(?string $filename, ?string $resource_type = null, ?string $category = null) : array