3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
19 * @author Trevor Parscal
20 * @author Roan Kattouw
24 * Object passed around to modules which contains information about the state
25 * of a specific loader request
27 class ResourceLoaderContext
{
29 /* Protected Members */
31 protected $resourceLoader;
45 public function __construct( ResourceLoader
$resourceLoader, WebRequest
$request ) {
46 global $wgDefaultSkin, $wgResourceLoaderDebug;
48 $this->resourceLoader
= $resourceLoader;
49 $this->request
= $request;
53 $modules = $request->getVal( 'modules' );
54 $this->modules
= $modules ? self
::expandModuleNames( $modules ) : array();
56 $this->skin
= $request->getVal( 'skin' );
57 $this->user
= $request->getVal( 'user' );
58 $this->debug
= $request->getFuzzyBool( 'debug', $wgResourceLoaderDebug );
59 $this->only
= $request->getVal( 'only' );
60 $this->version
= $request->getVal( 'version' );
63 $this->skin
= $wgDefaultSkin;
68 * Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to
69 * an array of module names like array( 'jquery.foo', 'jquery.bar',
70 * 'jquery.ui.baz', 'jquery.ui.quux' )
71 * @param $modules String Packed module name list
72 * @return array of module names
74 public static function expandModuleNames( $modules ) {
76 $exploded = explode( '|', $modules );
77 foreach ( $exploded as $group ) {
78 if ( strpos( $group, ',' ) === false ) {
79 // This is not a set of modules in foo.bar,baz notation
80 // but a single module
83 // This is a set of modules in foo.bar,baz notation
84 $pos = strrpos( $group, '.' );
85 if ( $pos === false ) {
86 // Prefixless modules, i.e. without dots
87 $retval = explode( ',', $group );
89 // We have a prefix and a bunch of suffixes
90 $prefix = substr( $group, 0, $pos ); // 'foo'
91 $suffixes = explode( ',', substr( $group, $pos +
1 ) ); // array( 'bar', 'baz' )
92 foreach ( $suffixes as $suffix ) {
93 $retval[] = "$prefix.$suffix";
102 * @return ResourceLoader
104 public function getResourceLoader() {
105 return $this->resourceLoader
;
111 public function getRequest() {
112 return $this->request
;
118 public function getModules() {
119 return $this->modules
;
125 public function getLanguage() {
126 if ( $this->language
=== null ) {
128 $this->language
= $this->request
->getVal( 'lang' );
129 if ( !$this->language
) {
130 $this->language
= $wgLang->getCode();
133 return $this->language
;
139 public function getDirection() {
140 if ( $this->direction
=== null ) {
141 $this->direction
= $this->request
->getVal( 'dir' );
142 if ( !$this->direction
) {
144 $this->direction
= $wgContLang->getDir();
147 return $this->direction
;
153 public function getSkin() {
160 public function getUser() {
167 public function getDebug() {
174 public function getOnly() {
181 public function getVersion() {
182 return $this->version
;
188 public function shouldIncludeScripts() {
189 return is_null( $this->only
) ||
$this->only
=== 'scripts';
195 public function shouldIncludeStyles() {
196 return is_null( $this->only
) ||
$this->only
=== 'styles';
202 public function shouldIncludeMessages() {
203 return is_null( $this->only
) ||
$this->only
=== 'messages';
209 public function getHash() {
210 if ( !isset( $this->hash
) ) {
211 $this->hash
= implode( '|', array(
212 $this->getLanguage(), $this->getDirection(), $this->skin
, $this->user
,
213 $this->debug
, $this->only
, $this->version