r96973 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r96972‎ | r96973 | r96974 >
Date:15:12, 13 September 2011
Author:jeroendedauw
Status:ok
Tags:
Comment:
docs++
Modified paths:
  • /trunk/extensions/Survey/Survey.settings.php (modified) (history)

Diff [purge]

Index: trunk/extensions/Survey/Survey.settings.php
@@ -18,6 +18,14 @@
1919 */
2020 class SurveySettings {
2121
 22+ /**
 23+ * Returns the default values for the settings.
 24+ * setting name (string) => setting value (mixed)
 25+ *
 26+ * @since 0.1
 27+ *
 28+ * @return array
 29+ */
2230 protected static function getDefaultSettings() {
2331 return array(
2432 'JSDebug' => false,
@@ -30,6 +38,15 @@
3139 );
3240 }
3341
 42+ /**
 43+ * Retruns an array with all settings after making sure they are
 44+ * initialized (ie set settings have been merged with the defaults).
 45+ * setting name (string) => setting value (mixed)
 46+ *
 47+ * @since 0.1
 48+ *
 49+ * @return array
 50+ */
3451 public static function getSettings() {
3552 static $settings = false;
3653
@@ -43,9 +60,24 @@
4461 return $settings;
4562 }
4663
 64+ /**
 65+ * Gets the value of the specified setting.
 66+ *
 67+ * @since 0.1
 68+ *
 69+ * @param string $settingName
 70+ *
 71+ * @throws MWException
 72+ * @return mixed
 73+ */
4774 public static function get( $settingName ) {
4875 $settings = self::getSettings();
49 - return array_key_exists( $settingName, $settings ) ? $settings[$settingName] : null;
 76+
 77+ if ( !array_key_exists( $settingName, $settings ) ) {
 78+ throw new MWException( 'Attempt to get non-existing setting "' . $settingName . '"' );
 79+ }
 80+
 81+ return $settings[$settingName];
5082 }
5183
5284 }

Status & tagging log