<!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>[25524] trunk/src/wp-includes/class.wp-dependencies.php: Inline documentation for WP_Dependencies and _WP_Dependency classes.</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/25524">25524</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-09-20 19:53:53 +0000 (Fri, 20 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for WP_Dependencies and _WP_Dependency classes.
Props kitchin for the initial patch.
Fixes <a href="http://core.trac.wordpress.org/ticket/23914">#23914</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpdependenciesphp">trunk/src/wp-includes/class.wp-dependencies.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpdependenciesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class.wp-dependencies.php (25523 => 25524)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class.wp-dependencies.php 2013-09-20 19:36:00 UTC (rev 25523)
+++ trunk/src/wp-includes/class.wp-dependencies.php 2013-09-20 19:53:53 UTC (rev 25524)
</span><span class="lines">@@ -1,16 +1,10 @@
</span><span class="cx"> <?php
</span><span class="cx"> /**
</span><del>- * BackPress Scripts enqueue.
</del><ins>+ * BackPress Scripts enqueue
</ins><span class="cx"> *
</span><del>- * These classes were refactored from the WordPress WP_Scripts and WordPress
- * script enqueue API.
</del><ins>+ * Classes were refactored from the WP_Scripts and WordPress script enqueue API.
</ins><span class="cx"> *
</span><del>- * @package BackPress
- * @since r74
- */
-
-/**
- * BackPress enqueued dependiences class.
</del><ins>+ * @since BackPress r74
</ins><span class="cx"> *
</span><span class="cx"> * @package BackPress
</span><span class="cx"> * @uses _WP_Dependency
</span><span class="lines">@@ -83,26 +77,48 @@
</span><span class="cx"> var $group = 0;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Do the dependencies
</del><ins>+ * Process the items and dependencies.
</ins><span class="cx"> *
</span><del>- * Process the items passed to it or the queue. Processes all dependencies.
</del><ins>+ * Processes the items passed to it or the queue, and their dependencies.
</ins><span class="cx"> *
</span><del>- * @param mixed $handles (optional) items to be processed. (void) processes queue, (string) process that item, (array of strings) process those items
- * @return array Items that have been processed
</del><ins>+ * @access public
+ * @since 2.1.0
+ *
+ * @param mixed $handles Optional. Items to be processed: Process queue (false), process item (string), process items (array of strings).
+ * @param mixed $group Group level: level (int), no groups (false).
+ * @return array Handles of items that have been processed.
</ins><span class="cx"> */
</span><del>- function do_items( $handles = false, $group = false ) {
- // Print the queue if nothing is passed. If a string is passed, print that script. If an array is passed, print those scripts.
</del><ins>+ public function do_items( $handles = false, $group = false ) {
+ /**
+ * If nothing is passed, print the queue. If a string is passed,
+ * print that item. If an array is passed, print those items.
+ */
</ins><span class="cx"> $handles = false === $handles ? $this->queue : (array) $handles;
</span><span class="cx"> $this->all_deps( $handles );
</span><span class="cx">
</span><span class="cx"> foreach( $this->to_do as $key => $handle ) {
</span><span class="cx"> if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) {
</span><span class="cx">
</span><del>- if ( ! $this->registered[$handle]->src ) { // Defines a group.
</del><ins>+ /**
+ * A single item may alias a set of items, by having dependencies,
+ * but no source. Queuing the item queues the dependencies.
+ *
+ * Example: The extending class WP_Scripts is used to register 'scriptaculous' as a set of registered handles:
+ * <code>add( 'scriptaculous', false, array( 'scriptaculous-dragdrop', 'scriptaculous-slider', 'scriptaculous-controls' ) );</code>
+ *
+ * The src property is false.
+ **/
+ if ( ! $this->registered[$handle]->src ) {
</ins><span class="cx"> $this->done[] = $handle;
</span><span class="cx"> continue;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Attempt to process the item. If successful,
+ * add the handle to the done array.
+ *
+ * Unset the item from the to_do array.
+ */
</ins><span class="cx"> if ( $this->do_item( $handle, $group ) )
</span><span class="cx"> $this->done[] = $handle;
</span><span class="cx">
</span><span class="lines">@@ -113,20 +129,34 @@
</span><span class="cx"> return $this->done;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- function do_item( $handle ) {
</del><ins>+ /**
+ * Process a dependency.
+ *
+ * @access public
+ * @since 2.6.0
+ *
+ * @param string $handle Name of the item. Should be unique.
+ * @return bool True on success, false if not set.
+ */
+ public function do_item( $handle ) {
</ins><span class="cx"> return isset($this->registered[$handle]);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Determines dependencies
</del><ins>+ * Determine dependencies.
</ins><span class="cx"> *
</span><del>- * Recursively builds array of items to process taking dependencies into account. Does NOT catch infinite loops.
</del><ins>+ * Recursively builds an array of items to process taking
+ * dependencies into account. Does NOT catch infinite loops.
</ins><span class="cx"> *
</span><ins>+ * @access public
+ * @since 2.1.0
</ins><span class="cx"> *
</span><del>- * @param mixed $handles Accepts (string) dep name or (array of strings) dep names
- * @param bool $recursion Used internally when function calls itself
</del><ins>+ * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+ * @param bool $recursion Internal flag that function is calling itself.
+ * @param mixed $group Group level: (int) level, (false) no groups.
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><del>- function all_deps( $handles, $recursion = false, $group = false ) {
</del><ins>+ public function all_deps( $handles, $recursion = false, $group = false ) {
</ins><span class="cx"> if ( !$handles = (array) $handles )
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="lines">@@ -145,20 +175,20 @@
</span><span class="cx">
</span><span class="cx"> $keep_going = true;
</span><span class="cx"> if ( !isset($this->registered[$handle]) )
</span><del>- $keep_going = false; // Script doesn't exist
</del><ins>+ $keep_going = false; // Item doesn't exist.
</ins><span class="cx"> elseif ( $this->registered[$handle]->deps && array_diff($this->registered[$handle]->deps, array_keys($this->registered)) )
</span><del>- $keep_going = false; // Script requires deps which don't exist (not a necessary check. efficiency?)
</del><ins>+ $keep_going = false; // Item requires dependencies that don't exist.
</ins><span class="cx"> elseif ( $this->registered[$handle]->deps && !$this->all_deps( $this->registered[$handle]->deps, true, $group ) )
</span><del>- $keep_going = false; // Script requires deps which don't exist
</del><ins>+ $keep_going = false; // Item requires dependencies that don't exist.
</ins><span class="cx">
</span><del>- if ( !$keep_going ) { // Either script or its deps don't exist.
</del><ins>+ if ( ! $keep_going ) { // Either item or its dependencies don't exist.
</ins><span class="cx"> if ( $recursion )
</span><span class="cx"> return false; // Abort this branch.
</span><span class="cx"> else
</span><span class="cx"> continue; // We're at the top level. Move on to the next one.
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( $queued ) // Already grobbed it and its deps
</del><ins>+ if ( $queued ) // Already grabbed it and its dependencies.
</ins><span class="cx"> continue;
</span><span class="cx">
</span><span class="cx"> if ( isset($handle_parts[1]) )
</span><span class="lines">@@ -171,17 +201,21 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Adds item
</del><ins>+ * Register an item.
</ins><span class="cx"> *
</span><del>- * Adds the item only if no item of that name already exists
</del><ins>+ * Registers the item if no item of that name already exists.
</ins><span class="cx"> *
</span><del>- * @param string $handle Script name
- * @param string $src Script url
- * @param array $deps (optional) Array of script names on which this script depends
- * @param string $ver (optional) Script version (used for cache busting)
- * @return array Hierarchical array of dependencies
</del><ins>+ * @access public
+ * @since 2.1.0
+ *
+ * @param string $handle Unique item name.
+ * @param string $src The item url.
+ * @param array $deps Optional. An array of item handle strings on which this item depends.
+ * @param string $ver Optional. Version (used for cache busting).
+ * @param mixed $args Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer.
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><del>- function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {
</del><ins>+ public function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {
</ins><span class="cx"> if ( isset($this->registered[$handle]) )
</span><span class="cx"> return false;
</span><span class="cx"> $this->registered[$handle] = new _WP_Dependency( $handle, $src, $deps, $ver, $args );
</span><span class="lines">@@ -189,16 +223,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Adds extra data
</del><ins>+ * Add extra item data.
</ins><span class="cx"> *
</span><del>- * Adds data only if script has already been added.
</del><ins>+ * Adds data to a registered item.
</ins><span class="cx"> *
</span><del>- * @param string $handle Script name
- * @param string $key
- * @param mixed $value
- * @return bool success
</del><ins>+ * @access public
+ * @since 2.6.0
+ *
+ * @param string $handle Name of the item. Should be unique.
+ * @param string $key The data key.
+ * @param mixed $value The data value.
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><del>- function add_data( $handle, $key, $value ) {
</del><ins>+ public function add_data( $handle, $key, $value ) {
</ins><span class="cx"> if ( !isset( $this->registered[$handle] ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="lines">@@ -206,17 +243,18 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get extra data
</del><ins>+ * Get extra item data.
</ins><span class="cx"> *
</span><del>- * Gets data associated with a certain handle.
</del><ins>+ * Gets data associated with a registered item.
</ins><span class="cx"> *
</span><del>- * @since WP 3.3
</del><ins>+ * @access public
+ * @since 3.3.0
</ins><span class="cx"> *
</span><del>- * @param string $handle Script name
- * @param string $key
- * @return mixed
</del><ins>+ * @param string $handle Name of the item. Should be unique.
+ * @param string $key The data key.
+ * @return mixed Extra item data (string), false otherwise.
</ins><span class="cx"> */
</span><del>- function get_data( $handle, $key ) {
</del><ins>+ public function get_data( $handle, $key ) {
</ins><span class="cx"> if ( !isset( $this->registered[$handle] ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="lines">@@ -226,12 +264,34 @@
</span><span class="cx"> return $this->registered[$handle]->extra[$key];
</span><span class="cx"> }
</span><span class="cx">
</span><del>- function remove( $handles ) {
</del><ins>+ /**
+ * Un-register an item or items.
+ *
+ * @access public
+ * @since 2.1.0
+ *
+ * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+ * @return void
+ */
+ public function remove( $handles ) {
</ins><span class="cx"> foreach ( (array) $handles as $handle )
</span><span class="cx"> unset($this->registered[$handle]);
</span><span class="cx"> }
</span><span class="cx">
</span><del>- function enqueue( $handles ) {
</del><ins>+ /**
+ * Queue an item or items.
+ *
+ * Decodes handles and arguments, then queues handles and stores
+ * arguments in the class property $args. For example in extending
+ * classes, $args is appended to the item url as a query string.
+ * Note $args is NOT the $args property of items in the $registered array.
+ *
+ * @access public
+ * @since 2.1.0
+ *
+ * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+ */
+ public function enqueue( $handles ) {
</ins><span class="cx"> foreach ( (array) $handles as $handle ) {
</span><span class="cx"> $handle = explode('?', $handle);
</span><span class="cx"> if ( !in_array($handle[0], $this->queue) && isset($this->registered[$handle[0]]) ) {
</span><span class="lines">@@ -242,7 +302,18 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- function dequeue( $handles ) {
</del><ins>+ /**
+ * Dequeue an item or items.
+ *
+ * Decodes handles and arguments, then dequeues handles
+ * and removes arguments from the class property $args.
+ *
+ * @access public
+ * @since 2.1.0
+ *
+ * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+ */
+ public function dequeue( $handles ) {
</ins><span class="cx"> foreach ( (array) $handles as $handle ) {
</span><span class="cx"> $handle = explode('?', $handle);
</span><span class="cx"> $key = array_search($handle[0], $this->queue);
</span><span class="lines">@@ -253,8 +324,17 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>-
- function query( $handle, $list = 'registered' ) {
</del><ins>+ /**
+ * Query list for an item.
+ *
+ * @access public
+ * @since 2.1.0
+ *
+ * @param string $handle Name of the item. Should be unique.
+ * @param string $list Property name of list array.
+ * @return bool Found, or object Item data.
+ */
+ public function query( $handle, $list = 'registered' ) {
</ins><span class="cx"> switch ( $list ) {
</span><span class="cx"> case 'registered' :
</span><span class="cx"> case 'scripts': // back compat
</span><span class="lines">@@ -277,7 +357,18 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- function set_group( $handle, $recursion, $group ) {
</del><ins>+ /**
+ * Set item group, unless already in a lower group.
+ *
+ * @access public
+ * @since 2.8.0
+ *
+ * @param string $handle Name of the item. Should be unique.
+ * @param bool $recursion Internal flag that calling function was called recursively.
+ * @param mixed $group Group level.
+ * @return bool Not already in the group or a lower group
+ */
+ public function set_group( $handle, $recursion, $group ) {
</ins><span class="cx"> $group = (int) $group;
</span><span class="cx">
</span><span class="cx"> if ( $recursion )
</span><span class="lines">@@ -292,8 +383,16 @@
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-}
</del><ins>+} // WP_Dependencies
</ins><span class="cx">
</span><ins>+/**
+ * Class _WP_Dependency
+ *
+ * Helper class to register a handle and associated data.
+ *
+ * @access private
+ * @since 2.6.0
+ */
</ins><span class="cx"> class _WP_Dependency {
</span><span class="cx"> /**
</span><span class="cx"> * The handle name.
</span><span class="lines">@@ -351,16 +450,32 @@
</span><span class="cx"> */
</span><span class="cx"> var $extra = array();
</span><span class="cx">
</span><ins>+ /**
+ * Setup dependencies.
+ *
+ * @since 2.6.0
+ */
</ins><span class="cx"> function __construct() {
</span><span class="cx"> @list( $this->handle, $this->src, $this->deps, $this->ver, $this->args ) = func_get_args();
</span><span class="cx"> if ( ! is_array($this->deps) )
</span><span class="cx"> $this->deps = array();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Add handle data.
+ *
+ * @access public
+ * @since 2.6.0
+ *
+ * @param string $name The data key to add.
+ * @param mixed $data The data value to add.
+ * @return bool False if not scalar, true otherwise.
+ */
</ins><span class="cx"> function add_data( $name, $data ) {
</span><span class="cx"> if ( !is_scalar($name) )
</span><span class="cx"> return false;
</span><span class="cx"> $this->extra[$name] = $data;
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><del>-}
</del><ins>+
+} // _WP_Dependencies
</ins></span></pre>
</div>
</div>
</body>
</html>