<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[43355] trunk/src/js/_enqueues/lib/auth-check.js: Docs: Improve JSDoc for `auth-check.js`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/43355">43355</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/43355","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-06-16 10:28:56 +0000 (Sat, 16 Jun 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve JSDoc for `auth-check.js`.
Props pskli.
Fixes <a href="https://core.trac.wordpress.org/ticket/44364">#44364</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueslibauthcheckjs">trunk/src/js/_enqueues/lib/auth-check.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueslibauthcheckjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/lib/auth-check.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/lib/auth-check.js 2018-06-16 10:26:06 UTC (rev 43354)
+++ trunk/src/js/_enqueues/lib/auth-check.js 2018-06-16 10:28:56 UTC (rev 43355)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> (function($){
</span><span class="cx" style="display: block; padding: 0 10px"> var wrap, next;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Shows the authentication form popup.
+ *
+ * @since 3.6.0
+ * @private
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function show() {
</span><span class="cx" style="display: block; padding: 0 10px"> var parent = $('#wp-auth-check'),
</span><span class="cx" style="display: block; padding: 0 10px"> form = $('#wp-auth-check-form'),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,7 +21,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> frame, loaded = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( form.length ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Add unload confirmation to counter (frame-busting) JS redirects
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add unload confirmation to counter (frame-busting) JS redirects.
</ins><span class="cx" style="display: block; padding: 0 10px"> $(window).on( 'beforeunload.wp-auth-check', function(e) {
</span><span class="cx" style="display: block; padding: 0 10px"> e.originalEvent.returnValue = window.authcheckL10n.beforeunload;
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,7 +51,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> parent.css( 'max-height', height + 40 + 'px' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else if ( ! body || ! body.length ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Catch "silent" iframe origin exceptions in WebKit after another page is loaded in the iframe
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Catch "silent" iframe origin exceptions in WebKit after another page is
+ // loaded in the iframe.
</ins><span class="cx" style="display: block; padding: 0 10px"> wrap.addClass('fallback');
</span><span class="cx" style="display: block; padding: 0 10px"> parent.css( 'max-height', '' );
</span><span class="cx" style="display: block; padding: 0 10px"> form.remove();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,7 +68,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( frame ) {
</span><span class="cx" style="display: block; padding: 0 10px"> frame.focus();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // WebKit doesn't throw an error if the iframe fails to load because of "X-Frame-Options: DENY" header.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // WebKit doesn't throw an error if the iframe fails to load because of
+ // "X-Frame-Options: DENY" header.
</ins><span class="cx" style="display: block; padding: 0 10px"> // Wait for 10 sec. and switch to the fallback text.
</span><span class="cx" style="display: block; padding: 0 10px"> setTimeout( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! loaded ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,10 +83,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Hides the authentication form popup.
+ *
+ * @since 3.6.0
+ * @private
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function hide() {
</span><span class="cx" style="display: block; padding: 0 10px"> $(window).off( 'beforeunload.wp-auth-check' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // When on the Edit Post screen, speed up heartbeat after the user logs in to quickly refresh nonces
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // When on the Edit Post screen, speed up heartbeat after the user logs in to
+ // quickly refresh nonces.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( typeof adminpage !== 'undefined' && ( adminpage === 'post-php' || adminpage === 'post-new-php' ) &&
</span><span class="cx" style="display: block; padding: 0 10px"> typeof wp !== 'undefined' && wp.heartbeat ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,11 +108,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Schedules when the next time the authentication check will be done.
+ *
+ * @since 3.6.0
+ * @private
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function schedule() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var interval = parseInt( window.authcheckL10n.interval, 10 ) || 180; // in seconds, default 3 min.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // In seconds, default 3 min.
+ var interval = parseInt( window.authcheckL10n.interval, 10 ) || 180;
</ins><span class="cx" style="display: block; padding: 0 10px"> next = ( new Date() ).getTime() + ( interval * 1000 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Binds to the Heartbeat Tick event.
+ *
+ * - Shows the authentication form popup if user is not logged in.
+ * - Hides the authentication form popup if it is already visible and user is
+ * logged in.
+ *
+ * @ignore
+ *
+ * @since 3.6.0
+ *
+ * @param {Object} e The heartbeat-tick event that has been triggered.
+ * @param {Object} data Response data.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( document ).on( 'heartbeat-tick.wp-auth-check', function( e, data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'wp-auth-check' in data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> schedule();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,12 +143,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> hide();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Binds to the Heartbeat Send event.
+ *
+ * @ignore
+ *
+ * @since 3.6.0
+ *
+ * @param {Object} e The heartbeat-send event that has been triggered.
+ * @param {Object} data Response data.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> }).on( 'heartbeat-send.wp-auth-check', function( e, data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ( new Date() ).getTime() > next ) {
</span><span class="cx" style="display: block; padding: 0 10px"> data['wp-auth-check'] = true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> }).ready( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> schedule();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Hides the authentication form popup when the close icon is clicked.
+ *
+ * @ignore
+ *
+ * @since 3.6.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> wrap = $('#wp-auth-check-wrap');
</span><span class="cx" style="display: block; padding: 0 10px"> wrap.find('.wp-auth-check-close').on( 'click', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> hide();
</span></span></pre>
</div>
</div>
</body>
</html>