From fb161c774c316977be047d140b72eb8c8ea4996f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Sat, 16 Nov 2013 14:22:54 +0100 Subject: [PATCH] mediawiki.Title: Add 'params' parameter to #getUrl Same as the parameter to mw.util.getUrl(). Also prettify the docs there. Change-Id: I94489e7d526d69126f3e90b7f41e2ec0430f7f66 --- resources/mediawiki/mediawiki.Title.js | 6 ++++-- resources/mediawiki/mediawiki.util.js | 4 ++-- .../suites/resources/mediawiki/mediawiki.Title.test.js | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/resources/mediawiki/mediawiki.Title.js b/resources/mediawiki/mediawiki.Title.js index dde5abff68..481b792b55 100644 --- a/resources/mediawiki/mediawiki.Title.js +++ b/resources/mediawiki/mediawiki.Title.js @@ -550,10 +550,12 @@ * Get the URL to this title * * @see mw.util#getUrl + * @param {Object} [params] A mapping of query parameter names to values, + * e.g. `{ action: 'edit' }`. * @return {string} */ - getUrl: function () { - return mw.util.getUrl( this.toString() ); + getUrl: function ( params ) { + return mw.util.getUrl( this.toString(), params ); }, /** diff --git a/resources/mediawiki/mediawiki.util.js b/resources/mediawiki/mediawiki.util.js index a057ccea3c..86f06b8fe3 100644 --- a/resources/mediawiki/mediawiki.util.js +++ b/resources/mediawiki/mediawiki.util.js @@ -164,8 +164,8 @@ * Get the link to a page name (relative to `wgServer`), * * @param {string} str Page name to get the link for. - * @param {Object} params A mapping of query parameter names to values, - * e.g. { action: 'edit' }. Optional. + * @param {Object} [params] A mapping of query parameter names to values, + * e.g. `{ action: 'edit' }`. * @return {string} Location for a page with name of `str` or boolean false on error. */ getUrl: function ( str, params ) { diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js index f0bb0fccc6..2556cde50a 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js @@ -317,14 +317,15 @@ } ); - QUnit.test( 'getUrl', 2, function ( assert ) { + QUnit.test( 'getUrl', 3, function ( assert ) { var title; // Config mw.config.set( 'wgArticlePath', '/wiki/$1' ); title = new mw.Title( 'Foobar' ); - assert.equal( title.getUrl(), '/wiki/Foobar', 'Basic functionally, getUrl uses mw.util.getUrl' ); + assert.equal( title.getUrl(), '/wiki/Foobar', 'Basic functionality, getUrl uses mw.util.getUrl' ); + assert.equal( title.getUrl({ action: 'edit' }), '/wiki/Foobar?action=edit', 'Basic functionality, \'params\' parameter' ); title = new mw.Title( 'John Doe', 3 ); assert.equal( title.getUrl(), '/wiki/User_talk:John_Doe', 'Escaping in title and namespace for urls' ); -- 2.20.1