Page MenuHomeWickedGov Phorge
Files F2752566

Hooks.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

Hooks.php
View Options

<?php
namespace GlobalPreferences;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Output\Hook\BeforePageDisplayHook;
use MediaWiki\Output\OutputPage;
use MediaWiki\Preferences\Hook\PreferencesFormPreSaveHook;
use MediaWiki\Preferences\PreferencesFactory;
use MediaWiki\User\Options\Hook\SaveUserOptionsHook;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\User\Options\UserOptionsManager;
use MediaWiki\User\User;
use MediaWiki\User\UserIdentity;
use Skin;
class Hooks implements
BeforePageDisplayHook,
SaveUserOptionsHook,
PreferencesFormPreSaveHook
{
/** @var GlobalPreferencesFactory */
private $preferencesFactory;
/** @var UserOptionsManager */
private $userOptionsManager;
/**
* @param PreferencesFactory $preferencesFactory
* @param UserOptionsManager $userOptionsManager
*/
public function __construct(
PreferencesFactory $preferencesFactory,
UserOptionsManager $userOptionsManager
) {
$this->preferencesFactory = $preferencesFactory;
$this->userOptionsManager = $userOptionsManager;
}
/**
* Allows last minute changes to the output page, e.g. adding of CSS or JavaScript by extensions.
* @link https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay
* @param OutputPage $out The output page.
* @param Skin $skin The skin. Not used.
*/
public function onBeforePageDisplay( $out, $skin ): void {
if ( $out->getTitle()->isSpecial( 'Preferences' ) ) {
// Add module styles and scripts separately
// so non-JS users get the styles quicker and to avoid a FOUC.
$out->addModuleStyles( 'ext.GlobalPreferences.local-nojs' );
$out->addModules( 'ext.GlobalPreferences.local' );
}
}
/**
* When saving a user's options, remove any global ones and never save any on the Global
* Preferences page. Global options are saved separately, in the PreferencesFormPreSave hook.
*
* @see https://www.mediawiki.org/wiki/Manual:Hooks/SaveUserOptions
* @param UserIdentity $user The user.
* @param string[] &$modifiedOptions The user's options that were modified.
* @param string[] $originalOptions The original options.
* @return bool False if nothing changed, true otherwise.
*/
public function onSaveUserOptions( UserIdentity $user, array &$modifiedOptions, array $originalOptions ) {
if ( $this->preferencesFactory->onGlobalPrefsPage() ) {
// It shouldn't be possible to save local options here,
// but never save on this page anyways.
return false;
}
$this->preferencesFactory->handleLocalPreferencesChange( $user, $modifiedOptions, $originalOptions );
return true;
}
/**
* @link https://www.mediawiki.org/wiki/Manual:Hooks/PreferencesFormPreSave
* @param array $formData An associative array containing the data from the preferences form.
* @param HTMLForm $form The HTMLForm object that represents the preferences form.
* @param User $user The User object that can be used to change the user's preferences.
* @param bool &$result The boolean return value of the Preferences::tryFormSubmit method.
* @param array $oldUserOptions Array with user's old options (before save)
* @return bool|void True or no return value to continue or false to abort
*/
public function onPreferencesFormPreSave( $formData, $form, $user, &$result, $oldUserOptions ) {
if ( !$this->preferencesFactory->onGlobalPrefsPage( $form ) ) {
return $this->localPreferencesFormPreSave( $formData, $user );
}
return true;
}
/**
* Process PreferencesFormPreSave for Special:Preferences
* Handles CheckMatrix
*
* @param array $formData Associative array of [ preference name => value ]
* @param User $user Current user
* @return bool Hook return value
*/
private function localPreferencesFormPreSave( array $formData, User $user ): bool {
foreach ( $formData as $pref => $value ) {
if ( !GlobalPreferencesFactory::isLocalPrefName( $pref ) ) {
continue;
}
// Determine the real name of the preference.
$suffixLen = strlen( UserOptionsLookup::LOCAL_EXCEPTION_SUFFIX );
$realName = substr( $pref, 0, -$suffixLen );
if ( isset( $formData[$realName] ) ) {
// Not a CheckMatrix field
continue;
}
$checkMatrix = preg_grep( "/^$realName-/", array_keys( $formData ) );
foreach ( $checkMatrix as $check ) {
$localExceptionName = $check . UserOptionsLookup::LOCAL_EXCEPTION_SUFFIX;
$this->userOptionsManager->setOption( $user, $localExceptionName, $value );
}
}
return true;
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 20:09 (1 d, 12 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
da/18/50223d8a912463819ac78487c980
Default Alt Text
Hooks.php (4 KB)

Event Timeline