X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/3f5685912e89eb3b0534acd85aa0946b1ca2bbe3..refs/tags/wordpress-4.5:/wp-includes/class.wp-dependencies.php

diff --git a/wp-includes/class.wp-dependencies.php b/wp-includes/class.wp-dependencies.php
index 54afdef0..03484181 100644
--- a/wp-includes/class.wp-dependencies.php
+++ b/wp-includes/class.wp-dependencies.php
@@ -1,58 +1,116 @@
 <?php
 /**
- * BackPress Scripts enqueue.
+ * Dependencies API: WP_Dependencies base class
  *
- * These classes were refactored from the WordPress WP_Scripts and WordPress
- * script enqueue API.
+ * @since 2.6.0
  *
- * @package BackPress
- * @since r74
+ * @package WordPress
+ * @subpackage Dependencies
  */
 
 /**
- * BackPress enqueued dependiences class.
+ * Core base class extended to register items.
  *
- * @package BackPress
+ * @package WordPress
+ * @since 2.6.0
  * @uses _WP_Dependency
- * @since r74
  */
 class WP_Dependencies {
-	var $registered = array();
-	var $queue = array();
-	var $to_do = array();
-	var $done = array();
-	var $args = array();
-	var $groups = array();
-	var $group = 0;
-
-	function WP_Dependencies() {
-		$args = func_get_args();
-		call_user_func_array( array(&$this, '__construct'), $args );
-	}
+	/**
+	 * An array of registered handle objects.
+	 *
+	 * @access public
+	 * @since 2.6.8
+	 * @var array
+	 */
+	public $registered = array();
 
-	function __construct() {}
+	/**
+	 * An array of queued _WP_Dependency handle objects.
+	 *
+	 * @access public
+	 * @since 2.6.8
+	 * @var array
+	 */
+	public $queue = array();
 
 	/**
-	 * Do the dependencies
+	 * An array of _WP_Dependency handle objects to queue.
 	 *
-	 * Process the items passed to it or the queue.  Processes all dependencies.
+	 * @access public
+	 * @since 2.6.0
+	 * @var array
+	 */
+	public $to_do = array();
+
+	/**
+	 * An array of _WP_Dependency handle objects already queued.
 	 *
-	 * @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
+	 * @access public
+	 * @since 2.6.0
+	 * @var array
 	 */
-	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 );
+	public $done = array();
 
-		foreach( $this->to_do as $key => $handle ) {
-			if ( !in_array($handle, $this->done) && isset($this->registered[$handle]) ) {
+	/**
+	 * An array of additional arguments passed when a handle is registered.
+	 *
+	 * Arguments are appended to the item query string.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var array
+	 */
+	public $args = array();
 
-				if ( ! $this->registered[$handle]->src ) { // Defines a group.
-					$this->done[] = $handle;
-					continue;
-				}
+	/**
+	 * An array of handle groups to enqueue.
+	 *
+	 * @access public
+	 * @since 2.8.0
+	 * @var array
+	 */
+	public $groups = array();
+
+	/**
+	 * A handle group to enqueue.
+	 *
+	 * @access public
+	 * @since 2.8.0
+	 * @deprecated 4.5.0
+	 * @var int
+	 */
+	public $group = 0;
+
+	/**
+	 * Processes the items and dependencies.
+	 *
+	 * Processes the items passed to it or the queue, and their dependencies.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @since 2.8.0 Added the `$group` parameter.
+	 *
+	 * @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.
+		 */
+		$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]) ) {
+				/*
+				 * 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;
 
@@ -63,20 +121,36 @@ class WP_Dependencies {
 		return $this->done;
 	}
 
-	function do_item( $handle ) {
+	/**
+	 * Processes 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
+	 * Determines 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.
 	 *
-
-	 * @param mixed handles Accepts (string) dep name or (array of strings) dep names
-	 * @param bool recursion Used internally when function calls itself
+	 * @access public
+	 * @since 2.1.0
+	 * @since 2.6.0 Moved from `WP_Scripts`.
+	 * @since 2.8.0 Added the `$group` parameter.
+	 *
+	 * @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 int|false $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;
 
@@ -88,27 +162,28 @@ class WP_Dependencies {
 			if ( in_array($handle, $this->done, true) ) // Already done
 				continue;
 
-			$moved = $this->set_group( $handle, $recursion, $group );
+			$moved     = $this->set_group( $handle, $recursion, $group );
+			$new_group = $this->groups[ $handle ];
 
 			if ( $queued && !$moved ) // already queued and in the right group
 				continue;
 
 			$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?)
-			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.
+			elseif ( $this->registered[$handle]->deps && !$this->all_deps( $this->registered[$handle]->deps, true, $new_group ) )
+				$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.
+					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]) )
@@ -121,17 +196,25 @@ class WP_Dependencies {
 	}
 
 	/**
-	 * Adds item
+	 * Register an item.
+	 *
+	 * Registers the item if no item of that name already exists.
 	 *
-	 * Adds the item only if no item of that name already exists
+	 * @access public
+	 * @since 2.1.0
+	 * @since 2.6.0 Moved from `WP_Scripts`.
 	 *
-	 * @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
+	 * @param string           $handle Name of the item. Should be unique.
+	 * @param string           $src    Full URL of the item, or path of the item relative to the WordPress root directory.
+	 * @param array            $deps   Optional. An array of registered item handles this item depends on. Default empty array.
+	 * @param string|bool|null $ver    Optional. String specifying item version number, if it has one, which is added to the URL
+	 *                                 as a query string for cache busting purposes. If version is set to false, a version
+	 *                                 number is automatically added equal to current installed WordPress version.
+	 *                                 If set to null, no version is added.
+	 * @param mixed            $args   Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer. 
+	 * @return bool Whether the item has been registered. 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 );
@@ -139,27 +222,77 @@ 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
-	 * @param string data_name Name of object in which to store extra data
-	 * @param array data Array of extra data
-	 * @return bool success
+	 * @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.
 	 */
-	function add_data( $handle, $data_name, $data ) {
-		if ( !isset($this->registered[$handle]) )
+	public function add_data( $handle, $key, $value ) {
+		if ( !isset( $this->registered[$handle] ) )
 			return false;
-		return $this->registered[$handle]->add_data( $data_name, $data );
+
+		return $this->registered[$handle]->add_data( $key, $value );
 	}
 
-	function remove( $handles ) {
+	/**
+	 * Get extra item data.
+	 *
+	 * Gets data associated with a registered item.
+	 *
+	 * @access public
+	 * @since 3.3.0
+	 *
+	 * @param string $handle Name of the item. Should be unique.
+	 * @param string $key    The data key.
+	 * @return mixed Extra item data (string), false otherwise.
+	 */
+	public function get_data( $handle, $key ) {
+		if ( !isset( $this->registered[$handle] ) )
+			return false;
+
+		if ( !isset( $this->registered[$handle]->extra[$key] ) )
+			return false;
+
+		return $this->registered[$handle]->extra[$key];
+	}
+
+	/**
+	 * Un-register an item or items.
+	 *
+	 * @access public
+	 * @since 2.1.0
+	 * @since 2.6.0 Moved from `WP_Scripts`.
+	 *
+	 * @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
+	 * @since 2.6.0 Moved from `WP_Scripts`.
+	 *
+	 * @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]]) ) {
@@ -170,7 +303,19 @@ 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
+	 * @since 2.6.0 Moved from `WP_Scripts`.
+	 *
+	 * @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);
@@ -181,65 +326,184 @@ class WP_Dependencies {
 		}
 	}
 
-	function query( $handle, $list = 'registered' ) { // registered, queue, done, to_do
-		switch ( $list ) :
-		case 'registered':
-		case 'scripts': // back compat
-			if ( isset($this->registered[$handle]) )
-				return $this->registered[$handle];
-			break;
-		case 'to_print': // back compat
-		case 'printed': // back compat
-			if ( 'to_print' == $list )
-				$list = 'to_do';
-			else
-				$list = 'printed';
-		default:
-			if ( in_array($handle, $this->$list) )
+	/**
+	 * Recursively search the passed dependency tree for $handle
+	 *
+	 * @since 4.0.0
+	 *
+	 * @param array  $queue  An array of queued _WP_Dependency handle objects.
+	 * @param string $handle Name of the item. Should be unique.
+	 * @return bool Whether the handle is found after recursively searching the dependency tree.
+	 */
+	protected function recurse_deps( $queue, $handle ) {
+		foreach ( $queue as $queued ) {
+			if ( ! isset( $this->registered[ $queued ] ) ) {
+				continue;
+			}
+
+			if ( in_array( $handle, $this->registered[ $queued ]->deps ) ) {
+				return true;
+			} elseif ( $this->recurse_deps( $this->registered[ $queued ]->deps, $handle ) ) {
 				return true;
-			break;
-		endswitch;
+			}
+		}
+
 		return false;
 	}
 
-	function set_group( $handle, $recursion, $group ) {
-		$group = (int) $group;
+	/**
+	 * Query list for an item.
+	 *
+	 * @access public
+	 * @since 2.1.0
+	 * @since 2.6.0 Moved from `WP_Scripts`.
+	 *
+	 * @param string $handle Name of the item. Should be unique.
+	 * @param string $list   Property name of list array.
+	 * @return bool|_WP_Dependency Found, or object Item data.
+	 */
+	public function query( $handle, $list = 'registered' ) {
+		switch ( $list ) {
+			case 'registered' :
+			case 'scripts': // back compat
+				if ( isset( $this->registered[ $handle ] ) )
+					return $this->registered[ $handle ];
+				return false;
+
+			case 'enqueued' :
+			case 'queue' :
+				if ( in_array( $handle, $this->queue ) ) {
+					return true;
+				}
+				return $this->recurse_deps( $this->queue, $handle );
+
+			case 'to_do' :
+			case 'to_print': // back compat
+				return in_array( $handle, $this->to_do );
+
+			case 'done' :
+			case 'printed': // back compat
+				return in_array( $handle, $this->done );
+		}
+		return false;
+	}
 
-		if ( $recursion )
-			$group = min($this->group, $group);
-		else
-			$this->group = $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 ( isset($this->groups[$handle]) && $this->groups[$handle] <= $group )
+		if ( isset( $this->groups[ $handle ] ) && $this->groups[ $handle ] <= $group ) {
 			return false;
+		}
+
+		$this->groups[ $handle ] = $group;
 
-		$this->groups[$handle] = $group;
 		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 {
-	var $handle;
-	var $src;
-	var $deps = array();
-	var $ver = false;
-	var $args = null;
+	/**
+	 * The handle name.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var null
+	 */
+	public $handle;
+
+	/**
+	 * The handle source.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var null
+	 */
+	public $src;
+
+	/**
+	 * An array of handle dependencies.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var array
+	 */
+	public $deps = array();
+
+	/**
+	 * The handle version.
+	 *
+	 * Used for cache-busting.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var bool|string
+	 */
+	public $ver = false;
+
+	/**
+	 * Additional arguments for the handle.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var null
+	 */
+	public $args = null;  // Custom property, such as $in_footer or $media.
 
-	var $extra = array();
+	/**
+	 * Extra data to supply to the handle.
+	 *
+	 * @access public
+	 * @since 2.6.0
+	 * @var array
+	 */
+	public $extra = array();
 
-	function _WP_Dependency() {
-		@list($this->handle, $this->src, $this->deps, $this->ver, $this->args) = func_get_args();
-		if ( !is_array($this->deps) )
+	/**
+	 * Setup dependencies.
+	 *
+	 * @since 2.6.0
+	 */
+	public function __construct() {
+		@list( $this->handle, $this->src, $this->deps, $this->ver, $this->args ) = func_get_args();
+		if ( ! is_array($this->deps) )
 			$this->deps = array();
-		if ( !$this->ver )
-			$this->ver = false;
 	}
 
-	function add_data( $name, $data ) {
+	/**
+	 * 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.
+	 */
+	public function add_data( $name, $data ) {
 		if ( !is_scalar($name) )
 			return false;
 		$this->extra[$name] = $data;
 		return true;
 	}
-}
+
+} // _WP_Dependencies