Inline documentation for WP_Dependencies and _WP_Dependency classes.

Props kitchin for the initial patch.
Fixes #23914.

Built from https://develop.svn.wordpress.org/trunk@25524


git-svn-id: http://core.svn.wordpress.org/trunk@25444 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/class.wp-dependencies.php

@@ -1,16 +1,10 @@
 <?php
 /**
- * BackPress Scripts enqueue.
+ * BackPress Scripts enqueue
  *
- * These classes were refactored from the WordPress WP_Scripts and WordPress
+ * Classes were refactored from the WP_Scripts and WordPress script enqueue API.
- * script enqueue API.
  *
- * @package BackPress
+ * @since BackPress r74
- * @since r74
- */
-
-/**
- * BackPress enqueued dependiences class.
  *
  * @package BackPress
  * @uses _WP_Dependency
@@ -83,26 +77,48 @@ class WP_Dependencies {
 	var $group = 0;
 
 	/**
-	 * Do the dependencies
+	 * Process the items and dependencies.
 	 *
-	 * Process the items passed to it or the queue. Processes all dependencies.
+	 * Processes the items passed to it or the queue, and their dependencies.
 	 *
-	 * @param mixed $handles (optional) items to be processed. (void) processes queue, (string) process that item, (array of strings) process those items
+	 * @access public
-	 * @return array Items that have been processed
+	 * @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.
+	 */
+	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.
 		 */
-	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.
 		$handles = false === $handles ? $this->queue : (array) $handles;
 		$this->all_deps( $handles );
 
 		foreach( $this->to_do as $key => $handle ) {
 			if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) {
 
-				if ( ! $this->registered[$handle]->src ) { // Defines a group.
+				/**
+				 * 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 ) {
 					$this->done[] = $handle;
 					continue;
 				}
 
+				/**
+				 * Attempt to process the item. If successful,
+				 * add the handle to the done array.
+				 *
+				 * Unset the item from the to_do array.
+				 */
 				if ( $this->do_item( $handle, $group ) )
 					$this->done[] = $handle;
 
@@ -113,20 +129,34 @@ class WP_Dependencies {
 		return $this->done;
 	}
 
-	function do_item( $handle ) {
+	/**
+	 * 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 ) {
 		return isset($this->registered[$handle]);
 	}
 
 	/**
-	 * Determines dependencies
+	 * Determine dependencies.
 	 *
-	 * Recursively builds array of items to process taking dependencies into account. Does NOT catch infinite loops.
+	 * Recursively builds an array of items to process taking
+	 * dependencies into account. Does NOT catch infinite loops.
 	 *
+	 * @access public
+	 * @since 2.1.0
 	 *
-	 * @param mixed $handles Accepts (string) dep name or (array of strings) dep names
+	 * @param mixed $handles   Item handle and argument (string) or item handles and arguments (array of strings).
-	 * @param bool $recursion Used internally when function calls itself
+	 * @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.
 	 */
-	function all_deps( $handles, $recursion = false, $group = false ) {
+	public function all_deps( $handles, $recursion = false, $group = false ) {
 		if ( !$handles = (array) $handles )
 			return false;
 
@@ -145,20 +175,20 @@ class WP_Dependencies {
 
 			$keep_going = true;
 			if ( !isset($this->registered[$handle]) )
-				$keep_going = false; // Script doesn't exist
+				$keep_going = false; // Item doesn't exist.
 			elseif ( $this->registered[$handle]->deps && array_diff($this->registered[$handle]->deps, array_keys($this->registered)) )
-				$keep_going = false; // Script requires deps which don't exist (not a necessary check. efficiency?)
+				$keep_going = false; // Item requires dependencies that don't exist.
 			elseif ( $this->registered[$handle]->deps && !$this->all_deps( $this->registered[$handle]->deps, true, $group ) )
-				$keep_going = false; // Script requires deps which don't exist
+				$keep_going = false; // Item requires dependencies that don't exist.
 
-			if ( !$keep_going ) { // Either script or its deps don't exist.
+			if ( ! $keep_going ) { // Either item or its dependencies don't exist.
 				if ( $recursion )
 					return false; // Abort this branch.
 				else
 					continue; // We're at the top level. Move on to the next one.
 			}
 
-			if ( $queued ) // Already grobbed it and its deps
+			if ( $queued ) // Already grabbed it and its dependencies.
 				continue;
 
 			if ( isset($handle_parts[1]) )
@@ -171,17 +201,21 @@ class WP_Dependencies {
 	}
 
 	/**
-	 * Adds item
+	 * Register an item.
 	 *
-	 * Adds the item only if no item of that name already exists
+	 * Registers the item if no item of that name already exists.
 	 *
-	 * @param string $handle Script name
+	 * @access public
-	 * @param string $src Script url
+	 * @since 2.1.0
-	 * @param array $deps (optional) Array of script names on which this script depends
+	 *
-	 * @param string $ver (optional) Script version (used for cache busting)
+	 * @param string $handle Unique item name.
-	 * @return array Hierarchical array of dependencies
+	 * @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.
 	 */
-	function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {
+	public function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {
 		if ( isset($this->registered[$handle]) )
 			return false;
 		$this->registered[$handle] = new _WP_Dependency( $handle, $src, $deps, $ver, $args );
@@ -189,16 +223,19 @@ class WP_Dependencies {
 	}
 
 	/**
-	 * Adds extra data
+	 * Add extra item data.
 	 *
-	 * Adds data only if script has already been added.
+	 * Adds data to a registered item.
 	 *
-	 * @param string $handle Script name
+	 * @access public
-	 * @param string $key
+	 * @since 2.6.0
-	 * @param mixed $value
+	 *
-	 * @return bool success
+	 * @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.
 	 */
-	function add_data( $handle, $key, $value ) {
+	public function add_data( $handle, $key, $value ) {
 		if ( !isset( $this->registered[$handle] ) )
 			return false;
 
@@ -206,17 +243,18 @@ class WP_Dependencies {
 	}
 
 	/**
-	 * Get extra data
+	 * Get extra item data.
 	 *
-	 * Gets data associated with a certain handle.
+	 * Gets data associated with a registered item.
 	 *
-	 * @since WP 3.3
+	 * @access public
+	 * @since 3.3.0
 	 *
-	 * @param string $handle Script name
+	 * @param string $handle Name of the item. Should be unique.
-	 * @param string $key
+	 * @param string $key    The data key.
-	 * @return mixed
+	 * @return mixed Extra item data (string), false otherwise.
 	 */
-	function get_data( $handle, $key ) {
+	public function get_data( $handle, $key ) {
 		if ( !isset( $this->registered[$handle] ) )
 			return false;
 
@@ -226,12 +264,34 @@ class WP_Dependencies {
 		return $this->registered[$handle]->extra[$key];
 	}
 
-	function remove( $handles ) {
+	/**
+	 * 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 ) {
 		foreach ( (array) $handles as $handle )
 			unset($this->registered[$handle]);
 	}
 
-	function enqueue( $handles ) {
+	/**
+	 * 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 ) {
 		foreach ( (array) $handles as $handle ) {
 			$handle = explode('?', $handle);
 			if ( !in_array($handle[0], $this->queue) && isset($this->registered[$handle[0]]) ) {
@@ -242,7 +302,18 @@ class WP_Dependencies {
 		}
 	}
 
-	function dequeue( $handles ) {
+	/**
+	 * 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 ) {
 		foreach ( (array) $handles as $handle ) {
 			$handle = explode('?', $handle);
 			$key = array_search($handle[0], $this->queue);
@@ -253,8 +324,17 @@ class WP_Dependencies {
 		}
 	}
 
-
+	/**
-	function query( $handle, $list = 'registered' ) {
+	 * 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' ) {
 		switch ( $list ) {
 			case 'registered' :
 			case 'scripts': // back compat
@@ -277,7 +357,18 @@ class WP_Dependencies {
 		return false;
 	}
 
-	function set_group( $handle, $recursion, $group ) {
+	/**
+	 * 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 ) {
 		$group = (int) $group;
 
 		if ( $recursion )
@@ -292,8 +383,16 @@ class WP_Dependencies {
 		return true;
 	}
 
-}
+} // WP_Dependencies
 
+/**
+ * Class _WP_Dependency
+ *
+ * Helper class to register a handle and associated data.
+ *
+ * @access private
+ * @since 2.6.0
+ */
 class _WP_Dependency {
 	/**
 	 * The handle name.
@@ -351,16 +450,32 @@ class _WP_Dependency {
 	 */
 	var $extra = array();
 
+	/**
+	 * Setup dependencies.
+	 *
+	 * @since 2.6.0
+	 */
 	function __construct() {
 		@list( $this->handle, $this->src, $this->deps, $this->ver, $this->args ) = func_get_args();
 		if ( ! is_array($this->deps) )
 			$this->deps = array();
 	}
 
+	/**
+	 * 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.
+	 */
 	function add_data( $name, $data ) {
 		if ( !is_scalar($name) )
 			return false;
 		$this->extra[$name] = $data;
 		return true;
 	}
-}
+
+} // _WP_Dependencies