Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Skin: Allow using link-class when class is an array

Browse source 
When creating a link with Skin::makeLink and specifying the
link-class option, makeLink blindly assumes the class attribute
it is given to be a string and will concat the value of link-class
to it, even when it is an array. PHP's type juggling will coerce
the array into a string and throw a notice.

Reproducable test case:

$link = [
	'text' => 'Link text',
	'href' => 'example.com',
	'class' => [ 'class1', 'class2' ]
];
$options = [
	'link-class' => 'link-class'
];

$skin->makeLink( 'test', $link, $options );

Change-Id: I6381e3e8893e4992dbed33c88674a5cf4367314f
This commit is contained in:
mainframe98 2020-11-15 17:34:01 +01:00
parent 5c932b2029
commit a5a8f46958
2 changed files with 48 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
includes/skins/Skin.php
View file

@ -2248,6 +2248,9 @@ abstract class Skin extends ContextSource {
* will render as element properties:
* data-foo='1' data-bar='baz'
*
* The "class" key currently accepts both a string and an array of classes, but this will be
* changed to only accept an array in the future.
*
* @param array $options Can be used to affect the output of a link.
* Possible options are:
* - 'text-wrapper' key to specify a list of elements to wrap the text of
@ -2327,7 +2330,12 @@ abstract class Skin extends ContextSource {
}
if ( isset( $options['link-class'] ) ) {
if ( isset( $attrs['class'] ) ) {
$attrs['class'] .= " {$options['link-class']}";
// In the future, this should accept an array of classes, not a string
if ( is_array( $attrs['class'] ) ) {
$attrs['class'][] = $options['link-class'];
} else {
$attrs['class'] .= " {$options['link-class']}";
}
} else {
$attrs['class'] = $options['link-class'];
}
@ -2348,7 +2356,9 @@ abstract class Skin extends ContextSource {
* @param array $item Array of list item data containing some of a specific set of keys.
* The "id", "class" and "itemtitle" keys will be used as attributes for the list item,
* if "active" contains a value of true a "active" class will also be appended to class.
* @phan-param array{id?:string,class?:string,itemtitle?:string,active?:bool} $item
* The "class" key currently accepts both a string and an array of classes, but this will be
* changed to only accept an array in the future.
* @phan-param array{id?:string,class?:string|string[],itemtitle?:string,active?:bool} $item
*
* @param array $options
* @phan-param array{tag?:string} $options
@ -2414,8 +2424,14 @@ abstract class Skin extends ContextSource {
if ( !isset( $attrs['class'] ) ) {
$attrs['class'] = '';
}
$attrs['class'] .= ' active';
$attrs['class'] = trim( $attrs['class'] );
// In the future, this should accept an array of classes, not a string
if ( is_array( $attrs['class'] ) ) {
$attrs['class'][] = 'active';
} else {
$attrs['class'] .= ' active';
$attrs['class'] = trim( $attrs['class'] );
}
}
if ( isset( $item['itemtitle'] ) ) {
$attrs['title'] = $item['itemtitle'];

28
tests/phpunit/includes/skins/SkinTest.php
View file

@ -49,4 +49,32 @@ class SkinTest extends MediaWikiIntegrationTestCase {
true
];
}
/**
* @covers Skin::makeLink
*/
public function testMakeLinkLinkClass() {
$skin = new class extends Skin {
public function outputPage() {
}
};
$link = $skin->makeLink(
'test',
[
'text' => 'Test',
'href' => '',
'class' => [
'class1',
'class2'
]
],
[ 'link-class' => 'link-class' ]
);
$this->assertHTMLEquals(
'<a href="" class="class1 class2 link-class">Test</a>',
$link
);
}
}