sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve JSDoc for `wp-includes/js/media/controllers/gallery-add.js`. 

Props boblinthorst, bramheijmink, manuelaugustin, ireneyoast, igorsch, nataliashitova.
Fixes #43500.

git-svn-id: https://develop.svn.wordpress.org/trunk@42798 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2018-03-08 16:24:16 +00:00
parent 4933dff8c1
commit c6ecac6ad5
2 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/wp-includes/js/media/controllers/gallery-add.js
View File

@ -8,14 +8,16 @@ var Selection = wp.media.model.Selection,
* *
* A state for selecting more images to add to a gallery. * A state for selecting more images to add to a gallery.
* *
* @memberOf wp.media.controller * @since 3.5.0
* *
* @class * @class
* @augments wp.media.controller.Library * @augments wp.media.controller.Library
* @augments wp.media.controller.State * @augments wp.media.controller.State
* @augments Backbone.Model * @augments Backbone.Model
* *
* @param {object} [attributes] The attributes hash passed to the state. * @memberof wp.media.controller
*
* @param {Object} [attributes] The attributes hash passed to the state.
* @param {string} [attributes.id=gallery-library] Unique identifier. * @param {string} [attributes.id=gallery-library] Unique identifier.
* @param {string} [attributes.title=Add to Gallery] Title for the state. Displays in the frame's title region. * @param {string} [attributes.title=Add to Gallery] Title for the state. Displays in the frame's title region.
* @param {boolean} [attributes.multiple=add] Whether multi-select is enabled. @todo 'add' doesn't seem do anything special, and gets used as a boolean. * @param {boolean} [attributes.multiple=add] Whether multi-select is enabled. @todo 'add' doesn't seem do anything special, and gets used as a boolean.
@ -32,7 +34,7 @@ var Selection = wp.media.model.Selection,
* @param {boolean} [attributes.sortable=true] Whether the Attachments should be sortable. Depends on the orderby property being set to menuOrder on the attachments collection. * @param {boolean} [attributes.sortable=true] Whether the Attachments should be sortable. Depends on the orderby property being set to menuOrder on the attachments collection.
* @param {boolean} [attributes.autoSelect=true] Whether an uploaded attachment should be automatically added to the selection. * @param {boolean} [attributes.autoSelect=true] Whether an uploaded attachment should be automatically added to the selection.
* @param {boolean} [attributes.contentUserSetting=true] Whether the content region's mode should be set and persisted per user. * @param {boolean} [attributes.contentUserSetting=true] Whether the content region's mode should be set and persisted per user.
* @param {int} [attributes.priority=100] The priority for the state link in the media menu. * @param {number} [attributes.priority=100] The priority for the state link in the media menu.
* @param {boolean} [attributes.syncSelection=false] Whether the Attachments selection should be persisted from the last state. * @param {boolean} [attributes.syncSelection=false] Whether the Attachments selection should be persisted from the last state.
* Defaults to false because for this state, because the library of the Edit Gallery state is the selection. * Defaults to false because for this state, because the library of the Edit Gallery state is the selection.
*/ */
@ -49,10 +51,13 @@ GalleryAdd = Library.extend(/** @lends wp.media.controller.GalleryAdd.prototype
}, Library.prototype.defaults ), }, Library.prototype.defaults ),
/** /**
* Initializes the library. Creates a library of images if a library isn't supplied.
*
* @since 3.5.0 * @since 3.5.0
*
* @returns {void}
*/ */
initialize: function() { initialize: function() {
// If a library wasn't supplied, create a library of images.
if ( ! this.get('library') ) { if ( ! this.get('library') ) {
this.set( 'library', wp.media.query({ type: 'image' }) ); this.set( 'library', wp.media.query({ type: 'image' }) );
} }
@ -61,7 +66,14 @@ GalleryAdd = Library.extend(/** @lends wp.media.controller.GalleryAdd.prototype
}, },
/** /**
* Activates the library.
*
* Removes all event listeners if in edit mode. Creates a validator to check an attachment.
* Resets library and re-enables event listeners. Activates edit mode. Calls the parent's activate method.
*
* @since 3.5.0 * @since 3.5.0
*
* @returns {void}
*/ */
activate: function() { activate: function() {
var library = this.get('library'), var library = this.get('library'),
@ -71,15 +83,19 @@ GalleryAdd = Library.extend(/** @lends wp.media.controller.GalleryAdd.prototype
library.unobserve( this.editLibrary ); library.unobserve( this.editLibrary );
} }
// Accepts attachments that exist in the original library and /*
// that do not exist in gallery's library. * Accept attachments that exist in the original library but
* that do not exist in gallery's library yet.
*/
library.validator = function( attachment ) { library.validator = function( attachment ) {
return !! this.mirroring.get( attachment.cid ) && ! edit.get( attachment.cid ) && Selection.prototype.validator.apply( this, arguments ); return !! this.mirroring.get( attachment.cid ) && ! edit.get( attachment.cid ) && Selection.prototype.validator.apply( this, arguments );
}; };
// Reset the library to ensure that all attachments are re-added /*
// to the collection. Do so silently, as calling `observe` will * Reset the library to ensure that all attachments are re-added
// trigger the `reset` event. * to the collection. Do so silently, as calling `observe` will
* trigger the `reset` event.
*/
library.reset( library.mirroring.models, { silent: true }); library.reset( library.mirroring.models, { silent: true });
library.observe( edit ); library.observe( edit );
this.editLibrary = edit; this.editLibrary = edit;

8
src/wp-includes/js/media/controllers/gallery-edit.js
View File

@ -7,13 +7,15 @@ var Library = wp.media.controller.Library,
* *
* A state for editing a gallery's images and settings. * A state for editing a gallery's images and settings.
* *
* @memberOf wp.media.controller * @since 3.5.0
* *
* @class * @class
* @augments wp.media.controller.Library * @augments wp.media.controller.Library
* @augments wp.media.controller.State * @augments wp.media.controller.State
* @augments Backbone.Model * @augments Backbone.Model
* *
* @memberOf wp.media.controller
*
* @param {object} [attributes] The attributes hash passed to the state. * @param {object} [attributes] The attributes hash passed to the state.
* @param {string} [attributes.id=gallery-edit] Unique identifier. * @param {string} [attributes.id=gallery-edit] Unique identifier.
* @param {string} [attributes.title=Edit Gallery] Title for the state. Displays in the frame's title region. * @param {string} [attributes.title=Edit Gallery] Title for the state. Displays in the frame's title region.
@ -28,9 +30,9 @@ var Library = wp.media.controller.Library,
* @param {boolean} [attributes.describe=true] Whether to offer UI to describe attachments - e.g. captioning images in a gallery. * @param {boolean} [attributes.describe=true] Whether to offer UI to describe attachments - e.g. captioning images in a gallery.
* @param {boolean} [attributes.displaySettings=true] Whether to show the attachment display settings interface. * @param {boolean} [attributes.displaySettings=true] Whether to show the attachment display settings interface.
* @param {boolean} [attributes.dragInfo=true] Whether to show instructional text about the attachments being sortable. * @param {boolean} [attributes.dragInfo=true] Whether to show instructional text about the attachments being sortable.
* @param {int} [attributes.idealColumnWidth=170] The ideal column width in pixels for attachments. * @param {number} [attributes.idealColumnWidth=170] The ideal column width in pixels for attachments.
* @param {boolean} [attributes.editing=false] Whether the gallery is being created, or editing an existing instance. * @param {boolean} [attributes.editing=false] Whether the gallery is being created, or editing an existing instance.
* @param {int} [attributes.priority=60] The priority for the state link in the media menu. * @param {number} [attributes.priority=60] The priority for the state link in the media menu.
* @param {boolean} [attributes.syncSelection=false] Whether the Attachments selection should be persisted from the last state. * @param {boolean} [attributes.syncSelection=false] Whether the Attachments selection should be persisted from the last state.
* Defaults to false for this state, because the library passed in *is* the selection. * Defaults to false for this state, because the library passed in *is* the selection.
* @param {view} [attributes.AttachmentView] The single `Attachment` view to be used in the `Attachments`. * @param {view} [attributes.AttachmentView] The single `Attachment` view to be used in the `Attachments`.