<?php 


         /**
          * These Functions are Specific to the Advanced Sidebar Menu
          * @author Mat Lipe
          * @since 5.19.13
          * 
          * @package Advanced Sidebar Menu
          */
class advancedSidebarMenu{
      var $instance; //The widget instance 
      var $top_id; //Either the top cat or page
      var $exclude;
      var $ancestors; //For the category ancestors
      var $count = 1; //Count for grandchild levels
      var $order_by;
         
         
      
      /**
       * Checks if a widgets checkbox is checked.
       * * this one is special and does a double check
       * 
       * @since 4.1.3
       * 
       * @param string $name - name of checkbox
       */   
      function checked($name){
      
        if( isset( $this->instance[$name] ) && $this->instance[$name] == 'checked' ) return true;
        
        return false;
          
      }   
         
      /**
       * Retrieves the Highest level Category Id
       * 
       * @since 4.1.3
       * @param int $catId - id of cat looking for top parent of
       * 
       * @return int
       */   
       function getTopCat( $catId ){
             $cat_ancestors = array();
             $cat_ancestors[] = $catId ;
       
            do {
                $cat_id = get_category($cat_id);
                $cat_id = $cat_id->parent;
                $cat_ancestors[] = $cat_id; 
            }
             while ($cat_id);
       
            
             //Reverse the array to start at the last
             $this->ancestors = array_reverse( $cat_ancestors );
             
             //forget the [0] because the parent of top parent is always 0
             return $this->ancestors[1];
           
       }
       
       
       
      /**   
       * Removes the closing </li> tag from a list item to allow for child menus inside of it
       * 
       * @param string $item - an <li></li> item
       * @return string|bool
       * @since 4.7.13
       */
      function openListItem($item = false){
          if( !$item ) return false;
          
          return substr(trim($item), 0, -5);
      }   
         
      /**
       * The Old way of doing thing which displayed all 3rd levels and below when on a second level page
       * This is only here for people afraid of change who liked the old way of doing things
       * 
       * @uses used in views -> page_list.php when legacy mode is checked in widget
       * @since 4.7.13
       */   
      function grandChildLegacyMode($pID ){
          #-- if the link that was just listed is the current page we are on
            if( !$this->page_ancestor( $pID ) ) return;

                //Get the children of this page
                $grandkids = $this->page_children($pID->ID );                
                if( $grandkids ){
                    #-- Create a new menu with all the children under it
                    $content .= '<ul class="grandchild-sidebar-menu">';
                            $content .= wp_list_pages("post_type=".$this->post_type."&sort_column=$this->order_by&title_li=&echo=0&exclude=".$this->instance['exclude']."&child_of=".$pID->ID);

                    $content .= '</ul>';
                }
                
                return $content;
      }    
                  
         
     /**   
      * Displays all the levels of the Grandchild Menus
      * 
      * Will run until there are no children left for the current page's hyercy
      * Only displays the pages if we are on a child or grandchild page of the Id sent 
      * which at the time of creation comes from the child level pages
      * 
      * 
      * @uses called by the widget view page_list.php
      * @since 4.0
      * 
      * @since 4.7.13
      */
     function displayGrandChildMenu($page){
        static $count = 0;
        $count++;

        //If the page sent is not a child of the current page
        if( !$this->page_ancestor($page) ) return;
        
        //if there are no children of the current page bail
        if( !$children = $this->page_children($page->ID) ) return;

       $content .= sprintf('<ul class="grandchild-sidebar-menu level-%s children">',$count );
        foreach( $children as $child ){
            

            $args = array(
                  'post_type' => $this->post_type,
                  'sort_column' => $this->order_by,
                  'title_li'    => '',
                  'echo'        => 0,
                  'depth'       => 1,
                  'exclude'     => join(',',$this->exclude),
                  'include'     => $child->ID
                  );
                  
            $content .= $this->openListItem(wp_list_pages($args));

            //If this newly outputed child is a direct parent of the current page
            if( $this->page_ancestor($child) ){
               $content .= $this->displayGrandChildMenu($child);
            }
            
            $content .= '</li>';
        
       }
       $content .= '</ul>';
       
       return $content; 
        
    }
         
         
         
         
         
         /**
          * Adds the class for current page item etc to the page list when using a custom post type
          * @param array $css the currrent css classes
          * @param obj $this_menu_item the page being checked
          * @return array
          * @since 10.10.12
          */
    function custom_post_type_css($css, $this_menu_item){
             global $post;
             if ( isset($post->ancestors) && in_array($this_menu_item->ID, (array)$post->ancestors) ){
                 $css[] = 'current_page_ancestor';
             }
             if ( $this_menu_item->ID == $post->ID ){
                 $css[] = 'current_page_item';
             
             } elseif ($this_menu_item->ID == $post->post_parent ){
                 $css[] = 'current_page_parent';
             }
             return $css;
     }
         

    /**
     * 
     * IF this is a top level category
     * @param obj $cat the cat object
     */
    function first_level_category( $cat ){
        if( !in_array($cat->cat_ID, $this->exclude) && $cat->parent == $this->top_id){
            return true;
        } else {
            return false;
        }
    }
    
    /**
     * If the cat is a second level cat
     * @param obj $cat the cat
     * @since 10.12.12
     */
    function second_level_cat( $child_cat ){
        //if this is the currrent cat or a parent of the current cat
        if( $child_cat->cat_ID == get_query_var('cat' ) || in_array( $child_cat->cat_ID, $this->ancestors )){
            $all_children = array();
            $all_children = get_categories( array( 'child_of' => $child_cat->cat_ID ) );
            if( !empty( $all_children ) ){
                return true;
            } else {
                return false;
            }
            
        } else {
            return false;
        }
    }
    
    /**
     * Determines if all the children should be included
     * @since 5.19.13
     * @return bool
     */
    function display_all(){
    
        if( !isset( $this->instance['display_all'] ) ) return false;

        if( $this->instance['display_all'] == 'checked' ){
            return true;
        } else {
            return false;
        }
    }
    
    /**
     * 
     * Returns and array of all the children of a page
     * @param int $pID the id of the page
     * @since 4.8.13
     */
    function page_children( $pID ){
        global $wpdb, $table_prefix;
        return $wpdb->get_results( "SELECT ID FROM ".$table_prefix."posts WHERE post_parent = ".$pID." AND post_status='publish' ORDER By ".$this->order_by );
        
    }
    
    /**
     * 
     * Determines if this is an ancestor or the current post
     * @param obj $pID the post object
     * @since 7/19/12
     */
    function page_ancestor( $pID ){
        global $post;
        if($pID->ID == $post->ID or $pID->ID == $post->post_parent or @in_array($pID->ID, $post->ancestors) ){
            return true;
        } else {
            return false;
        }
    }
    
    
    /**
     * Determines if the parent page or cat should be included
     * @since 5.19.13
     * @return bool
     */
    function include_parent(){
        if( !isset( $this->instance['include_parent'] ) ) return false;
        if( ($this->instance['include_parent'] == 'checked') && (!in_array($this->top_id, $this->exclude)) ){
            return true;
        } else {
            return false;
        }
    }
    
   
    /**
     * Echos the title of the widget to the page
     * @since 5.19.13
     */
    function title(){
        if( $this->instance['title'] != '' ){
            $title = apply_filters('widget_title', $this->instance['title'], $this->args, $this->instance );
            echo $this->args['before_title'] . $title . $this->args['after_title'];
        }
        
    }
    
    
    /**
     * 
     * Checks is this id is excluded or not
     * @param int $id the id to check
     * @return bool
     */
    function exclude( $id ){
        if( !in_array( $id, $this->exclude ) ){
            return true;
        } else {
            return false;
        }
    }
    


    /**
    * Allows for Overwritting files in the child theme
    * @since 4.23.13
    * @param string $file the name of the file to overwrite
    */
         
     static function file_hyercy( $file, $legacy = false ){
        if ( $theme_file = locate_template(array('advanced-sidebar-menu/'.$file)) ) {
            $file = $theme_file;
        } elseif( $legacy ){
            $file = ADVANCED_SIDEBAR_LEGACY_DIR . $file;
        } else {
            $file = ADVANCED_SIDEBAR_VIEWS_DIR . $file;
        }
        return apply_filters( 'advanced_sidebar_menu_view_file', $file, $legacy );
    
    }

} //End class