WordPress/wp-admin/js/media.js
atimmer f6a37e7d39 Docs: Remove @summary tags from JSDoc.
As decided in the JavaScript core chat. With a few reasons:

* It is visually cleaner when reading the source.
* This bring the JavaScript documentation closer to the PHP documentation.

The only disadvantage is that the JSDoc parser doesn't split out the summary and the description in the new format. We've decided to solve this when building the JavaScript documentation parser.

Props herregroen.
Fixes #42901.

Built from https://develop.svn.wordpress.org/trunk@42411


git-svn-id: http://core.svn.wordpress.org/trunk@42240 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-12-18 14:14:53 +00:00

208 lines
5.1 KiB
JavaScript

/* global ajaxurl, attachMediaBoxL10n, _wpMediaGridSettings, showNotice */
/**
* Creates a dialog containing posts that can have a particular media attached
* to it.
*
* @since 2.7.0
*
* @namespace findPosts
*
* @requires jQuery
*/
var findPosts;
( function( $ ){
findPosts = {
/**
* Opens a dialog to attach media to a post.
*
* Adds an overlay prior to retrieving a list of posts to attach the media to.
*
* @since 2.7.0
*
* @memberOf findPosts
*
* @param {string} af_name The name of the affected element.
* @param {string} af_val The value of the affected post element.
*
* @returns {boolean} Always returns false.
*/
open: function( af_name, af_val ) {
var overlay = $( '.ui-find-overlay' );
if ( overlay.length === 0 ) {
$( 'body' ).append( '<div class="ui-find-overlay"></div>' );
findPosts.overlay();
}
overlay.show();
if ( af_name && af_val ) {
// #affected is a hidden input field in the dialog that keeps track of which media should be attached.
$( '#affected' ).attr( 'name', af_name ).val( af_val );
}
$( '#find-posts' ).show();
// Close the dialog when the escape key is pressed.
$('#find-posts-input').focus().keyup( function( event ){
if ( event.which == 27 ) {
findPosts.close();
}
});
// Retrieves a list of applicable posts for media attachment and shows them.
findPosts.send();
return false;
},
/**
* Clears the found posts lists before hiding the attach media dialog.
*
* @since 2.7.0
*
* @memberOf findPosts
*
* @returns {void}
*/
close: function() {
$('#find-posts-response').empty();
$('#find-posts').hide();
$( '.ui-find-overlay' ).hide();
},
/**
* Binds a click event listener to the overlay which closes the attach media
* dialog.
*
* @since 3.5.0
*
* @memberOf findPosts
*
* @returns {void}
*/
overlay: function() {
$( '.ui-find-overlay' ).on( 'click', function () {
findPosts.close();
});
},
/**
* Retrieves and displays posts based on the search term.
*
* Sends a post request to the admin_ajax.php, requesting posts based on the
* search term provided by the user. Defaults to all posts if no search term is
* provided.
*
* @since 2.7.0
*
* @memberOf findPosts
*
* @returns {void}
*/
send: function() {
var post = {
ps: $( '#find-posts-input' ).val(),
action: 'find_posts',
_ajax_nonce: $('#_ajax_nonce').val()
},
spinner = $( '.find-box-search .spinner' );
spinner.addClass( 'is-active' );
/**
* Send a POST request to admin_ajax.php, hide the spinner and replace the list
* of posts with the response data. If an error occurs, display it.
*/
$.ajax( ajaxurl, {
type: 'POST',
data: post,
dataType: 'json'
}).always( function() {
spinner.removeClass( 'is-active' );
}).done( function( x ) {
if ( ! x.success ) {
$( '#find-posts-response' ).text( attachMediaBoxL10n.error );
}
$( '#find-posts-response' ).html( x.data );
}).fail( function() {
$( '#find-posts-response' ).text( attachMediaBoxL10n.error );
});
}
};
/**
* Initializes the file once the DOM is fully loaded and attaches events to the
* various form elements.
*
* @returns {void}
*/
$( document ).ready( function() {
var settings, $mediaGridWrap = $( '#wp-media-grid' );
// Opens a manage media frame into the grid.
if ( $mediaGridWrap.length && window.wp && window.wp.media ) {
settings = _wpMediaGridSettings;
window.wp.media({
frame: 'manage',
container: $mediaGridWrap,
library: settings.queryVars
}).open();
}
// Prevents form submission if no post has been selected.
$( '#find-posts-submit' ).click( function( event ) {
if ( ! $( '#find-posts-response input[type="radio"]:checked' ).length )
event.preventDefault();
});
// Submits the search query when hitting the enter key in the search input.
$( '#find-posts .find-box-search :input' ).keypress( function( event ) {
if ( 13 == event.which ) {
findPosts.send();
return false;
}
});
// Binds the click event to the search button.
$( '#find-posts-search' ).click( findPosts.send );
// Binds the close dialog click event.
$( '#find-posts-close' ).click( findPosts.close );
// Binds the bulk action events to the submit buttons.
$( '#doaction, #doaction2' ).click( function( event ) {
/*
* Retrieves all select elements for bulk actions that have a name starting with `action`
* and handle its action based on its value.
*/
$( 'select[name^="action"]' ).each( function() {
var optionValue = $( this ).val();
if ( 'attach' === optionValue ) {
event.preventDefault();
findPosts.open();
} else if ( 'delete' === optionValue ) {
if ( ! showNotice.warn() ) {
event.preventDefault();
}
}
});
});
/**
* Enables clicking on the entire table row.
*
* @returns {void}
*/
$( '.find-box-inside' ).on( 'click', 'tr', function() {
$( this ).find( '.found-radio input' ).prop( 'checked', true );
});
});
})( jQuery );