public $mLangObj;
Actual:
public $mFlags; public $mDescCodeSep = ':', $mDescVarSep = ';'; public $mUcfirst = false; public $mConvRuleTitle = false; public $mURLVariant; public $mUserVariant; public $mHeaderVariant; public $mMaxDepth = 10; public $mVarSeparatorPattern;
Expected:
protected $mFlags;
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| languages: Decrease visibility of public variables in LanguageConverter class | mediawiki/core | master | +57 -24 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Peter.ovchyn | T243461 Decrease visibility of public variables in LanguageConverter class | |||
| Open | roman-stolar | T243910 Refactor ConverterRule not to use public variables from LanguageConverter and remove mutual dependency between them |
This definitely seems like a good idea. The trick is making sure that nothing relies on these fields. We don't have a formal deprecation process for reducing visibility, but it's technically removing something from the public interface, so care should be taken.
I see two attempts to normalize property deprecation:
And none is really used widely. Why?
Looks like DeprecationHelper is more or less good for that.
What if we use it here?
Moreover, I'd improve it a bit in order to provide a better strategy of deprecation as separate ticket:
I see the following cases:
public function __get( string $name ) {
if ( $name == "mConverter" ) {
wfDeprecated( 'mConverter', '1.35' );
return $this->getConverter();
}
throw new RuntimeException( "Cannot get '$name' property." );
}Ah, good find! I was actually looking for DeprecationHelper the other day, and didn't remember the name. Yes, it's a good fit for this used case. It's not used much because on the one hand, few people know about it. On the other hand, it's never used for long - any use should be removed after one release.
I don't think use case (1) exist. When we don't ant direct writes, we don't want direct reads either.
Change 568505 had a related patch set uploaded (by Peter.ovchyn; owner: Peter.ovchyn):
[mediawiki/core@master] languages: Decrease visibility of public variables in LanguageConverter class
A couple of variables has left unchanged:
public $mFlags; // Used in ConverterRule public $mDescCodeSep = ':'; // Used in ConverterRule, descendants public $mDescVarSep = ';'; // Used in ConverterRule, descendants public $mVariantNames; // Used in ConverterRule public $mVariants; // Used in ConverterRule
In order to make them non-public, ConverterRule should be refactored.
I created a task on that.
Change 568505 merged by jenkins-bot:
[mediawiki/core@master] languages: Decrease visibility of public variables in LanguageConverter class