Function __global->get_permissions_matrix
Definitions
sources/permissions2.php
- Create a form field input matrix for permission setting.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $server_id | ID_TEXT | No | No | required parameter | N/A | N/A | Permission ID (page_link style) for the resource being set |
| $access | array | No | No | required parameter | N/A | N/A | An inverted list showing what view permissions are set for what we're setting permissions for |
| $overridables | array | No | No | required parameter | N/A | N/A | List of overridable privilege codes for what we're setting permissions for |
| $privileges | array | No | No | required parameter | N/A | N/A | List of privilege settings relating to what we're setting permissions for, from the database |
| $default_access | array | No | No | required parameter | N/A | N/A | Multi-dimensional array showing what the inherited defaults for this permission would be |
| $include_outer | boolean | No | No | True | N/A | N/A | Whether to include the stuff to make it fit alongside other form fields in a normal form table |
| $pinterface_view | ?Tempcode | No | No | Null | N/A | N/A | Label for view permissions (null: default) |
Returns
- The form field matrix
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Create a form field input matrix for permission setting.
*
* @param ID_TEXT $server_id Permission ID (page_link style) for the resource being set
* @param array $access An inverted list showing what view permissions are set for what we're setting permissions for
* @param array $overridables List of overridable privilege codes for what we're setting permissions for
* @param array $privileges List of privilege settings relating to what we're setting permissions for, from the database
* @param array $default_access Multi-dimensional array showing what the inherited defaults for this permission would be
* @param boolean $include_outer Whether to include the stuff to make it fit alongside other form fields in a normal form table
* @param ?Tempcode $pinterface_view Label for view permissions (null: default)
* @return Tempcode The form field matrix
*/
function get_permissions_matrix(string $server_id, array $access, array $overridables, array $privileges, array $default_access, bool $include_outer = true, ?object $pinterface_view = null) : object
* Create a form field input matrix for permission setting.
*
* @param ID_TEXT $server_id Permission ID (page_link style) for the resource being set
* @param array $access An inverted list showing what view permissions are set for what we're setting permissions for
* @param array $overridables List of overridable privilege codes for what we're setting permissions for
* @param array $privileges List of privilege settings relating to what we're setting permissions for, from the database
* @param array $default_access Multi-dimensional array showing what the inherited defaults for this permission would be
* @param boolean $include_outer Whether to include the stuff to make it fit alongside other form fields in a normal form table
* @param ?Tempcode $pinterface_view Label for view permissions (null: default)
* @return Tempcode The form field matrix
*/
function get_permissions_matrix(string $server_id, array $access, array $overridables, array $privileges, array $default_access, bool $include_outer = true, ?object $pinterface_view = null) : object
