MediaWiki  master
MWGrants.php
Go to the documentation of this file.
1 <?php
21 
25 class MWGrants {
26 
31  public static function getValidGrants() {
32  global $wgGrantPermissions;
33 
34  return array_keys( $wgGrantPermissions );
35  }
36 
41  public static function getRightsByGrant() {
42  global $wgGrantPermissions;
43 
44  $res = [];
45  foreach ( $wgGrantPermissions as $grant => $rights ) {
46  $res[$grant] = array_keys( array_filter( $rights ) );
47  }
48  return $res;
49  }
50 
57  public static function grantName( $grant, $lang = null ) {
58  // Give grep a chance to find the usages:
59  // grant-blockusers, grant-createeditmovepage, grant-delete,
60  // grant-editinterface, grant-editmycssjs, grant-editmywatchlist,
61  // grant-editpage, grant-editprotected, grant-highvolume,
62  // grant-oversight, grant-patrol, grant-protect, grant-rollback,
63  // grant-sendemail, grant-uploadeditmovefile, grant-uploadfile,
64  // grant-basic, grant-viewdeleted, grant-viewmywatchlist,
65  // grant-createaccount
66  $msg = wfMessage( "grant-$grant" );
67  if ( $lang !== null ) {
68  if ( is_string( $lang ) ) {
70  }
71  $msg->inLanguage( $lang );
72  }
73  if ( !$msg->exists() ) {
74  $msg = wfMessage( 'grant-generic', $grant );
75  if ( $lang ) {
76  $msg->inLanguage( $lang );
77  }
78  }
79  return $msg->text();
80  }
81 
88  public static function grantNames( array $grants, $lang = null ) {
89  if ( $lang !== null ) {
90  if ( is_string( $lang ) ) {
92  }
93  }
94 
95  $ret = [];
96  foreach ( $grants as $grant ) {
97  $ret[] = self::grantName( $grant, $lang );
98  }
99  return $ret;
100  }
101 
107  public static function getGrantRights( $grants ) {
108  global $wgGrantPermissions;
109 
110  $rights = [];
111  foreach ( (array)$grants as $grant ) {
112  if ( isset( $wgGrantPermissions[$grant] ) ) {
113  $rights = array_merge( $rights, array_keys( array_filter( $wgGrantPermissions[$grant] ) ) );
114  }
115  }
116  return array_unique( $rights );
117  }
118 
124  public static function grantsAreValid( array $grants ) {
125  return array_diff( $grants, self::getValidGrants() ) === [];
126  }
127 
133  public static function getGrantGroups( $grantsFilter = null ) {
134  global $wgGrantPermissions, $wgGrantPermissionGroups;
135 
136  if ( is_array( $grantsFilter ) ) {
137  $grantsFilter = array_flip( $grantsFilter );
138  }
139 
140  $groups = [];
141  foreach ( $wgGrantPermissions as $grant => $rights ) {
142  if ( $grantsFilter !== null && !isset( $grantsFilter[$grant] ) ) {
143  continue;
144  }
145  if ( isset( $wgGrantPermissionGroups[$grant] ) ) {
146  $groups[$wgGrantPermissionGroups[$grant]][] = $grant;
147  } else {
148  $groups['other'][] = $grant;
149  }
150  }
151 
152  return $groups;
153  }
154 
159  public static function getHiddenGrants() {
160  global $wgGrantPermissionGroups;
161 
162  $grants = [];
163  foreach ( $wgGrantPermissionGroups as $grant => $group ) {
164  if ( $group === 'hidden' ) {
165  $grants[] = $grant;
166  }
167  }
168  return $grants;
169  }
170 
181  public static function getGrantsLink( $grant, $lang = null ) {
182  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
183  return $linkRenderer->makeKnownLink(
184  \SpecialPage::getTitleFor( 'Listgrants', false, $grant ),
185  self::grantName( $grant, $lang )
186  );
187  }
188 
195  public static function getGrantsWikiText( $grantsFilter, $lang = null ) {
197 
198  if ( is_string( $lang ) ) {
200  } elseif ( $lang === null ) {
201  $lang = $wgContLang;
202  }
203 
204  $s = '';
205  foreach ( self::getGrantGroups( $grantsFilter ) as $group => $grants ) {
206  if ( $group === 'hidden' ) {
207  continue; // implicitly granted
208  }
209  $s .= "*<span class=\"mw-grantgroup\">" .
210  wfMessage( "grant-group-$group" )->inLanguage( $lang )->text() . "</span>\n";
211  $s .= ":" . $lang->semicolonList( self::grantNames( $grants, $lang ) ) . "\n";
212  }
213  return "$s\n";
214  }
215 
216 }
static getValidGrants()
List all known grants.
Definition: MWGrants.php:31
the array() calling protocol came about after MediaWiki 1.4rc1.
static grantName($grant, $lang=null)
Fetch the display name of the grant.
Definition: MWGrants.php:57
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:2019
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name If you don't need a full Title object...
Definition: SpecialPage.php:82
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:2019
static getGrantRights($grants)
Fetch the rights allowed by a set of grants.
Definition: MWGrants.php:107
if(!isset($args[0])) $lang
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
A collection of public static functions to deal with grants.
Definition: MWGrants.php:25
static getHiddenGrants()
Get the list of grants that are hidden and should always be granted.
Definition: MWGrants.php:159
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
$res
Definition: database.txt:21
static getGrantsWikiText($grantsFilter, $lang=null)
Generate wikitext to display a list of grants.
Definition: MWGrants.php:195
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static getGrantGroups($grantsFilter=null)
Divide the grants into groups.
Definition: MWGrants.php:133
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static getGrantsLink($grant, $lang=null)
Generate a link to Special:ListGrants for a particular grant name.
Definition: MWGrants.php:181
static getRightsByGrant()
Map all grants to corresponding user rights.
Definition: MWGrants.php:41
static grantsAreValid(array $grants)
Test that all grants in the list are known.
Definition: MWGrants.php:124
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
static grantNames(array $grants, $lang=null)
Fetch the display names for the grants.
Definition: MWGrants.php:88
static factory($code)
Get a cached or new language object for a given language code.
Definition: Language.php:183