MediaWiki  master
QuickTemplate.php
Go to the documentation of this file.
1 <?php
21 
27 abstract class QuickTemplate {
28 
32  public $data;
33 
35  protected $config;
36 
40  function __construct( Config $config = null ) {
41  $this->data = [];
42  if ( $config === null ) {
43  wfDebug( __METHOD__ . ' was called with no Config instance passed to it' );
44  $config = MediaWikiServices::getInstance()->getMainConfig();
45  }
46  $this->config = $config;
47  }
48 
54  public function set( $name, $value ) {
55  $this->data[$name] = $value;
56  }
57 
64  public function extend( $name, $value ) {
65  if ( $this->haveData( $name ) ) {
66  $this->data[$name] .= $value;
67  } else {
68  $this->data[$name] = $value;
69  }
70  }
71 
80  public function get( $name, $default = null ) {
81  return $this->data[$name] ?? $default;
82  }
83 
91  public function setRef( $name, &$value ) {
92  wfDeprecated( __METHOD__, '1.31' );
93  $this->data[$name] =& $value;
94  }
95 
100  abstract public function execute();
101 
107  function text( $str ) {
108  echo htmlspecialchars( $this->data[$str] );
109  }
110 
116  function html( $str ) {
117  echo $this->data[$str];
118  }
119 
124  function msg( $msgKey ) {
125  echo htmlspecialchars( wfMessage( $msgKey )->text() );
126  }
127 
136  function msgHtml( $msgKey ) {
137  wfDeprecated( __METHOD__, '1.32' );
138  echo wfMessage( $msgKey )->text();
139  }
140 
146  function msgWiki( $msgKey ) {
147  // TODO: Add wfDeprecated( __METHOD__, '1.33' ) after 1.33 got released
148  global $wgOut;
149 
150  $text = wfMessage( $msgKey )->plain();
151  echo $wgOut->parseAsInterface( $text );
152  }
153 
159  function haveData( $str ) {
160  return isset( $this->data[$str] );
161  }
162 
169  function haveMsg( $msgKey ) {
170  $msg = wfMessage( $msgKey );
171  return $msg->exists() && !$msg->isDisabled();
172  }
173 
179  public function getSkin() {
180  return $this->data['skin'];
181  }
182 
189  public function getHTML() {
190  ob_start();
191  $this->execute();
192  $html = ob_get_contents();
193  ob_end_clean();
194  return $html;
195  }
196 }
msgWiki( $msgKey)
An ugly, ugly hack.
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:1982
Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
msgHtml( $msgKey)
$value
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
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 use $formDescriptor instead 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
Interface for configuration instances.
Definition: Config.php:28
getSkin()
Get the Skin object related to this object.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
setRef( $name, &$value)
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)
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$wgOut
Definition: Setup.php:880
getHTML()
Fetch the output of a QuickTemplate and return it.
haveMsg( $msgKey)
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output...
extend( $name, $value)
extends the value of data with name $name with the value $value