<!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>[42993] trunk/src/wp-includes/js/wp-backbone.js: Docs: Improve JSDoc for `wp-includes/js/wp-backbone.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/42993">42993</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/42993","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-04-19 14:01:48 +0000 (Thu, 19 Apr 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 `wp-includes/js/wp-backbone.js`.
Props ericlewis, gma992, adamsilverstein.
Fixes <a href="https://core.trac.wordpress.org/ticket/35465">#35465</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjswpbackbonejs">trunk/src/wp-includes/js/wp-backbone.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjswpbackbonejs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/wp-backbone.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/wp-backbone.js 2018-04-19 12:38:44 UTC (rev 42992)
+++ trunk/src/wp-includes/js/wp-backbone.js 2018-04-19 14:01:48 UTC (rev 42993)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,11 +9,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp.Backbone = {};
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // wp.Backbone.Subviews
- // --------------------
- //
- // A subview manager.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * A backbone subview manager.
+ *
+ * @since 3.5.0
+ * @since 3.6.0 Moved wp.media.Views to wp.Backbone.Subviews.
+ *
+ * @memberOf wp.Backbone
+ *
+ * @class
+ *
+ * @param {wp.Backbone.View} view The main view.
+ * @param {array|Object} views The subviews for the main view.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> wp.Backbone.Subviews = function( view, views ) {
</span><span class="cx" style="display: block; padding: 0 10px"> this.view = view;
</span><span class="cx" style="display: block; padding: 0 10px"> this._views = _.isArray( views ) ? { '': views } : views || {};
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,63 +30,95 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp.Backbone.Subviews.extend = Backbone.Model.extend;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> _.extend( wp.Backbone.Subviews.prototype, {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Fetch all of the subviews
- //
- // Returns an array of all subviews.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fetches all of the subviews.
+ *
+ * @since 3.5.0
+ *
+ * @return {array} All the subviews.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> all: function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return _.flatten( _.values( this._views ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return _.flatten( _.values( this._views ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Get a selector's subviews
- //
- // Fetches all subviews that match a given `selector`.
- //
- // If no `selector` is provided, it will grab all subviews attached
- // to the view's root.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fetches all subviews that match a given `selector`.
+ *
+ * If no `selector` is provided, it will grab all subviews attached
+ * to the view's root.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} selector A jQuery selector.
+ *
+ * @return {array}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> get: function( selector ) {
</span><span class="cx" style="display: block; padding: 0 10px"> selector = selector || '';
</span><span class="cx" style="display: block; padding: 0 10px"> return this._views[ selector ];
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Get a selector's first subview
- //
- // Fetches the first subview that matches a given `selector`.
- //
- // If no `selector` is provided, it will grab the first subview
- // attached to the view's root.
- //
- // Useful when a selector only has one subview at a time.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fetches the first subview that matches a given `selector`.
+ *
+ * If no `selector` is provided, it will grab the first subview attached to the
+ * view's root.
+ *
+ * Useful when a selector only has one subview at a time.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} selector A jQuery selector.
+ *
+ * @return {Backbone.View} The view.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> first: function( selector ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var views = this.get( selector );
</span><span class="cx" style="display: block; padding: 0 10px"> return views && views.length ? views[0] : null;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Register subview(s)
- //
- // Registers any number of `views` to a `selector`.
- //
- // When no `selector` is provided, the root selector (the empty string)
- // is used. `views` accepts a `Backbone.View` instance or an array of
- // `Backbone.View` instances.
- //
- // ---
- //
- // Accepts an `options` object, which has a significant effect on the
- // resulting behavior.
- //
- // `options.silent` – *boolean, `false`*
- // > If `options.silent` is true, no DOM modifications will be made.
- //
- // `options.add` – *boolean, `false`*
- // > Use `Views.add()` as a shortcut for setting `options.add` to true.
- //
- // > By default, the provided `views` will replace
- // any existing views associated with the selector. If `options.add`
- // is true, the provided `views` will be added to the existing views.
- //
- // `options.at` – *integer, `undefined`*
- // > When adding, to insert `views` at a specific index, use
- // `options.at`. By default, `views` are added to the end of the array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Registers subview(s).
+ *
+ * Registers any number of `views` to a `selector`.
+ *
+ * When no `selector` is provided, the root selector (the empty string)
+ * is used. `views` accepts a `Backbone.View` instance or an array of
+ * `Backbone.View` instances.
+ *
+ * ---
+ *
+ * Accepts an `options` object, which has a significant effect on the
+ * resulting behavior.
+ *
+ * `options.silent` – *boolean, `false`*
+ * > If `options.silent` is true, no DOM modifications will be made.
+ *
+ * `options.add` – *boolean, `false`*
+ * > Use `Views.add()` as a shortcut for setting `options.add` to true.
+ *
+ * > By default, the provided `views` will replace
+ * any existing views associated with the selector. If `options.add`
+ * is true, the provided `views` will be added to the existing views.
+ *
+ * `options.at` – *integer, `undefined`*
+ * > When adding, to insert `views` at a specific index, use
+ * `options.at`. By default, `views` are added to the end of the array.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} selector A jQuery selector.
+ * @param {array|Object} views The subviews for the main view.
+ * @param {Object} options Options for call. If `options.silent` is true,
+ * no DOM modifications will be made. Use
+ * `Views.add()` as a shortcut for setting
+ * `options.add` to true. If `options.add` is
+ * true, the provided `views` will be added to
+ * the existing views. When adding, to insert
+ * `views` at a specific index, use `options.at`.
+ *
+ * @return wp.Backbone.Subviews
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> set: function( selector, views, options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var existing, next;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,24 +174,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Add subview(s) to existing subviews
- //
- // An alias to `Views.set()`, which defaults `options.add` to true.
- //
- // Adds any number of `views` to a `selector`.
- //
- // When no `selector` is provided, the root selector (the empty string)
- // is used. `views` accepts a `Backbone.View` instance or an array of
- // `Backbone.View` instances.
- //
- // Use `Views.set()` when setting `options.add` to `false`.
- //
- // Accepts an `options` object. By default, provided `views` will be
- // inserted at the end of the array of existing views. To insert
- // `views` at a specific index, use `options.at`. If `options.silent`
- // is true, no DOM modifications will be made.
- //
- // For more information on the `options` object, see `Views.set()`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Add subview(s) to existing subviews.
+ *
+ * An alias to `Views.set()`, which defaults `options.add` to true.
+ *
+ * Adds any number of `views` to a `selector`.
+ *
+ * When no `selector` is provided, the root selector (the empty string)
+ * is used. `views` accepts a `Backbone.View` instance or an array of
+ * `Backbone.View` instances.
+ *
+ * Uses `Views.set()` when setting `options.add` to `false`.
+ *
+ * Accepts an `options` object. By default, provided `views` will be
+ * inserted at the end of the array of existing views. To insert
+ * `views` at a specific index, use `options.at`. If `options.silent`
+ * is true, no DOM modifications will be made.
+ *
+ * For more information on the `options` object, see `Views.set()`.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} selector A jQuery selector.
+ * @param {array|object} views The subviews for the main view.
+ * @param {Object} options Options for call. To insert `views` at a
+ * specific index, use `options.at`. If
+ * `options.silent` is true, no DOM modifications
+ * will be made.
+ *
+ * @return wp.Backbone.Subviews
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> add: function( selector, views, options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! _.isString( selector ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> options = views;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,14 +215,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this.set( selector, views, _.extend({ add: true }, options ) );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Stop tracking subviews
- //
- // Stops tracking `views` registered to a `selector`. If no `views` are
- // set, then all of the `selector`'s subviews will be unregistered and
- // removed.
- //
- // Accepts an `options` object. If `options.silent` is set, `remove`
- // will *not* be triggered on the unregistered views.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Removes an added subview.
+ *
+ * Stops tracking `views` registered to a `selector`. If no `views` are
+ * set, then all of the `selector`'s subviews will be unregistered and
+ * removed.
+ *
+ * Accepts an `options` object. If `options.silent` is set, `remove`
+ * will *not* be triggered on the unregistered views.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} selector A jQuery selector.
+ * @param {array|object} views The subviews for the main view.
+ * @param {Object} options Options for call. If `options.silent` is set,
+ * `remove` will *not* be triggered on the
+ * unregistered views.
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> unset: function( selector, views, options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var existing;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,20 +257,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Detach all subviews
- //
- // Detaches all subviews from the DOM.
- //
- // Helps to preserve all subview events when re-rendering the master
- // view. Used in conjunction with `Views.render()`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Detaches all subviews.
+ *
+ * Helps to preserve all subview events when re-rendering the master
+ * view. Used in conjunction with `Views.render()`.
+ *
+ * @since 3.5.0
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> detach: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $( _.pluck( this.all(), 'el' ) ).detach();
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Render all subviews
- //
- // Renders all subviews. Used in conjunction with `Views.detach()`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Renders all subviews
+ *
+ * Used in conjunction with `Views.detach()`.
+ *
+ * @since 3.5.0
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> render: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var options = {
</span><span class="cx" style="display: block; padding: 0 10px"> ready: this._isReady()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -219,13 +294,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Remove all subviews
- //
- // Triggers the `remove()` method on all subviews. Detaches the master
- // view from its parent. Resets the internals of the views manager.
- //
- // Accepts an `options` object. If `options.silent` is set, `unset`
- // will *not* be triggered on the master view's parent.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Removes all subviews
+ *
+ * Triggers the `remove()` method on all subviews. Detaches the master
+ * view from its parent. Resets the internals of the views manager.
+ *
+ * Accepts an `options` object. If `options.silent` is set, `unset`
+ * will *not* be triggered on the master view's parent.
+ *
+ * @since 3.6.0
+ *
+ * @param {Object} options Options for call.
+ * @param {boolean} options.silent If true, `unset` wil *not* be triggered on
+ * the master views' parent.
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> remove: function( options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! options || ! options.silent ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( this.parent && this.parent.views )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,23 +324,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Replace a selector's subviews
- //
- // By default, sets the `$target` selector's html to the subview `els`.
- //
- // Can be overridden in subclasses.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Replaces a selector's subviews
+ *
+ * By default, sets the `$target` selector's html to the subview `els`.
+ *
+ * Can be overridden in subclasses.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} $target Selector where to put the elements.
+ * @param {*} els HTML or elements to put into the selector's HTML.
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> replace: function( $target, els ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $target.html( els );
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Insert subviews into a selector
- //
- // By default, appends the subview `els` to the end of the `$target`
- // selector. If `options.at` is set, inserts the subview `els` at the
- // provided index.
- //
- // Can be overridden in subclasses.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Insert subviews into a selector
+ *
+ * By default, appends the subview `els` to the end of the `$target`
+ * selector. If `options.at` is set, inserts the subview `els` at the
+ * provided index.
+ *
+ * Can be overridden in subclasses.
+ *
+ * @since 3.5.0
+ *
+ * @param {string} $target Selector where to put the elements.
+ * @param {*} els HTML or elements to put at the end of the
+ * $target.
+ * @param {?Object} options Options for call.
+ * @param {?number} options.at At which index to put the elements.
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> insert: function( $target, els, options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var at = options && options.at,
</span><span class="cx" style="display: block; padding: 0 10px"> $children;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -268,13 +374,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ### Trigger the ready event
- //
- // **Only use this method if you know what you're doing.**
- // For performance reasons, this method does not check if the view is
- // actually attached to the DOM. It's taking your word for it.
- //
- // Fires the ready event on the current view and all attached subviews.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Triggers the ready event.
+ *
+ * Only use this method if you know what you're doing. For performance reasons,
+ * this method does not check if the view is actually attached to the DOM. It's
+ * taking your word for it.
+ *
+ * Fires the ready event on the current view and all attached subviews.
+ *
+ * @since 3.5.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> ready: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> this.view.trigger('ready');
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -283,12 +393,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return view.views;
</span><span class="cx" style="display: block; padding: 0 10px"> }).flatten().where({ attached: true }).invoke('ready');
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // #### Internal. Attaches a series of views to a selector.
- //
- // Checks to see if a matching selector exists, renders the views,
- // performs the proper DOM operation, and then checks if the view is
- // attached to the document.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Attaches a series of views to a selector. Internal.
+ *
+ * Checks to see if a matching selector exists, renders the views,
+ * performs the proper DOM operation, and then checks if the view is
+ * attached to the document.
+ *
+ * @since 3.5.0
+ *
+ * @private
+ *
+ * @param {string} selector A jQuery selector.
+ * @param {array|object} views The subviews for the main view.
+ * @param {Object} options Options for call.
+ * @param {boolean} options.add If true the provided views will be added.
+ *
+ * @return {wp.Backbone.Subviews} The current Subviews instance.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _attach: function( selector, views, options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var $selector = selector ? this.view.$( selector ) : this.view.$el,
</span><span class="cx" style="display: block; padding: 0 10px"> managers;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,7 +445,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // #### Internal. Checks if the current view is in the DOM.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Determines whether or not the current view is in the DOM.
+ *
+ * @since 3.5.0
+ *
+ * @private
+ *
+ * @returns {boolean} Whether or not the current view is in the DOM.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _isReady: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var node = this.view.el;
</span><span class="cx" style="display: block; padding: 0 10px"> while ( node ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -336,15 +466,27 @@
</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">+ wp.Backbone.View = Backbone.View.extend({
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // wp.Backbone.View
- // ----------------
- //
- // The base view class.
- wp.Backbone.View = Backbone.View.extend({
</del><span class="cx" style="display: block; padding: 0 10px"> // The constructor for the `Views` manager.
</span><span class="cx" style="display: block; padding: 0 10px"> Subviews: wp.Backbone.Subviews,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * The base view class.
+ *
+ * This extends the backbone view to have a build-in way to use subviews. This
+ * makes it easier to have nested views.
+ *
+ * @since 3.5.0
+ * @since 3.6.0 Moved wp.media.View to wp.Backbone.View
+ *
+ * @memberOf wp.Backbone
+ *
+ * @constructs
+ * @augments Backbone.View
+ *
+ * @param {Object} options The options for this view.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> constructor: function( options ) {
</span><span class="cx" style="display: block; padding: 0 10px"> this.views = new this.Subviews( this, this.views );
</span><span class="cx" style="display: block; padding: 0 10px"> this.on( 'ready', this.ready, this );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,6 +496,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> Backbone.View.apply( this, arguments );
</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">+ /**
+ * @since 3.5.0
+ *
+ * Removes this view and all subviews.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> remove: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var result = Backbone.View.prototype.remove.apply( this, arguments );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -364,6 +511,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return result;
</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">+ /**
+ * Renders this view and all subviews.
+ *
+ * @since 3.5.0
+ *
+ * @returns {wp.Backbone.View} The current instance of the view.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> render: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var options;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,10 +536,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return this;
</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">+ /**
+ * Returns the options for this view.
+ *
+ * @since 3.5.0
+ *
+ * @returns {Object} The options for this view.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> prepare: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> return this.options;
</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">+ /**
+ * Method that is called when the ready event is triggered.
+ *
+ * @since 3.5.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> ready: function() {}
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px"> }(jQuery));
</span></span></pre>
</div>
</div>
</body>
</html>