mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-31 01:59:47 +02:00
* The way that the JS modules for media are currently set up turns the existing global `wp.media` namespace into a read-only API, this is bad. * For the existing module implementation to work with plugins, those looking to override or extend a class would have to modify their own plugin to use `browserify` - we can't expect this to happen * Because the general way that plugins override media classes is via machete (resetting them to something else), we cannot use `require( 'module' )` in the internal code for media modules We CAN continue to use `require( 'fun/js' )` in the manifests for media. Future code/projects should carefully consider what is made to be public API. In 3.5, EVERYTHING was made public, so everything shall remain public. See #31684, #28510. Built from https://develop.svn.wordpress.org/trunk@31935 git-svn-id: http://core.svn.wordpress.org/trunk@31914 1a063a9b-81f0-0310-95a4-ce76da25c4cd
161 lines
6.4 KiB
JavaScript
161 lines
6.4 KiB
JavaScript
/*globals wp, Backbone */
|
|
|
|
/**
|
|
* wp.media.controller.CollectionEdit
|
|
*
|
|
* A state for editing a collection, which is used by audio and video playlists,
|
|
* and can be used for other collections.
|
|
*
|
|
* @class
|
|
* @augments wp.media.controller.Library
|
|
* @augments wp.media.controller.State
|
|
* @augments Backbone.Model
|
|
*
|
|
* @param {object} [attributes] The attributes hash passed to the state.
|
|
* @param {string} attributes.title Title for the state. Displays in the media menu and the frame's title region.
|
|
* @param {wp.media.model.Attachments} [attributes.library] The attachments collection to edit.
|
|
* If one is not supplied, an empty media.model.Selection collection is created.
|
|
* @param {boolean} [attributes.multiple=false] Whether multi-select is enabled.
|
|
* @param {string} [attributes.content=browse] Initial mode for the content region.
|
|
* @param {string} attributes.menu Initial mode for the menu region. @todo this needs a better explanation.
|
|
* @param {boolean} [attributes.searchable=false] Whether the library is searchable.
|
|
* @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.describe=true] Whether to offer UI to describe the attachments - e.g. captioning images in a gallery.
|
|
* @param {boolean} [attributes.dragInfo=true] Whether to show instructional text about the attachments being sortable.
|
|
* @param {boolean} [attributes.dragInfoText] Instructional text about the attachments being sortable.
|
|
* @param {int} [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 {int} [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.
|
|
* Defaults to false for this state, because the library passed in *is* the selection.
|
|
* @param {view} [attributes.SettingsView] The view to edit the collection instance settings (e.g. Playlist settings with "Show tracklist" checkbox).
|
|
* @param {view} [attributes.AttachmentView] The single `Attachment` view to be used in the `Attachments`.
|
|
* If none supplied, defaults to wp.media.view.Attachment.EditLibrary.
|
|
* @param {string} attributes.type The collection's media type. (e.g. 'video').
|
|
* @param {string} attributes.collectionType The collection type. (e.g. 'playlist').
|
|
*/
|
|
var Library = wp.media.controller.Library,
|
|
l10n = wp.media.view.l10n,
|
|
$ = jQuery,
|
|
CollectionEdit;
|
|
|
|
CollectionEdit = Library.extend({
|
|
defaults: {
|
|
multiple: false,
|
|
sortable: true,
|
|
searchable: false,
|
|
content: 'browse',
|
|
describe: true,
|
|
dragInfo: true,
|
|
idealColumnWidth: 170,
|
|
editing: false,
|
|
priority: 60,
|
|
SettingsView: false,
|
|
syncSelection: false
|
|
},
|
|
|
|
/**
|
|
* @since 3.9.0
|
|
*/
|
|
initialize: function() {
|
|
var collectionType = this.get('collectionType');
|
|
|
|
if ( 'video' === this.get( 'type' ) ) {
|
|
collectionType = 'video-' + collectionType;
|
|
}
|
|
|
|
this.set( 'id', collectionType + '-edit' );
|
|
this.set( 'toolbar', collectionType + '-edit' );
|
|
|
|
// If we haven't been provided a `library`, create a `Selection`.
|
|
if ( ! this.get('library') ) {
|
|
this.set( 'library', new wp.media.model.Selection() );
|
|
}
|
|
// The single `Attachment` view to be used in the `Attachments` view.
|
|
if ( ! this.get('AttachmentView') ) {
|
|
this.set( 'AttachmentView', wp.media.view.Attachment.EditLibrary );
|
|
}
|
|
Library.prototype.initialize.apply( this, arguments );
|
|
},
|
|
|
|
/**
|
|
* @since 3.9.0
|
|
*/
|
|
activate: function() {
|
|
var library = this.get('library');
|
|
|
|
// Limit the library to images only.
|
|
library.props.set( 'type', this.get( 'type' ) );
|
|
|
|
// Watch for uploaded attachments.
|
|
this.get('library').observe( wp.Uploader.queue );
|
|
|
|
this.frame.on( 'content:render:browse', this.renderSettings, this );
|
|
|
|
Library.prototype.activate.apply( this, arguments );
|
|
},
|
|
|
|
/**
|
|
* @since 3.9.0
|
|
*/
|
|
deactivate: function() {
|
|
// Stop watching for uploaded attachments.
|
|
this.get('library').unobserve( wp.Uploader.queue );
|
|
|
|
this.frame.off( 'content:render:browse', this.renderSettings, this );
|
|
|
|
Library.prototype.deactivate.apply( this, arguments );
|
|
},
|
|
|
|
/**
|
|
* Render the collection embed settings view in the browser sidebar.
|
|
*
|
|
* @todo This is against the pattern elsewhere in media. Typically the frame
|
|
* is responsible for adding region mode callbacks. Explain.
|
|
*
|
|
* @since 3.9.0
|
|
*
|
|
* @param {wp.media.view.attachmentsBrowser} The attachments browser view.
|
|
*/
|
|
renderSettings: function( attachmentsBrowserView ) {
|
|
var library = this.get('library'),
|
|
collectionType = this.get('collectionType'),
|
|
dragInfoText = this.get('dragInfoText'),
|
|
SettingsView = this.get('SettingsView'),
|
|
obj = {};
|
|
|
|
if ( ! library || ! attachmentsBrowserView ) {
|
|
return;
|
|
}
|
|
|
|
library[ collectionType ] = library[ collectionType ] || new Backbone.Model();
|
|
|
|
obj[ collectionType ] = new SettingsView({
|
|
controller: this,
|
|
model: library[ collectionType ],
|
|
priority: 40
|
|
});
|
|
|
|
attachmentsBrowserView.sidebar.set( obj );
|
|
|
|
if ( dragInfoText ) {
|
|
attachmentsBrowserView.toolbar.set( 'dragInfo', new wp.media.View({
|
|
el: $( '<div class="instructions">' + dragInfoText + '</div>' )[0],
|
|
priority: -40
|
|
}) );
|
|
}
|
|
|
|
// Add the 'Reverse order' button to the toolbar.
|
|
attachmentsBrowserView.toolbar.set( 'reverse', {
|
|
text: l10n.reverseOrder,
|
|
priority: 80,
|
|
|
|
click: function() {
|
|
library.reset( library.toArray().reverse() );
|
|
}
|
|
});
|
|
}
|
|
});
|
|
|
|
module.exports = CollectionEdit;
|