summaryrefslogtreecommitdiff
path: root/vendor/oojs/oojs-ui/php/Theme.php
blob: d36b6d82eca6189bc6dc68297d2f8c9f5718d0f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<?php

namespace OOUI;

/**
 * Theme logic.
 *
 * @abstract
 */
class Theme {

	/* Members */

	private static $singleton;

	/* Static Methods */

	public static function setSingleton( Theme $theme ) {
		self::$singleton = $theme;
	}

	public static function singleton() {
		if ( !self::$singleton ) {
			throw new Exception( __METHOD__ . ' was called with no singleton theme set.' );
		}

		return self::$singleton;
	}

	/**
	 * Get a list of classes to be applied to a widget.
	 *
	 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
	 * otherwise state transitions will not work properly.
	 *
	 * @param Element $element Element for which to get classes
	 * @return array Categorized class names with `on` and `off` lists
	 */
	public function getElementClasses( Element $element ) {
		return array( 'on' => array(), 'off' => array() );
	}

	/**
	 * Update CSS classes provided by the theme.
	 *
	 * For elements with theme logic hooks, this should be called any time there's a state change.
	 *
	 * @param Element $element Element for which to update classes
	 * @return array Categorized class names with `on` and `off` lists
	 */
	public function updateElementClasses( Element $element ) {
		$classes = $this->getElementClasses( $element );

		$element
			->removeClasses( $classes['off'] )
			->addClasses( $classes['on'] );
	}
}