MediaWiki  REL1_31
HTMLTextAreaField.php
Go to the documentation of this file.
1 <?php
2 
4  const DEFAULT_COLS = 80;
5  const DEFAULT_ROWS = 25;
6 
7  protected $mPlaceholder = '';
8  protected $mUseEditFont = false;
9 
17  public function __construct( $params ) {
18  parent::__construct( $params );
19 
20  if ( isset( $params['placeholder-message'] ) ) {
21  $this->mPlaceholder = $this->getMessage( $params['placeholder-message'] )->text();
22  } elseif ( isset( $params['placeholder'] ) ) {
23  $this->mPlaceholder = $params['placeholder'];
24  }
25 
26  if ( isset( $params['useeditfont'] ) ) {
27  $this->mUseEditFont = $params['useeditfont'];
28  }
29  }
30 
31  public function getCols() {
32  return isset( $this->mParams['cols'] ) ? $this->mParams['cols'] : static::DEFAULT_COLS;
33  }
34 
35  public function getRows() {
36  return isset( $this->mParams['rows'] ) ? $this->mParams['rows'] : static::DEFAULT_ROWS;
37  }
38 
39  public function getSpellCheck() {
40  $val = isset( $this->mParams['spellcheck'] ) ? $this->mParams['spellcheck'] : null;
41  if ( is_bool( $val ) ) {
42  // "spellcheck" attribute literally requires "true" or "false" to work.
43  return $val === true ? 'true' : 'false';
44  }
45  return null;
46  }
47 
48  public function getInputHTML( $value ) {
49  $classes = [];
50 
51  $attribs = [
52  'id' => $this->mID,
53  'cols' => $this->getCols(),
54  'rows' => $this->getRows(),
55  'spellcheck' => $this->getSpellCheck(),
56  ] + $this->getTooltipAndAccessKey();
57 
58  if ( $this->mClass !== '' ) {
59  array_push( $classes, $this->mClass );
60  }
61  if ( $this->mUseEditFont ) {
62  // The following classes can be used here:
63  // * mw-editfont-monospace
64  // * mw-editfont-sans-serif
65  // * mw-editfont-serif
66  array_push(
67  $classes,
68  'mw-editfont-' . $this->mParent->getUser()->getOption( 'editfont' )
69  );
70  $this->mParent->getOutput()->addModuleStyles( 'mediawiki.editfont.styles' );
71  }
72  if ( $this->mPlaceholder !== '' ) {
73  $attribs['placeholder'] = $this->mPlaceholder;
74  }
75  if ( count( $classes ) ) {
76  $attribs['class'] = implode( ' ', $classes );
77  }
78 
79  $allowedParams = [
80  'tabindex',
81  'disabled',
82  'readonly',
83  'required',
84  'autofocus'
85  ];
86 
87  $attribs += $this->getAttributes( $allowedParams );
88  return Html::textarea( $this->mName, $value, $attribs );
89  }
90 
91  function getInputOOUI( $value ) {
92  $classes = [];
93 
94  if ( isset( $this->mParams['cols'] ) ) {
95  throw new Exception( "OOUIHTMLForm does not support the 'cols' parameter for textareas" );
96  }
97 
99 
100  if ( $this->mClass !== '' ) {
101  array_push( $classes, $this->mClass );
102  }
103  if ( $this->mUseEditFont ) {
104  // The following classes can be used here:
105  // * mw-editfont-monospace
106  // * mw-editfont-sans-serif
107  // * mw-editfont-serif
108  array_push(
109  $classes,
110  'mw-editfont-' . $this->mParent->getUser()->getOption( 'editfont' )
111  );
112  $this->mParent->getOutput()->addModuleStyles( 'mediawiki.editfont.styles' );
113  }
114  if ( $this->mPlaceholder !== '' ) {
115  $attribs['placeholder'] = $this->mPlaceholder;
116  }
117  if ( count( $classes ) ) {
118  $attribs['classes'] = $classes;
119  }
120 
121  $allowedParams = [
122  'tabindex',
123  'disabled',
124  'readonly',
125  'required',
126  'autofocus',
127  ];
128 
129  $attribs += OOUI\Element::configFromHtmlAttributes(
130  $this->getAttributes( $allowedParams )
131  );
132 
133  return new OOUI\MultilineTextInputWidget( [
134  'id' => $this->mID,
135  'name' => $this->mName,
136  'value' => $value,
137  'rows' => $this->getRows(),
138  ] + $attribs );
139  }
140 }
HTMLTextAreaField\$mUseEditFont
$mUseEditFont
Definition: HTMLTextAreaField.php:8
Html\textarea
static textarea( $name, $value='', array $attribs=[])
Convenience function to produce a <textarea> element.
Definition: Html.php:790
HTMLFormField\getTooltipAndAccessKeyOOUI
getTooltipAndAccessKeyOOUI()
Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
Definition: HTMLFormField.php:1010
HTMLTextAreaField\getSpellCheck
getSpellCheck()
Definition: HTMLTextAreaField.php:39
$params
$params
Definition: styleTest.css.php:40
HTMLTextAreaField\DEFAULT_COLS
const DEFAULT_COLS
Definition: HTMLTextAreaField.php:4
HTMLFormField\getMessage
getMessage( $value)
Turns a *-message parameter (which could be a MessageSpecifier, or a message name,...
Definition: HTMLFormField.php:1177
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:37
HTMLFormField
The parent class to generate form fields.
Definition: HTMLFormField.php:7
HTMLTextAreaField\getInputHTML
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself.
Definition: HTMLTextAreaField.php:48
HTMLTextAreaField\getCols
getCols()
Definition: HTMLTextAreaField.php:31
HTMLFormField\$mID
$mID
Definition: HTMLFormField.php:15
$attribs
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 after processing & $attribs
Definition: hooks.txt:2014
$value
$value
Definition: styleTest.css.php:45
HTMLTextAreaField\$mPlaceholder
$mPlaceholder
Definition: HTMLTextAreaField.php:7
HTMLTextAreaField\DEFAULT_ROWS
const DEFAULT_ROWS
Definition: HTMLTextAreaField.php:5
HTMLTextAreaField\getInputOOUI
getInputOOUI( $value)
Same as getInputHTML, but returns an OOUI object.
Definition: HTMLTextAreaField.php:91
HTMLTextAreaField\getRows
getRows()
Definition: HTMLTextAreaField.php:35
HTMLFormField\getTooltipAndAccessKey
getTooltipAndAccessKey()
Returns the attributes required for the tooltip and accesskey, for Html::element() etc.
Definition: HTMLFormField.php:997
HTMLTextAreaField\__construct
__construct( $params)
Definition: HTMLTextAreaField.php:17
HTMLFormField\getAttributes
getAttributes(array $list)
Returns the given attributes from the parameters.
Definition: HTMLFormField.php:1027
HTMLTextAreaField
Definition: HTMLTextAreaField.php:3