enmi-conf.org: comparison wp/wp-includes/class.wp-dependencies.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 <?php
 /**
-* BackPress Scripts enqueue
+* Dependencies API: WP_Dependencies base class
 *
-* Classes were refactored from the WP_Scripts and WordPress script enqueue API.
+* @since 2.6.0
 *
-* @since BackPress r74
+* @package WordPress
+* @subpackage Dependencies
+*/
+/**
+* Core base class extended to register items.
 *
-* @package BackPress
+* @since 2.6.0
-* @uses _WP_Dependency
+*
-* @since r74
+* @see _WP_Dependency
 */
 class WP_Dependencies {
 	/**
 	 * An array of registered handle objects.
 	 *
-	 * @access public
 	 * @since 2.6.8
 	 * @var array
 	 */
 	public $registered = array();
 	/**
 	 * An array of queued _WP_Dependency handle objects.
 	 *
-	 * @access public
 	 * @since 2.6.8
 	 * @var array
 	 */
 	public $queue = array();
 	/**
 	 * An array of _WP_Dependency handle objects to queue.
 	 *
-	 * @access public
 	 * @since 2.6.0
 	 * @var array
 	 */
 	public $to_do = array();
 	/**
 	 * An array of _WP_Dependency handle objects already queued.
 	 *
-	 * @access public
 	 * @since 2.6.0
 	 * @var array
 	 */
 	public $done = array();
 	/**
 	 * 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();
 	/**
 	 * 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;
 	/**
-	 * Process the items and dependencies.
+	 * 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.1.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.
 	 */
 		 * 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 ) {
+		foreach ( $this->to_do as $key => $handle ) {
 			if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) {
-				/*
-				 * 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.
 		return $this->done;
 	}
 	/**
-	 * Process a dependency.
+	 * 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]);
 	}
 	/**
-	 * Determine dependencies.
+	 * Determines dependencies.
 	 *
 	 * Recursively builds an array of items to process taking
 	 * dependencies into account. Does NOT catch infinite loops.
 	 *
-	 * @access public
+	 * @since 2.1.0
-	 * @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 mixed     $handles   Item handle and argument (string) or item handles and arguments (array of strings).
-	 * @param mixed $group     Group level: (int) level, (false) no groups.
+	 * @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.
 	 */
 	public function all_deps( $handles, $recursion = false, $group = false ) {
 		if ( !$handles = (array) $handles )
 			return false;
 			$queued = in_array($handle, $this->to_do, true);
 			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; // Item doesn't exist.
 			elseif ( $this->registered[$handle]->deps && array_diff($this->registered[$handle]->deps, array_keys($this->registered)) )
 				$keep_going = false; // Item requires dependencies that don't exist.
-			elseif ( $this->registered[$handle]->deps && !$this->all_deps( $this->registered[$handle]->deps, true, $group ) )
+			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 item or its dependencies don't exist.
 				if ( $recursion )
 					return false; // Abort this branch.
 	/**
 	 * Register an item.
 	 *
 	 * Registers the item if no item of that name already exists.
 	 *
-	 * @access public
+	 * @since 2.1.0
-	 * @since 2.1.0
+	 * @since 2.6.0 Moved from `WP_Scripts`.
 	 *
-	 * @param string $handle Unique item name.
+	 * @param string           $handle Name of the item. Should be unique.
-	 * @param string $src    The item url.
+	 * @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 item handle strings on which this item depends.
+	 * @param array            $deps   Optional. An array of registered item handles this item depends on. Default empty array.
-	 * @param string $ver    Optional. Version (used for cache busting).
+	 * @param string|bool|null $ver    Optional. String specifying item version number, if it has one, which is added to the URL
-	 * @param mixed  $args   Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer.
+	 *                                 as a query string for cache busting purposes. If version is set to false, a version
-	 * @return bool True on success, false on failure.
+	 *                                 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.
 	 */
 	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 );
 	/**
 	 * Add extra item data.
 	 *
 	 * Adds data to a registered item.
 	 *
-	 * @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.
 	/**
 	 * 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.
 	}
 	/**
 	 * Un-register an item or items.
 	 *
-	 * @access public
+	 * @since 2.1.0
-	 * @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 ) {
 	 * 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.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 ) {
 	 * 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.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 ) {
 	 *
 	 * @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 boolean Whether the handle is found after recursively searching the dependency tree.
+	 * @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;
 	}
 	/**
 	 * Query list for an item.
 	 *
-	 * @access public
+	 * @since 2.1.0
-	 * @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 Found, or object Item data.
+	 * @return bool|_WP_Dependency Found, or object Item data.
 	 */
 	public function query( $handle, $list = 'registered' ) {
 		switch ( $list ) {
 			case 'registered' :
 			case 'scripts': // back compat
 	}
 	/**
 	 * 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 )
+		if ( isset( $this->groups[ $handle ] ) && $this->groups[ $handle ] <= $group ) {
-			$group = min($this->group, $group);
+			return false;
-		else
+		}
-			$this->group = $group;
+		$this->groups[ $handle ] = $group;
-		if ( isset($this->groups[$handle]) && $this->groups[$handle] <= $group )
-			return false;
-		$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 {
-	/**
-	 * 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.
-	/**
-	 * Extra data to supply to the handle.
-	 *
-	 * @access public
-	 * @since 2.6.0
-	 * @var array
-	 */
-	public $extra = array();
-	/**
-	 * 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();
-	}
-	/**
-	 * 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

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9