Allow closures as HTMLInfoField values
authorGergő Tisza <tgr.huwiki@gmail.com>
Tue, 2 Aug 2016 07:27:44 +0000 (00:27 -0700)
committerGergő Tisza <gtisza@wikimedia.org>
Tue, 2 Aug 2016 21:22:31 +0000 (21:22 +0000)
This makes it possible to parametrize info fields so they can be
easily altered.

Change-Id: I17328cf3f1a710096c64b17dde0864cb9be3892d

includes/htmlform/fields/HTMLInfoField.php

index ada4fb6..6dc5d08 100644 (file)
@@ -4,12 +4,29 @@
  * 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 );
        }
 
+       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 );
        }