wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-09-25 11:17:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename popups.eventLogging to popups.logger

Browse source 
...and eventLogging.logEvent to logger.log

Change-Id: I9af697a56c2248069a32ac586f5b78b55095460e
This commit is contained in:
Prateek Saxena 2015-03-19 14:49:39 +05:30
parent 13d3df306d
commit d49cfb9b65
3 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Popups.hooks.php
View file

@ -67,7 +67,7 @@ class PopupsHooks {
$rl->register( "ext.popups", array(
'scripts' => array(
'resources/ext.popups.core.js',
'resources/ext.popups.eventlogging.js',
'resources/ext.popups.logger.js',
'resources/ext.popups.renderer.js',
'resources/ext.popups.renderer.article.js',
'resources/ext.popups.disablenavpop.js',

48
resources/ext.popups.eventlogging.js → resources/ext.popups.logger.js
View file

@ -1,28 +1,28 @@
( function ( $, mw ) {
/**
* @class mw.popups.eventLogging
* @class mw.popups.logger
* @singleton
*/
var eventLogging = {};
var logger = {};
/**
* Unix timestamp of when the popup was rendered
* @property time
*/
eventLogging.time = undefined;
logger.time = undefined;
/**
* How long was the popup open in milliseconds
* @property {Number} duration
*/
eventLogging.duration = undefined;
logger.duration = undefined;
/**
* Was the popup clicked, middle clicked or dismissed
* @property {String} action
*/
eventLogging.action = undefined;
logger.action = undefined;
/**
* Logs different actions such as meta and shift click on the popup
@ -31,18 +31,18 @@
* @method logClick
* @param {Object} event
*/
eventLogging.logClick = function ( event ) {
logger.logClick = function ( event ) {
if ( event.which === 2 ) { // middle click
eventLogging.action = 'opened in new tab';
logger.action = 'opened in new tab';
} else if ( event.which === 1 ) {
if ( event.ctrlKey || event.metaKey ) {
eventLogging.action = 'opened in new tab';
logger.action = 'opened in new tab';
} else if ( event.shiftKey ) {
eventLogging.action = 'opened in new window';
logger.action = 'opened in new window';
} else {
eventLogging.action = 'opened in same tab';
eventLogging.duration = mw.now() - eventLogging.time;
eventLogging.logEvent( mw.popups.render.currentLink.attr( 'href' ) );
logger.action = 'opened in same tab';
logger.duration = mw.now() - logger.time;
logger.log( mw.popups.render.currentLink.attr( 'href' ) );
event.preventDefault();
}
}
@ -53,11 +53,11 @@
* https://meta.wikimedia.org/wiki/Schema:Popups
* If `href` is passed it redirects to that location after the event is logged.
*
* @method logEvent
* @method log
* @param {String} href
* @return {Boolean} logged Whether or not the event was logged
*/
eventLogging.logEvent = function ( href ) {
logger.log = function ( href ) {
if ( mw.eventLog === undefined ) {
return false;
}
@ -65,12 +65,12 @@
var
deferred = $.Deferred(),
event = {
'duration': Math.round( eventLogging.duration ),
'action': eventLogging.action
'duration': Math.round( logger.duration ),
'action': logger.action
};
if ( eventLogging.sessionId !== null ) {
event.sessionId = eventLogging.sessionId;
if ( logger.sessionId !== null ) {
event.sessionId = logger.sessionId;
}
if ( href ) {
@ -82,9 +82,9 @@
mw.eventLog.logEvent( 'Popups', event ).then( deferred.resolve, deferred.reject );
// reset
eventLogging.time = undefined;
eventLogging.duration = undefined;
eventLogging.action = undefined;
logger.time = undefined;
logger.duration = undefined;
logger.action = undefined;
return true;
};
@ -95,7 +95,7 @@
* @method getSessionsId
* @return {String} sessionId
*/
eventLogging.getSessionId = function () {
logger.getSessionId = function () {
var sessionId = null;
try {
sessionId = localStorage.getItem( 'popupsSessionId' );
@ -110,8 +110,8 @@
/**
* @property sessionId
*/
eventLogging.sessionId = eventLogging.getSessionId();
logger.sessionId = logger.getSessionId();
mw.popups.eventLogging = eventLogging;
mw.popups.logger = logger;
} ) ( jQuery, mediaWiki );

10
resources/ext.popups.renderer.js
View file

@ -153,9 +153,9 @@
cache.process( link );
// Event logging
mw.popups.eventLogging.time = mw.now();
mw.popups.eventLogging.action = 'dismissed';
mw.popups.$popup.find( 'a.mwe-popups-extract, a.mwe-popups-discreet' ).click( mw.popups.eventLogging.logClick );
mw.popups.logger.time = mw.now();
mw.popups.logger.action = 'dismissed';
mw.popups.$popup.find( 'a.mwe-popups-extract, a.mwe-popups-discreet' ).click( mw.popups.logger.logClick );
link
.off( 'mouseleave blur', mw.popups.render.leaveInactive )
@ -175,8 +175,8 @@
return false;
}
mw.popups.eventLogging.duration = mw.now() - mw.popups.eventLogging.time;
mw.popups.eventLogging.logEvent();
mw.popups.logger.duration = mw.now() - mw.popups.logger.time;
mw.popups.logger.log();
$( mw.popups.render.currentLink ).off( 'mouseleave blur', mw.popups.render.leaveActive );