content
Packages
Interfaces
Classes
Files

Class: ModuleMap

Source Location: /content/sitemap/module_map.class.php [line 39]

Class Overview

SiteMapElement
   |
   --SiteMapSection
      |
      --ModuleMap
The ModuleMap class represents the map of a module. It has a description (generally the module description) and contains some elements which can be some simple links or some sections (which can match the categories for example).

Author(s):



Class Details

The ModuleMap class represents the map of a module. It has a description (generally the module description) and contains some elements which can be some simple links or some sections (which can match the categories for example).

Tags:

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


Class Methods

constructor ModuleMap [line 45]

ModuleMap ModuleMap( SiteMapLink $link)
Builds a ModuleMap object

Parameters:

SiteMapLink   $link   Link associated to the root of the module
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method export [line 84]

void export( &$export_config, SiteMapExportConfig $export_config)
Exports the sitemap (according to a configuration of templates). In your template, you will be able to use the following variables:
  • MODULE_NAME which contains the name of the module
  • MODULE_DESCRIPTION which contains the description of the module
  • MODULE_URL which contains the URL of the module root page
  • DEPTH which is the depth of the module map in the sitemap (generally 1). It might be usefull to apply different CSS styles to each level of depth.
  • LINK_CODE which contains the code of the link associated to the module root exported with the same configuration.
  • C_MODULE_MAP which is a boolean whose value is true, this will enable you to use a single template for the whole export configuration
  • The loop "element" for which the variable CODE contains the code of each sub element of the module (for example categories)
Overrides SiteMapSection::export() (Exports the section according to the given configuration. You will use the following template variables:
  • SECTION_NAME which contains the name of the section
  • SECTION_URL which contains the URL of the link associated to the section
  • DEPTH which contains the depth of the section in the site map tree (useful for CSS classes names)
  • LINK_CODE which contains the code got by the associated link export
  • C_SECTION, boolean meaning that it's a section (useful if you want to use a sigle template for the whole export configuration)
  • A loop "element" containing evert element of the section (their code is available in the CODE variable of the loop)
)

Parameters:

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

method get_description [line 55]

string get_description( )
Return the module description
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method set_description [line 64]

void set_description( string $description)
Sets the description of the module

Parameters:

string   $description   Description of the module
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Variables

[line 112]   string  $description 

Tags:

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

    Inherited Methods

    Class: SiteMapSection

    SiteMapSection::SiteMapSection()
    Builds a SiteMapSection object
    SiteMapSection::add()
    Adds an elemement to the section
    SiteMapSection::export()
    Exports the section according to the given configuration. You will use the following template variables:
    • SECTION_NAME which contains the name of the section
    • SECTION_URL which contains the URL of the link associated to the section
    • DEPTH which contains the depth of the section in the site map tree (useful for CSS classes names)
    • LINK_CODE which contains the code got by the associated link export
    • C_SECTION, boolean meaning that it's a section (useful if you want to use a sigle template for the whole export configuration)
    • A loop "element" containing evert element of the section (their code is available in the CODE variable of the loop)
    SiteMapSection::get_link()
    Returns the link associated to the section
    SiteMapSection::set_depth()
    Sets the depth of the element
    SiteMapSection::set_link()
    Sets the link associated to the section

    Class: SiteMapElement

    SiteMapElement::SiteMapElement()
    Builds a SiteMapElement object
    SiteMapElement::export()
    Exports the element
    SiteMapElement::get_depth()
    Returns the depth of the element in the tree
    SiteMapElement::get_name()
    Returns the name of the menu
    SiteMapElement::set_depth()
    Sets the depth of the element


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