MediaWiki  1.29.2
QuickTemplate.php
Go to the documentation of this file.
1 <?php
21 
27 abstract class QuickTemplate {
28 
30  protected $config;
31 
35  function __construct( Config $config = null ) {
36  $this->data = [];
37  $this->translator = new MediaWikiI18N();
38  if ( $config === null ) {
39  wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
40  $config = MediaWikiServices::getInstance()->getMainConfig();
41  }
42  $this->config = $config;
43  }
44 
50  public function set( $name, $value ) {
51  $this->data[$name] = $value;
52  }
53 
60  public function extend( $name, $value ) {
61  if ( $this->haveData( $name ) ) {
62  $this->data[$name] = $this->data[$name] . $value;
63  } else {
64  $this->data[$name] = $value;
65  }
66  }
67 
75  public function get( $name, $default = null ) {
76  if ( isset( $this->data[$name] ) ) {
77  return $this->data[$name];
78  } else {
79  return $default;
80  }
81  }
82 
87  public function setRef( $name, &$value ) {
88  $this->data[$name] =& $value;
89  }
90 
94  public function setTranslator( &$t ) {
95  $this->translator = &$t;
96  }
97 
102  abstract public function execute();
103 
108  function text( $str ) {
109  echo htmlspecialchars( $this->data[$str] );
110  }
111 
116  function html( $str ) {
117  echo $this->data[$str];
118  }
119 
124  function msg( $str ) {
125  echo htmlspecialchars( $this->translator->translate( $str ) );
126  }
127 
132  function msgHtml( $str ) {
133  echo $this->translator->translate( $str );
134  }
135 
141  function msgWiki( $str ) {
142  global $wgOut;
143 
144  $text = $this->translator->translate( $str );
145  echo $wgOut->parse( $text );
146  }
147 
153  function haveData( $str ) {
154  return isset( $this->data[$str] );
155  }
156 
163  function haveMsg( $str ) {
164  $msg = $this->translator->translate( $str );
165  return ( $msg != '-' ) && ( $msg != '' ); # ????
166  }
167 
173  public function getSkin() {
174  return $this->data['skin'];
175  }
176 
183  public function getHTML() {
184  ob_start();
185  $this->execute();
186  $html = ob_get_contents();
187  ob_end_clean();
188  return $html;
189  }
190 }
QuickTemplate\msgHtml
msgHtml( $str)
Definition: QuickTemplate.php:132
QuickTemplate\$config
$config
Definition: QuickTemplate.php:30
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
QuickTemplate\setRef
setRef( $name, &$value)
Definition: QuickTemplate.php:87
QuickTemplate\getSkin
getSkin()
Get the Skin object related to this object.
Definition: QuickTemplate.php:173
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:35
QuickTemplate\setTranslator
setTranslator(&$t)
Definition: QuickTemplate.php:94
QuickTemplate\getHTML
getHTML()
Fetch the output of a QuickTemplate and return it.
Definition: QuickTemplate.php:183
QuickTemplate\msg
msg( $str)
Definition: QuickTemplate.php:124
$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:1956
QuickTemplate\msgWiki
msgWiki( $str)
An ugly, ugly hack.
Definition: QuickTemplate.php:141
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
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:999
QuickTemplate\execute
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
QuickTemplate\text
text( $str)
Definition: QuickTemplate.php:108
$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\haveMsg
haveMsg( $str)
Definition: QuickTemplate.php:163
QuickTemplate\__construct
__construct(Config $config=null)
Definition: QuickTemplate.php:35
QuickTemplate\extend
extend( $name, $value)
extends the value of data with name $name with the value $value
Definition: QuickTemplate.php:60
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:153
QuickTemplate\html
html( $str)
Definition: QuickTemplate.php:116
$t
$t
Definition: testCompression.php:67
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:23
$wgOut
$wgOut
Definition: Setup.php:791
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:6