MediaWiki REL1_30
MWGrants.php
Go to the documentation of this file.
1<?php
21
25class MWGrants {
26
31 public static function getValidGrants() {
33
34 return array_keys( $wgGrantPermissions );
35 }
36
41 public static function getRightsByGrant() {
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 ) ) {
69 $lang = Language::factory( $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 ) ) {
91 $lang = Language::factory( $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 ) {
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() {
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 ) {
196 global $wgContLang;
197
198 if ( is_string( $lang ) ) {
199 $lang = Language::factory( $lang );
200 } elseif ( $lang === null ) {
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}
Array $wgGrantPermissions
Map of (grant => right => boolean) Users authorize consumers (like Apps) to act on their behalf but o...
Array $wgGrantPermissionGroups
Map of grants to their UI grouping.
A collection of public static functions to deal with grants.
Definition MWGrants.php:25
static getGrantsWikiText( $grantsFilter, $lang=null)
Generate wikitext to display a list of grants.
Definition MWGrants.php:195
static grantName( $grant, $lang=null)
Fetch the display name of the grant.
Definition MWGrants.php:57
static getHiddenGrants()
Get the list of grants that are hidden and should always be granted.
Definition MWGrants.php:159
static grantNames(array $grants, $lang=null)
Fetch the display names for the grants.
Definition MWGrants.php:88
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
static getGrantRights( $grants)
Fetch the rights allowed by a set of grants.
Definition MWGrants.php:107
static getGrantGroups( $grantsFilter=null)
Divide the grants into groups.
Definition MWGrants.php:133
static getValidGrants()
List all known grants.
Definition MWGrants.php:31
MediaWikiServices is the service locator for the application scope of MediaWiki.
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,...
$res
Definition database.txt:21
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:57
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 unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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:1975
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:2026
if(!isset( $args[0])) $lang