[ Index ]

PHP Cross Reference of phpBB-3.2.0-deutsch

title

Body

[close]

/phpbb/ -> permissions.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 363 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

permissions:: (10 methods):
  __construct()
  get_categories()
  get_category_lang()
  get_types()
  get_type_lang()
  get_permissions()
  get_permission_category()
  category_defined()
  permission_defined()
  get_permission_lang()


Class: permissions  - X-Ref

__construct(\phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\user $user)   X-Ref
Constructor

param: \phpbb\event\dispatcher_interface    $phpbb_dispatcher    Event dispatcher
param: \phpbb\user                $user                User Object

get_categories()   X-Ref
Returns an array with all the permission categories (pm, post, settings, misc, etc.)

return: array    Layout: cat-identifier => Language key

get_category_lang($category)   X-Ref
Returns the language string of a permission category

return: string        Language string
param: string    $category    Identifier of the category

get_types()   X-Ref
Returns an array with all the permission types (a_, u_, m_, etc.)

return: array    Layout: type-identifier => Language key

get_type_lang($type, $scope = false)   X-Ref
Returns the language string of a permission type

return: string    Language string
param: string    $type    Identifier of the type
param: mixed    $scope    Scope of the type (should be 'global', 'local' or false)

get_permissions()   X-Ref
Returns an array with all the permissions.
Each Permission has the following layout:
'<type><permission>' => array(
'lang'    => 'Language Key with a Short description', // Optional, if not set,
// the permissions identifier '<type><permission>' is used with
// all uppercase.
'cat'    => 'Identifier of the category, the permission should be displayed in',
),
Example:
'u_viewprofile' => array(
'lang'    => 'ACL_U_VIEWPROFILE',
'cat'    => 'profile',
),

return: array

get_permission_category($permission)   X-Ref
Returns the category of a permission

return: string        Returns the category identifier of the permission
param: string    $permission    Identifier of the permission

category_defined($category)   X-Ref
Checks if a category has been defined

return: bool    True if the category is defined, false otherwise
param: string    $category    Identifier of the category

permission_defined($permission)   X-Ref
Checks if a permission has been defined

return: bool    True if the permission is defined, false otherwise
param: string    $permission    Identifier of the permission

get_permission_lang($permission)   X-Ref
Returns the language string of a permission

return: string    Language string
param: string    $permission    Identifier of the permission



Generated: Sun Feb 19 19:47:08 2017 Cross-referenced by PHPXref 0.7.1