MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / htmlform / HTMLFormElement.php

diff --git a/includes/htmlform/HTMLFormElement.php b/includes/htmlform/HTMLFormElement.php
new file mode 100644 (file)
index 0000000..10db90c
--- /dev/null
+++ b/includes/htmlform/HTMLFormElement.php
@@ -0,0 +1,65 @@
+<?php
+
+/**
+ * Allows custom data specific to HTMLFormField to be set for OOjs UI forms. A matching JS widget
+ * (defined in htmlform.Element.js) picks up the extra config when constructed using OO.ui.infuse().
+ *
+ * Currently only supports passing 'hide-if' data.
+ */
+trait HTMLFormElement {
+
+       protected $hideIf = null;
+       protected $modules = null;
+
+       public function initializeHTMLFormElement( array $config = [] ) {
+               // Properties
+               $this->hideIf = isset( $config['hideIf'] ) ? $config['hideIf'] : null;
+               $this->modules = isset( $config['modules'] ) ? $config['modules'] : [];
+
+               // Initialization
+               if ( $this->hideIf ) {
+                       $this->addClasses( [ 'mw-htmlform-hide-if' ] );
+               }
+               if ( $this->modules ) {
+                       // JS code must be able to read this before infusing (before OOjs UI is even loaded),
+                       // so we put this in a separate attribute (not with the rest of the config).
+                       // And it's not needed anymore after infusing, so we don't put it in JS config at all.
+                       $this->setAttributes( [ 'data-mw-modules' => implode( ',', $this->modules ) ] );
+               }
+               $this->registerConfigCallback( function ( &$config ) {
+                       if ( $this->hideIf !== null ) {
+                               $config['hideIf'] = $this->hideIf;
+                       }
+               } );
+       }
+}
+
+class HTMLFormFieldLayout extends OOUI\FieldLayout {
+       use HTMLFormElement;
+
+       public function __construct( $fieldWidget, array $config = [] ) {
+               // Parent constructor
+               parent::__construct( $fieldWidget, $config );
+               // Traits
+               $this->initializeHTMLFormElement( $config );
+       }
+
+       protected function getJavaScriptClassName() {
+               return 'mw.htmlform.FieldLayout';
+       }
+}
+
+class HTMLFormActionFieldLayout extends OOUI\ActionFieldLayout {
+       use HTMLFormElement;
+
+       public function __construct( $fieldWidget, $buttonWidget = false, array $config = [] ) {
+               // Parent constructor
+               parent::__construct( $fieldWidget, $buttonWidget, $config );
+               // Traits
+               $this->initializeHTMLFormElement( $config );
+       }
+
+       protected function getJavaScriptClassName() {
+               return 'mw.htmlform.ActionFieldLayout';
+       }
+}