content
Packages
Interfaces
Classes
Files

Class: SiteMap

Source Location: /content/sitemap/site_map.class.php [line 80]

Class Overview


Describes the map of the site. Can be exported according to any text form by using a template configuration. A site map contains some links, some link sections and some module maps (which also contain links and sections).

Author(s):



Class Details

Describes the map of the site. Can be exported according to any text form by using a template configuration. A site map contains some links, some link sections and some module maps (which also contain links and sections).

Tags:

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


Class Methods

constructor SiteMap [line 86]

SiteMap SiteMap( [ $site_name = ''], [SiteMapElement[] $elements = null])
Builds a SiteMap object with its elements

Parameters:

SiteMapElement[]   $elements   List of the elements it contains
   $site_name  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method add [line 125]

void add( SiteMapElement $element)
Adds an element to the elements list of the SiteMap

Parameters:

SiteMapElement   $element   The element to add
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method build_kernel_map [line 179]

void build_kernel_map( [ $mode = SITE_MAP_USER_MODE], [ $auth_mode = SITE_MAP_AUTH_GUEST])
Adds to the site map all the kernel links.

Parameters:

   $mode  
   $auth_mode  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method build_modules_maps [line 164]

void build_modules_maps( )
Adds to the site map all maps of the installed modules
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method export [line 141]

string export( &$export_config, SiteMapExportConfig $export_config)
Exports a SiteMap. You will be able to use the following variables into the templates used to export:
  • C_SITE_MAP which is a condition indicating if it's a site map (useful if you want to use a sigle template for the whole export configuration)
  • SITE_NAME which contains the name of the site
  • A loop "element" in which the code of each element is in the variable CODE

Tags:

  • return: The exported code of the SiteMap

Parameters:

SiteMapExportConfig   $export_config   Export configuration
   &$export_config  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method get_site_name [line 99]

string get_site_name( )
Returns the name of the site

Tags:

  • return: name
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method set_site_name [line 108]

void set_site_name( string $site_name)
Sets the name of the site. The default value is the name of the site taken from the site configuration.

Parameters:

string   $site_name   name of the site
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Variables

[line 231]   SiteMapElement[]  $elements  = array()

Tags:

    [ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    [line 235]   string  $site_name  =  ''

    Tags:

      [ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
      Documentation generated on Tue, 28 Jul 2009 22:43:41 +0200 by phpDocumentor 1.4.1