content
Packages
Interfaces
Classes
Files

Class: SitemapExportConfig

Source Location: /content/sitemap/site_map_export_config.class.php [line 41]

Class Overview



Configuration used to export a SiteMap. It contains some Template objects which are used to export each kind of elements of a sitemap. Using different configurations will enable you for example to export in HTML code to be displayed in a page of the web site (the site map) or to be written in the sitemap.xml file at the root of your site, this file will be read by the search engines to optimize the research of your site.

		

	    
Author(s):

	    
	




		





    

    
    

        
Methods

        
    

    		











Class Details


Configuration used to export a SiteMap. It contains some Template objects which are used to export each kind of elements of a sitemap. Using different configurations will enable you for example to export in HTML code to be displayed in a page of the web site (the site map) or to be written in the sitemap.xml file at the root of your site, this file will be read by the search engines to optimize the research of your site.
    
Tags:

    

        
    




[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]



	

	
Class Methods

	
  

    
    
constructor SitemapExportConfig [line 50]

    

    

    

        SitemapExportConfig SitemapExportConfig(

$site_map_file, mixed
$module_map_file, mixed
$section_file, mixed
$link_file)
    

    

    
        
Builds a SiteMapExportConfig object

    
        
Parameters:

    

    

          

        mixed  
        $module_map_file  
        The template used to export a ModuleMap object. Can be a Template object or a string (path of the template to use).
      

          

        mixed  
        $section_file  
        The template used to export a SiteMapSection object. Can be a Template object or a string (path of the template to use).
      

          

        mixed  
        $link_file  
        The template used to export a SiteMapLink object. Can be a Template object or a string (path of the template to use).
      

          

          
        $site_map_file  
        
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_link_stream [line 90]

    

    

    

        Template get_link_stream(
)
    

    

    
        
Returns the Template object to use while exporting a SiteMapLink object.

    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_module_map_stream [line 72]

    

    

    

        Template get_module_map_stream(
)
    

    

    
        
Returns the Template object to use while exporting a ModuleMap object.

    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_section_stream [line 81]

    

    

    

        Template get_section_stream(
)
    

    

    
        
Returns the Template object to use while exporting a SiteMapSection object.

    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_site_map_stream [line 63]

    

    

    

        Template get_site_map_stream(
)
    

    

    
        
Returns the Template object to use while exporting a SiteMap object.

    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method set_link_stream [line 126]

    

    

    

        void set_link_stream(
mixed
$link_file)
    

    

    
        
Sets the Template object to use while exporting a SiteMapLink object.

    
        
Parameters:

    

    

          

        mixed  
        $link_file  
        The template used to export a SiteMapLink object. Can be a Template object or a string (path of the template to use).
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method set_module_map_stream [line 108]

    

    

    

        void set_module_map_stream(
mixed
$module_map_file)
    

    

    
        
Sets the Template object to use while exporting a ModuleMap object.

    
        
Parameters:

    

    

          

        mixed  
        $module_map_file  
        The template used to export a ModuleMap object. Can be a Template object or a string (path of the template to use).
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method set_section_stream [line 117]

    

    

    

        void set_section_stream(
mixed
$section_file)
    

    

    
        
Sets the Template object to use while exporting a SiteMapSection object.

    
        
Parameters:

    

    

          

        mixed  
        $section_file  
        The template used to export a SiteMapSection object. Can be a Template object or a string (path of the template to use).
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method set_site_map_stream [line 99]

    

    

    

        void set_site_map_stream(

$site_map_file, mixed
$module_map_file)
    

    

    
        
Sets the Template object to use while exporting a Site object.

    
        
Parameters:

    

    

          

        mixed  
        $module_map_file  
        The template used to export a Site object. Can be a Template object or a string (path of the template to use).
      

          

          
        $site_map_file  
        
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  





    

    
Class Variables

    
                            

                            
                [line 149]  
                Template 
                $link_file 
                                                

                    
Tags:

    

        
    
    
    
                
    
                                    
    
                    
    
        
    [ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                    
    
                            
                [line 140]  
                Template 
                $module_map_file 
                                                
    
                    
    Tags:
    
    
    
        
      
    
      
                
      
                                    
      
                    
      
        
      [ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                      
      
                            
                [line 145]  
                Template 
                $section_file 
                                                
      
                    
      Tags:
      
    
      
        
        
    
        
                
        
                                    
        
                    
        
        
        [ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                        
        
                            
                [line 135]  
                Template 
                $site_map_file 
                                                
        
                    
        Tags:
        
    
        
        
          
    
          
                
          
                                    
          
                    
          
        
          [ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
              
          


                      		
        
          
            
          
    
    
                   
    
          
    
          Documentation generated on Tue, 28 Jul 2009 22:43:41 +0200 by phpDocumentor 1.4.1
          

          
			
          
			
	        
          
				

           

           

          Annonces