MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / htmlform / fields / HTMLInfoField.php

diff --git a/includes/htmlform/fields/HTMLInfoField.php b/includes/htmlform/fields/HTMLInfoField.php
new file mode 100644 (file)
index 0000000..1376d0c
--- /dev/null
+++ b/includes/htmlform/fields/HTMLInfoField.php
@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * An information field (text blob), not a proper input.
+ */
+class HTMLInfoField extends HTMLFormField {
+       /**
+        * @param array $info
+        *   In adition to the usual HTMLFormField parameters, this can take the following fields:
+        *   - default: the value (text) of the field. Unlike other form field types, HTMLInfoField can
+        *     take a closure as a default value, which will be evaluated with $info as its only parameter.
+        *   - raw: if true, the value won't be escaped.
+        *   - rawrow: if true, the usual wrapping of form fields (e.g. into a table row + cell when
+        *     display mode is table) will not happen and the value must contain it already.
+        */
+       public function __construct( $info ) {
+               $info['nodata'] = true;
+
+               parent::__construct( $info );
+       }
+
+       public function getDefault() {
+               $default = parent::getDefault();
+               if ( $default instanceof Closure ) {
+                       $default = call_user_func( $default, $this->mParams );
+               }
+               return $default;
+       }
+
+       public function getInputHTML( $value ) {
+               return !empty( $this->mParams['raw'] ) ? $value : htmlspecialchars( $value );
+       }
+
+       public function getInputOOUI( $value ) {
+               if ( !empty( $this->mParams['raw'] ) ) {
+                       $value = new OOUI\HtmlSnippet( $value );
+               }
+
+               return new OOUI\LabelWidget( [
+                       'label' => $value,
+               ] );
+       }
+
+       public function getTableRow( $value ) {
+               if ( !empty( $this->mParams['rawrow'] ) ) {
+                       return $value;
+               }
+
+               return parent::getTableRow( $value );
+       }
+
+       /**
+        * @param string $value
+        * @return string
+        * @since 1.20
+        */
+       public function getDiv( $value ) {
+               if ( !empty( $this->mParams['rawrow'] ) ) {
+                       return $value;
+               }
+
+               return parent::getDiv( $value );
+       }
+
+       /**
+        * @param string $value
+        * @return string
+        * @since 1.20
+        */
+       public function getRaw( $value ) {
+               if ( !empty( $this->mParams['rawrow'] ) ) {
+                       return $value;
+               }
+
+               return parent::getRaw( $value );
+       }
+
+       protected function needsLabel() {
+               return false;
+       }
+}