MediaWiki  1.28.0
QuickTemplate.php
Go to the documentation of this file.
1 <?php
26 abstract class QuickTemplate {
27 
29  protected $config;
30 
34  function __construct( Config $config = null ) {
35  $this->data = [];
36  $this->translator = new MediaWikiI18N();
37  if ( $config === null ) {
38  wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
39  $config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
40  }
41  $this->config = $config;
42  }
43 
49  public function set( $name, $value ) {
50  $this->data[$name] = $value;
51  }
52 
59  public function extend( $name, $value ) {
60  if ( $this->haveData( $name ) ) {
61  $this->data[$name] = $this->data[$name] . $value;
62  } else {
63  $this->data[$name] = $value;
64  }
65  }
66 
74  public function get( $name, $default = null ) {
75  if ( isset( $this->data[$name] ) ) {
76  return $this->data[$name];
77  } else {
78  return $default;
79  }
80  }
81 
86  public function setRef( $name, &$value ) {
87  $this->data[$name] =& $value;
88  }
89 
93  public function setTranslator( &$t ) {
94  $this->translator = &$t;
95  }
96 
101  abstract public function execute();
102 
107  function text( $str ) {
108  echo htmlspecialchars( $this->data[$str] );
109  }
110 
115  function html( $str ) {
116  echo $this->data[$str];
117  }
118 
123  function msg( $str ) {
124  echo htmlspecialchars( $this->translator->translate( $str ) );
125  }
126 
131  function msgHtml( $str ) {
132  echo $this->translator->translate( $str );
133  }
134 
140  function msgWiki( $str ) {
141  global $wgOut;
142 
143  $text = $this->translator->translate( $str );
144  echo $wgOut->parse( $text );
145  }
146 
152  function haveData( $str ) {
153  return isset( $this->data[$str] );
154  }
155 
162  function haveMsg( $str ) {
163  $msg = $this->translator->translate( $str );
164  return ( $msg != '-' ) && ( $msg != '' ); # ????
165  }
166 
172  public function getSkin() {
173  return $this->data['skin'];
174  }
175 
182  public function getHTML() {
183  ob_start();
184  $this->execute();
185  $html = ob_get_contents();
186  ob_end_clean();
187  return $html;
188  }
189 }
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
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:1936
Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0...
msgWiki($str)
An ugly, ugly hack.
$value
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
getSkin()
Get the Skin object related to this object.
Wrapper object for MediaWiki's localization functions, to be passed to the template engine...
setRef($name, &$value)
static getDefaultInstance()
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
__construct(Config $config=null)
$wgOut
Definition: Setup.php:816
getHTML()
Fetch the output of a QuickTemplate and return it.
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output...
set($name, $value)
Sets the value $value to $name.
extend($name, $value)
extends the value of data with name $name with the value $value
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300