<!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>[27212] trunk/src/wp-includes/js/media-editor.js: Add an abstraction of the gallery code in `media-editor.js` called `wp.media.collection`.</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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27212">27212</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-02-20 18:06:31 +0000 (Thu, 20 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add an abstraction of the gallery code in `media-editor.js` called `wp.media.collection`. This will be the basis for parsing `[gallery]`-like shortcodes in the media editor (thing playlists, collections of PDFs, etc).
There are currently no instances of this. Those will be forthcoming.
See <a href="http://core.trac.wordpress.org/ticket/26631">#26631</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjsmediaeditorjs">trunk/src/wp-includes/js/media-editor.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjsmediaeditorjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/media-editor.js (27211 => 27212)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/media-editor.js 2014-02-20 17:58:42 UTC (rev 27211)
+++ trunk/src/wp-includes/js/media-editor.js 2014-02-20 18:06:31 UTC (rev 27212)
</span><span class="lines">@@ -275,6 +275,269 @@
</span><span class="cx"> };
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * wp.media.collection
+ * @namespace
+ */
+ wp.media.collection = {
+ attachments : function ( prop, type ) {
+ /**
+ * Retrieve attachments based on the properties of the passed shortcode
+ *
+ * @global wp.media.query
+ *
+ * @param {wp.shortcode} shortcode An instance of wp.shortcode().
+ * @returns {wp.media.model.Attachments} A Backbone.Collection containing
+ * the media items belonging to a collection.
+ * The 'prop' specified by the passed prop is a Backbone.Model
+ * containing the 'props' for the gallery.
+ */
+ return function( shortcode ) {
+ var shortcodeString = shortcode.string(),
+ result = cache[ shortcodeString ],
+ attrs, args, query, others;
+
+ delete cache[ shortcodeString ];
+
+ if ( result ) {
+ return result;
+ }
+
+ // Fill the default shortcode attributes.
+ attrs = _.defaults( shortcode.attrs.named, this.defaults );
+ args = _.pick( attrs, 'orderby', 'order' );
+
+ args.type = type;
+ args.perPage = -1;
+
+ // Mark the `orderby` override attribute.
+ if ( undefined !== attrs.orderby ) {
+ attrs._orderByField = attrs.orderby;
+ }
+
+ if ( 'rand' === attrs.orderby ) {
+ attrs._orderbyRandom = true;
+ }
+
+ if ( -1 !== jQuery.inArray( prop, ['playlist', 'video-playlist'] ) ) {
+ _.each(['tracknumbers', 'tracklist', 'images'], function (setting) {
+ if ( 'undefined' === typeof attrs[setting] ) {
+ attrs['_' + setting] = wp.media[ prop ].defaults[ setting ];
+ } else if ( 'true' === attrs[setting] || true === attrs[setting] ) {
+ attrs['_' + setting] = true;
+ }
+ });
+ }
+
+ // Map the `orderby` attribute to the corresponding model property.
+ if ( ! attrs.orderby || /^menu_order(?: ID)?$/i.test( attrs.orderby ) ) {
+ args.orderby = 'menuOrder';
+ }
+
+ // Map the `ids` param to the correct query args.
+ if ( attrs.ids ) {
+ args.post__in = attrs.ids.split(',');
+ args.orderby = 'post__in';
+ } else if ( attrs.include ) {
+ args.post__in = attrs.include.split(',');
+ }
+
+ if ( attrs.exclude ) {
+ args.post__not_in = attrs.exclude.split(',');
+ }
+
+ if ( ! args.post__in ) {
+ args.uploadedTo = attrs.id;
+ }
+
+ // Collect the attributes that were not included in `args`.
+ others = _.omit( attrs, 'id', 'ids', 'include', 'exclude', 'orderby', 'order' );
+
+ query = wp.media.query( args );
+ query[ prop ] = new Backbone.Model( others );
+ return query;
+ };
+ },
+
+ shortcodeAttrs : function ( prop, attachments ) {
+ var props = attachments.props.toJSON(),
+ attrs = _.pick( props, 'orderby', 'order', 'style' );
+
+ if ( attachments[ prop ] ) {
+ _.extend( attrs, attachments[ prop ].toJSON() );
+ }
+
+ // Convert all collection shortcodes to use the `ids` property.
+ // Ignore `post__in` and `post__not_in`; the attachments in
+ // the collection will already reflect those properties.
+ attrs.ids = attachments.pluck('id');
+
+ // Copy the `uploadedTo` post ID.
+ if ( props.uploadedTo ) {
+ attrs.id = props.uploadedTo;
+ }
+
+ // Check if the collection is randomly ordered.
+ delete attrs.orderby;
+
+ if ( attrs._orderbyRandom ) {
+ attrs.orderby = 'rand';
+ } else if ( attrs._orderByField && attrs._orderByField != 'rand' ) {
+ attrs.orderby = attrs._orderByField;
+ }
+
+ delete attrs._orderbyRandom;
+ delete attrs._orderByField;
+
+ // If the `ids` attribute is set and `orderby` attribute
+ // is the default value, clear it for cleaner output.
+ if ( attrs.ids && 'post__in' === attrs.orderby ) {
+ delete attrs.orderby;
+ }
+
+ if ( -1 !== jQuery.inArray( prop, ['playlist', 'video-playlist'] ) ) {
+ _.each(['tracknumbers', 'tracklist', 'images'], function (setting) {
+ if ( attrs['_' + setting] ) {
+ attrs[setting] = true;
+ } else {
+ attrs[setting] = false;
+ }
+ delete attrs['_' + setting];
+ });
+ }
+
+ // Remove default attributes from the shortcode.
+ _.each( this.defaults, function( value, key ) {
+ if ( value === attrs[ key ] ) {
+ delete attrs[ key ];
+ }
+ });
+ return attrs;
+ },
+
+ editSelection : function ( prop, shortcode ) {
+ var defaultPostId = wp.media[ prop ].defaults.id,
+ attachments, selection;
+
+ // Ignore the rest of the match object.
+ shortcode = shortcode.shortcode;
+
+ if ( _.isUndefined( shortcode.get('id') ) && ! _.isUndefined( defaultPostId ) ) {
+ shortcode.set( 'id', defaultPostId );
+ }
+
+ attachments = wp.media[ prop ].attachments( shortcode );
+
+ selection = new wp.media.model.Selection( attachments.models, {
+ props: attachments.props.toJSON(),
+ multiple: true
+ });
+
+ selection[ prop ] = attachments[ prop ];
+
+ // Fetch the query's attachments, and then break ties from the
+ // query to allow for sorting.
+ selection.more().done( function() {
+ // Break ties with the query.
+ selection.props.set({ query: false });
+ selection.unmirror();
+ selection.props.unset('orderby');
+ });
+
+ return selection;
+ },
+
+ /**
+ *
+ * @param {string} prop The shortcode slug
+ * @param {wp.media.model.Attachments} attachments
+ * @param {wp.shortcode} shortcode
+ * @returns {wp.shortcode}
+ */
+ cacheShortcode : function ( prop, attachments, shortcode ) {
+ // Use a cloned version of the playlist.
+ var clone = new wp.media.model.Attachments( attachments.models, {
+ props: attachments.props.toJSON()
+ });
+ clone[ prop ] = attachments[ prop ];
+ cache[ shortcode.string() ] = clone;
+
+ return shortcode;
+ },
+
+ getEditFrame : function ( args ) {
+ // Destroy the previous gallery frame.
+ if ( this.frame ) {
+ this.frame.dispose();
+ }
+
+ // Store the current gallery frame.
+ this.frame = wp.media( _.extend( {
+ frame: 'post',
+ editing: true,
+ multiple: true,
+ }, args ) ).open();
+
+ return this.frame;
+ },
+
+ instance : function ( prop, args ) {
+ return {
+ attachments: this.attachments( prop, args.type ),
+ /**
+ * Triggered when clicking 'Insert {label}' or 'Update {label}'
+ *
+ * @global wp.shortcode
+ * @global wp.media.model.Attachments
+ *
+ * @param {wp.media.model.Attachments} attachments A Backbone.Collection containing
+ * the media items belonging to a collection.
+ * The 'prop' specified by the passed prop is a Backbone.Model
+ * containing the 'props' for the gallery.
+ * @returns {wp.shortcode}
+ */
+ shortcode: function( attachments ) {
+ var shortcode = new wp.shortcode({
+ tag: prop,
+ attrs: wp.media.collection.shortcodeAttrs( prop, attachments ),
+ type: 'single'
+ });
+
+ return wp.media.collection.cacheShortcode( prop, attachments, shortcode );
+ },
+ /**
+ * Triggered when double-clicking a collection shortcode placeholder
+ * in the editor
+ *
+ * @global wp.shortcode
+ * @global wp.media.model.Selection
+ * @global wp.media.view.l10n
+ *
+ * @param {string} content Content that is searched for possible
+ * shortcode markup matching the passed tag name,
+ *
+ * @this wp.media.{prop}
+ *
+ * @returns {wp.media.view.MediaFrame.Select} A media workflow.
+ */
+ edit: function( content ) {
+ var shortcode = wp.shortcode.next( prop, content );
+
+ // Bail if we didn't match the shortcode or all of the content.
+ if ( ! shortcode || shortcode.content !== content ) {
+ return;
+ }
+
+ return wp.media.collection.getEditFrame( {
+ title: args.title,
+ state: prop + '-edit',
+ selection: wp.media.collection.editSelection( prop, shortcode )
+ } );
+ }
+ };
+ }
+ };
+
+ /**
</ins><span class="cx"> * wp.media.gallery
</span><span class="cx"> * @namespace
</span><span class="cx"> */
</span></span></pre>
</div>
</div>
</body>
</html>