mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-12-22 12:42:43 +00:00
348e6f6cc8
This commit introduces several changes to improve the structure and readability of the FeatureManagement code in the Vector skin. Key changes include: - In ABRequirementTest.php, improved test method names for clarity. - In ABRequirement.php, simplified property declarations and cleaned up code structure. - In DynamicConfigRequirement.php, cleaned up property declarations. - In LimitedWidthContentRequirement.php, cleaned up property declarations and added type hints. - In LoggedInRequirement.php, cleaned up property declarations. - In OverridableConfigRequirement.php, cleaned up property declarations. - In OverrideableRequirementHelper.php, cleaned up property declarations. - In SimpleRequirement.php, cleaned up property declarations. - In UserPreferenceRequirement.php, cleaned up property declarations. Each change aims to enhance the codebase's maintainability and understandability. No functional changes were introduced. Change-Id: I23283c5a6799b1f03a6a9b5832c34c7dbbcca527
76 lines
2.3 KiB
PHP
76 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
*/
|
|
|
|
namespace MediaWiki\Skins\Vector\FeatureManagement\Requirements;
|
|
|
|
use MediaWiki\Request\WebRequest;
|
|
|
|
/**
|
|
* The `OverridableConfigRequirement` allows us to define requirements that can override
|
|
* requirements with querystring parameters.
|
|
*
|
|
* NOTE: This API hasn't settled. It may change at any time without warning. Please don't bind to
|
|
* it unless you absolutely need to
|
|
*
|
|
* @package MediaWiki\Skins\Vector\FeatureManagement\Requirements
|
|
*/
|
|
class OverrideableRequirementHelper {
|
|
private WebRequest $request;
|
|
|
|
private string $requirementName;
|
|
|
|
private string $overrideName;
|
|
|
|
/**
|
|
* This constructor accepts all dependencies needed to determine whether
|
|
* the overridable config is enabled for the current user and request.
|
|
*
|
|
* @param WebRequest $request
|
|
* @param string $requirementName The name of the requirement presented to FeatureManager.
|
|
*/
|
|
public function __construct(
|
|
WebRequest $request,
|
|
string $requirementName
|
|
) {
|
|
$this->request = $request;
|
|
$this->overrideName = 'vector' . strtolower( $requirementName );
|
|
$this->requirementName = $requirementName;
|
|
}
|
|
|
|
/**
|
|
* Check query parameter to override config or not.
|
|
* Then check for AB test value.
|
|
* Fallback to config value.
|
|
*
|
|
* @return bool|null
|
|
*/
|
|
public function isMet(): ?bool {
|
|
// Check query parameter.
|
|
if ( $this->request->getCheck( $this->overrideName ) ) {
|
|
return $this->request->getBool( $this->overrideName );
|
|
}
|
|
$vectorReq = 'Vector' . $this->requirementName;
|
|
if ( $this->request->getCheck( $vectorReq ) ) {
|
|
return $this->request->getBool( $vectorReq );
|
|
}
|
|
return null;
|
|
}
|
|
}
|