MediaWiki REL1_31
QuickTemplate.php
Go to the documentation of this file.
1<?php
21
27abstract class QuickTemplate {
28
32 public $data;
33
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}
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$wgOut
Definition Setup.php:912
Wrapper object for MediaWiki's localization functions, to be passed to the template engine.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0....
msgHtml( $msgKey)
getSkin()
Get the Skin object related to this object.
__construct(Config $config=null)
setRef( $name, &$value)
getHTML()
Fetch the output of a QuickTemplate and return it.
msgWiki( $msgKey)
An ugly, ugly hack.
extend( $name, $value)
extends the value of data with name $name with the value $value
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
haveMsg( $msgKey)
MediaWikiI18N $translator
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
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 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
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
Interface for configuration instances.
Definition Config.php:28