MediaWiki  REL1_31
QuickTemplate.php
Go to the documentation of this file.
1 <?php
21 
27 abstract class QuickTemplate {
28 
32  public $data;
33 
37  public $translator;
38 
40  protected $config;
41 
45  function __construct( Config $config = null ) {
46  $this->data = [];
47  $this->translator = new MediaWikiI18N();
48  if ( $config === null ) {
49  wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
50  $config = MediaWikiServices::getInstance()->getMainConfig();
51  }
52  $this->config = $config;
53  }
54 
60  public function set( $name, $value ) {
61  $this->data[$name] = $value;
62  }
63 
70  public function extend( $name, $value ) {
71  if ( $this->haveData( $name ) ) {
72  $this->data[$name] = $this->data[$name] . $value;
73  } else {
74  $this->data[$name] = $value;
75  }
76  }
77 
85  public function get( $name, $default = null ) {
86  if ( isset( $this->data[$name] ) ) {
87  return $this->data[$name];
88  } else {
89  return $default;
90  }
91  }
92 
100  public function setRef( $name, &$value ) {
101  wfDeprecated( __METHOD__, '1.31' );
102  $this->data[$name] =& $value;
103  }
104 
110  public function setTranslator( &$t ) {
111  wfDeprecated( __METHOD__, '1.31' );
112  $this->translator = &$t;
113  }
114 
119  abstract public function execute();
120 
125  function text( $str ) {
126  echo htmlspecialchars( $this->data[$str] );
127  }
128 
133  function html( $str ) {
134  echo $this->data[$str];
135  }
136 
141  function msg( $msgKey ) {
142  echo htmlspecialchars( wfMessage( $msgKey )->text() );
143  }
144 
149  function msgHtml( $msgKey ) {
150  echo wfMessage( $msgKey )->text();
151  }
152 
158  function msgWiki( $msgKey ) {
159  global $wgOut;
160 
161  $text = wfMessage( $msgKey )->text();
162  echo $wgOut->parse( $text );
163  }
164 
170  function haveData( $str ) {
171  return isset( $this->data[$str] );
172  }
173 
180  function haveMsg( $msgKey ) {
181  $msg = wfMessage( $msgKey );
182  return $msg->exists() && !$msg->isDisabled();
183  }
184 
190  public function getSkin() {
191  return $this->data['skin'];
192  }
193 
200  public function getHTML() {
201  ob_start();
202  $this->execute();
203  $html = ob_get_contents();
204  ob_end_clean();
205  return $html;
206  }
207 }
QuickTemplate\msgHtml
msgHtml( $msgKey)
Definition: QuickTemplate.php:149
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$html
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 & $html
Definition: hooks.txt:2013
wfMessage
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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
QuickTemplate\$translator
MediaWikiI18N $translator
Definition: QuickTemplate.php:37
QuickTemplate\msg
msg( $msgKey)
Definition: QuickTemplate.php:141
QuickTemplate\$config
$config
Definition: QuickTemplate.php:40
QuickTemplate\msgWiki
msgWiki( $msgKey)
An ugly, ugly hack.
Definition: QuickTemplate.php:158
QuickTemplate\setRef
setRef( $name, &$value)
Definition: QuickTemplate.php:100
QuickTemplate\getSkin
getSkin()
Get the Skin object related to this object.
Definition: QuickTemplate.php:190
php
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:37
QuickTemplate\setTranslator
setTranslator(&$t)
Definition: QuickTemplate.php:110
QuickTemplate\getHTML
getHTML()
Fetch the output of a QuickTemplate and return it.
Definition: QuickTemplate.php:200
Config
Interface for configuration instances.
Definition: Config.php:28
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
QuickTemplate\execute
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
QuickTemplate\text
text( $str)
Definition: QuickTemplate.php:125
$value
$value
Definition: styleTest.css.php:45
MediaWikiI18N
Wrapper object for MediaWiki's localization functions, to be passed to the template engine.
Definition: MediaWikiI18N.php:28
QuickTemplate\__construct
__construct(Config $config=null)
Definition: QuickTemplate.php:45
QuickTemplate\$data
array $data
Definition: QuickTemplate.php:32
QuickTemplate\extend
extend( $name, $value)
extends the value of data with name $name with the value $value
Definition: QuickTemplate.php:70
QuickTemplate
Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0....
Definition: QuickTemplate.php:27
QuickTemplate\haveData
haveData( $str)
Definition: QuickTemplate.php:170
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
QuickTemplate\html
html( $str)
Definition: QuickTemplate.php:133
$t
$t
Definition: testCompression.php:69
MediaWikiServices
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:25
$wgOut
$wgOut
Definition: Setup.php:912
QuickTemplate\haveMsg
haveMsg( $msgKey)
Definition: QuickTemplate.php:180
data
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:18