WordPress 4.3-scripts
[autoinstalls/wordpress.git] / wp-includes / class-wp-walker.php
index 547defee81c7d4fcf3a959f7afc47e3114261350..65d8a5869a70bc9c57564f0eefe9a85974eccd54 100644 (file)
@@ -16,28 +16,36 @@ class Walker {
         * What the class handles.
         *
         * @since 2.1.0
-        * @var string
         * @access public
+        * @var string
         */
-       var $tree_type;
+       public $tree_type;
 
        /**
         * DB fields to use.
         *
         * @since 2.1.0
         * @var array
-        * @access protected
         */
-       var $db_fields;
+       public $db_fields;
 
        /**
         * Max number of pages walked by the paged walker
         *
         * @since 2.7.0
         * @var int
-        * @access protected
         */
-       var $max_pages = 1;
+       public $max_pages = 1;
+
+       /**
+        * Whether the current element has children or not.
+        *
+        * To be used in start_el().
+        *
+        * @since 4.0.0
+        * @var bool
+        */
+       public $has_children;
 
        /**
         * Starts the list before the elements are added.
@@ -52,7 +60,7 @@ class Walker {
         * @param int    $depth  Depth of the item.
         * @param array  $args   An array of additional arguments.
         */
-       function start_lvl( &$output, $depth = 0, $args = array() ) {}
+       public function start_lvl( &$output, $depth = 0, $args = array() ) {}
 
        /**
         * Ends the list of after the elements are added.
@@ -67,7 +75,7 @@ class Walker {
         * @param int    $depth  Depth of the item.
         * @param array  $args   An array of additional arguments.
         */
-       function end_lvl( &$output, $depth = 0, $args = array() ) {}
+       public function end_lvl( &$output, $depth = 0, $args = array() ) {}
 
        /**
         * Start the element output.
@@ -84,7 +92,7 @@ class Walker {
         * @param array  $args              An array of additional arguments.
         * @param int    $current_object_id ID of the current item.
         */
-       function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {}
+       public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {}
 
        /**
         * Ends the element output, if needed.
@@ -99,7 +107,7 @@ class Walker {
         * @param int    $depth  Depth of the item.
         * @param array  $args   An array of additional arguments.
         */
-       function end_el( &$output, $object, $depth = 0, $args = array() ) {}
+       public function end_el( &$output, $object, $depth = 0, $args = array() ) {}
 
        /**
         * Traverse elements to create list from elements.
@@ -119,23 +127,24 @@ class Walker {
         * @param int    $depth             Depth of current element.
         * @param array  $args              An array of arguments.
         * @param string $output            Passed by reference. Used to append additional content.
-        * @return null Null on failure with no changes to parameters.
         */
-       function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
-
-               if ( !$element )
+       public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
+               if ( ! $element ) {
                        return;
+               }
 
                $id_field = $this->db_fields['id'];
+               $id       = $element->$id_field;
 
                //display this element
-               if ( isset( $args[0] ) && is_array( $args[0] ) )
-                       $args[0]['has_children'] = ! empty( $children_elements[$element->$id_field] );
+               $this->has_children = ! empty( $children_elements[ $id ] );
+               if ( isset( $args[0] ) && is_array( $args[0] ) ) {
+                       $args[0]['has_children'] = $this->has_children; // Backwards compatibility.
+               }
+
                $cb_args = array_merge( array(&$output, $element, $depth), $args);
                call_user_func_array(array($this, 'start_el'), $cb_args);
 
-               $id = $element->$id_field;
-
                // descend only when the depth is right and there are childrens for this element
                if ( ($max_depth == 0 || $max_depth > $depth+1 ) && isset( $children_elements[$id]) ) {
 
@@ -178,18 +187,15 @@ class Walker {
         * @param int   $max_depth The maximum hierarchical depth.
         * @return string The hierarchical item output.
         */
-       function walk( $elements, $max_depth) {
-
+       public function walk( $elements, $max_depth ) {
                $args = array_slice(func_get_args(), 2);
                $output = '';
 
-               if ($max_depth < -1) //invalid parameter
-                       return $output;
-
-               if (empty($elements)) //nothing to walk
+               //invalid parameter or nothing to walk
+               if ( $max_depth < -1 || empty( $elements ) ) {
                        return $output;
+               }
 
-               $id_field = $this->db_fields['id'];
                $parent_field = $this->db_fields['parent'];
 
                // flat display
@@ -263,20 +269,20 @@ class Walker {
         *
         * @since 2.7.0
         *
-        * @param int $max_depth The maximum hierarchical depth.
-        * @param int $page_num  The specific page number, beginning with 1.
-        * @return string XHTML of the specified page of elements
-        */
-       function paged_walk( $elements, $max_depth, $page_num, $per_page ) {
-
-               /* sanity check */
-               if ( empty($elements) || $max_depth < -1 )
+        * @param array $elements
+        * @param int   $max_depth The maximum hierarchical depth.
+        * @param int   $page_num The specific page number, beginning with 1.
+        * @param int   $per_page
+        * @return string XHTML of the specified page of elements
+        */
+       public function paged_walk( $elements, $max_depth, $page_num, $per_page ) {
+               if ( empty( $elements ) || $max_depth < -1 ) {
                        return '';
+               }
 
                $args = array_slice( func_get_args(), 4 );
                $output = '';
 
-               $id_field = $this->db_fields['id'];
                $parent_field = $this->db_fields['parent'];
 
                $count = -1;
@@ -375,8 +381,12 @@ class Walker {
                return $output;
        }
 
-       function get_number_of_root_elements( $elements ){
-
+       /**
+        *
+        * @param array $elements
+        * @return int
+        */
+       public function get_number_of_root_elements( $elements ){
                $num = 0;
                $parent_field = $this->db_fields['parent'];
 
@@ -387,11 +397,16 @@ class Walker {
                return $num;
        }
 
-       // Unset all the children for a given top level element.
-       function unset_children( $e, &$children_elements ){
-
-               if ( !$e || !$children_elements )
+       /**
+        * Unset all the children for a given top level element.
+        *
+        * @param object $e
+        * @param array $children_elements
+        */
+       public function unset_children( $e, &$children_elements ){
+               if ( ! $e || ! $children_elements ) {
                        return;
+               }
 
                $id_field = $this->db_fields['id'];
                $id = $e->$id_field;
@@ -400,9 +415,7 @@ class Walker {
                        foreach ( (array) $children_elements[$id] as $child )
                                $this->unset_children( $child, $children_elements );
 
-               if ( isset($children_elements[$id]) )
-                       unset( $children_elements[$id] );
-
+               unset( $children_elements[ $id ] );
        }
 
 } // Walker