Index: src/wp-includes/class.wp-dependencies.php =================================================================== --- src/wp-includes/class.wp-dependencies.php (revision 25513) +++ src/wp-includes/class.wp-dependencies.php (working copy) @@ -1,20 +1,13 @@ 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: + * add( 'scriptaculous', false, array( 'scriptaculous-dragdrop', 'scriptaculous-slider', 'scriptaculous-controls' ) ); + * + * 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. + */ if ( $this->do_item( $handle, $group ) ) $this->done[] = $handle; @@ -56,20 +69,34 @@ return $this->done; } - function do_item( $handle ) { + /** + * Process a dependency. + * + * @access public + * @since Unknown + * + * @param string $handle Unique item name. + * @return bool True on success, false on failure. + */ + 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 Unknown * - * @param mixed $handles Accepts (string) dep name or (array of strings) dep names - * @param bool $recursion Used internally when function calls itself + * @param mixed $handles (string) Dependency handle and argument or (array of strings) Dependency handles and arguments. + * @param bool $recursion Internal flag that function is calling itself. + * @param mixed $group Group level: (int) level, (false) no groups. + * @return bool Success */ - function all_deps( $handles, $recursion = false, $group = false ) { + public function all_deps( $handles, $recursion = false, $group = false ) { if ( !$handles = (array) $handles ) return false; @@ -88,20 +115,20 @@ $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]) ) @@ -114,17 +141,21 @@ } /** - * 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 - * @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 + * @access public + * @since Unknown + * + * @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. */ - 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 ); @@ -132,16 +163,19 @@ } /** - * 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 $key - * @param mixed $value - * @return bool success + * @access public + * @since Unknown + * + * @param string $handle Unique item name. + * @param string $key Data key. + * @param mixed $value 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; @@ -149,17 +183,18 @@ } /** - * 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 $key - * @return mixed + * @param string $handle Unique item name. + * @param string $key Data key. + * @return mixed (string) Extra item data, false otherwise. */ - function get_data( $handle, $key ) { + public function get_data( $handle, $key ) { if ( !isset( $this->registered[$handle] ) ) return false; @@ -169,12 +204,35 @@ return $this->registered[$handle]->extra[$key]; } - function remove( $handles ) { + /** + * Unregister and item or items. + * + * @access public + * @since Unknown + * + * @param mixed $handles (string) Item handle or (array of strings) Item handles. + * @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 Unknown + * + * @param mixed $handles (string) Item handle and argument or (array of strings) Item handles and arguments + * @return void + */ + public function enqueue( $handles ) { foreach ( (array) $handles as $handle ) { $handle = explode('?', $handle); if ( !in_array($handle[0], $this->queue) && isset($this->registered[$handle[0]]) ) { @@ -185,7 +243,19 @@ } } - 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 Unknown + * + * @param mixed $handles (string) Item handle and argument or (array of strings) Item handles and arguments + * @return void + */ + public function dequeue( $handles ) { foreach ( (array) $handles as $handle ) { $handle = explode('?', $handle); $key = array_search($handle[0], $this->queue); @@ -196,8 +266,17 @@ } } - - function query( $handle, $list = 'registered' ) { + /** + * Query list for an item. + * + * @access public + * @since Unknown + * + * @param string $handle The item handle. + * @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 @@ -220,7 +299,18 @@ return false; } - function set_group( $handle, $recursion, $group ) { + /** + * Set item group, unless already in a lower group. + * + * @access public + * @since Unknown + * + * @param string $handle The item handle. + * @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 ) @@ -235,8 +325,16 @@ 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; @@ -246,16 +344,32 @@ 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