MediaWiki  1.30.0
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 
97  public function setRef( $name, &$value ) {
98  $this->data[$name] =& $value;
99  }
100 
104  public function setTranslator( &$t ) {
105  $this->translator = &$t;
106  }
107 
112  abstract public function execute();
113 
118  function text( $str ) {
119  echo htmlspecialchars( $this->data[$str] );
120  }
121 
126  function html( $str ) {
127  echo $this->data[$str];
128  }
129 
134  function msg( $str ) {
135  echo htmlspecialchars( $this->translator->translate( $str ) );
136  }
137 
142  function msgHtml( $str ) {
143  echo $this->translator->translate( $str );
144  }
145 
151  function msgWiki( $str ) {
152  global $wgOut;
153 
154  $text = $this->translator->translate( $str );
155  echo $wgOut->parse( $text );
156  }
157 
163  function haveData( $str ) {
164  return isset( $this->data[$str] );
165  }
166 
173  function haveMsg( $str ) {
174  $msg = $this->translator->translate( $str );
175  return ( $msg != '-' ) && ( $msg != '' ); # ????
176  }
177 
183  public function getSkin() {
184  return $this->data['skin'];
185  }
186 
193  public function getHTML() {
194  ob_start();
195  $this->execute();
196  $html = ob_get_contents();
197  ob_end_clean();
198  return $html;
199  }
200 }
QuickTemplate\msgHtml
msgHtml( $str)
Definition: QuickTemplate.php:142
QuickTemplate\$translator
MediaWikiI18N $translator
Definition: QuickTemplate.php:37
QuickTemplate\$config
$config
Definition: QuickTemplate.php:40
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:302
QuickTemplate\setRef
setRef( $name, &$value)
Definition: QuickTemplate.php:97
QuickTemplate\getSkin
getSkin()
Get the Skin object related to this object.
Definition: QuickTemplate.php:183
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:104
QuickTemplate\getHTML
getHTML()
Fetch the output of a QuickTemplate and return it.
Definition: QuickTemplate.php:193
QuickTemplate\msg
msg( $str)
Definition: QuickTemplate.php:134
$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:1965
QuickTemplate\msgWiki
msgWiki( $str)
An ugly, ugly hack.
Definition: QuickTemplate.php:151
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:1047
QuickTemplate\execute
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
QuickTemplate\text
text( $str)
Definition: QuickTemplate.php:118
$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:173
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:163
QuickTemplate\html
html( $str)
Definition: QuickTemplate.php:126
$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:819
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
array
the array() calling protocol came about after MediaWiki 1.4rc1.