MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / ListToggle.php

diff --git a/includes/ListToggle.php b/includes/ListToggle.php
new file mode 100644 (file)
index 0000000..7a5fd9a
--- /dev/null
+++ b/includes/ListToggle.php
@@ -0,0 +1,69 @@
+<?php
+/**
+ * Class for generating clickable toggle links for a list of checkboxes.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Class for generating clickable toggle links for a list of checkboxes.
+ *
+ * This is only supported on clients that have JavaScript enabled; it is hidden
+ * for clients that have it disabled.
+ *
+ * @since 1.27
+ */
+class ListToggle {
+       /** @var OutputPage */
+       private $output;
+
+       public function __construct( OutputPage $output ) {
+               $this->output = $output;
+
+               $output->addModules( 'mediawiki.checkboxtoggle' );
+               $output->addModuleStyles( 'mediawiki.checkboxtoggle.styles' );
+       }
+
+       private function checkboxLink( $checkboxType ) {
+               return Html::element(
+                       // CSS classes: mw-checkbox-all, mw-checkbox-none, mw-checkbox-invert
+                       'a', [ 'class' => 'mw-checkbox-' . $checkboxType, 'role' => 'button', 'tabindex' => 0 ],
+                       $this->output->msg( 'checkbox-' . $checkboxType )->text()
+               );
+       }
+
+       /**
+        * @return string
+        */
+       public function getHTML() {
+               // Select: All, None, Invert
+               $links = [
+                       $this->checkboxLink( 'all' ),
+                       $this->checkboxLink( 'none' ),
+                       $this->checkboxLink( 'invert' ),
+               ];
+
+               return Html::rawElement( 'div',
+                       [
+                               'class' => 'mw-checkbox-toggle-controls'
+                       ],
+                       $this->output->msg( 'checkbox-select' )
+                               ->rawParams( $this->output->getLanguage()->commaList( $links ) )->escaped()
+               );
+       }
+}