SectionContentManagerMap Class Reference

Maintains the map of SectionContentManagers for different Section types. More...

Static Public Member Functions
static	registerManager ($type, $manager)
	Registers a SectionContentManager for handling a specified section type. More...
static	getManager ($section)
	Retrieves the SectionContentManager object for the specified section. More...
static	isSectionTypeRegistered ($section_type)
	Check whether a SectionContentManager has been registered for the specified type. More...
static	getRegisteredTypes ()
	Returns the list of registered section content types. More...
static	onInitialize ()

Detailed Description

Maintains the map of SectionContentManagers for different Section types.

Components can register a custom SectionManager type by consuming the RegisterSectionManagers event and calling SectionManagerMap::registerSectionManager().

Author

andy

Definition at line 78 of file section_manager.inc.

Member Function Documentation

getManager()

static SectionContentManagerMap::getManager (   $section )

static

Retrieves the SectionContentManager object for the specified section.

Parameters

Section

$section

the Section object for which the manager is to be retrieved

Returns

the SectionContentManager object that will resolve content for this section

Exceptions

FakoliException

Definition at line 100 of file section_manager.inc.

     {
          $mgr = SectionContentManagerMap::$map[$section->section_type];
          if (!$mgr)
          {
               throw new FakoliException("Unknown section manager for section '{$section->section}'");
          }
          
          return $mgr;
     }

getRegisteredTypes()

static SectionContentManagerMap::getRegisteredTypes ( )

static

Returns the list of registered section content types.

Returns

array the list of registered section content types in alphabetical order

Definition at line 125 of file section_manager.inc.

     {
          $types = array_keys(SectionContentManagerMap::$map);
          sort($types);
          return $types;
     }

isSectionTypeRegistered()

static SectionContentManagerMap::isSectionTypeRegistered (   $section_type )

static

Check whether a SectionContentManager has been registered for the specified type.

Parameters

string

$section_type

the type of Section

Returns

boolen true if a SectionContentManager has been registered for this type, false otherwise

Definition at line 116 of file section_manager.inc.

     {
          return array_key_exists($section_type, SectionContentManagerMap::$map);
     }

onInitialize()

static SectionContentManagerMap::onInitialize ( )

static

Definition at line 132 of file section_manager.inc.

     {
          trace("Registering Section Content Managers", 4);
          ComponentManager::fireEvent('RegisterSectionContentManagers');
     }

registerManager()

static SectionContentManagerMap::registerManager (   $type,   $manager  )

static

Registers a SectionContentManager for handling a specified section type.

Parameters

string	$type	the type of section to be managed by the registered object
object	$manager	the section manager object that will resolve content requests for sections of the given type.

Definition at line 88 of file section_manager.inc.

     {
          trace("Section Type '{$type}' will be managed by ".get_class($manager), 4);
          SectionContentManagerMap::$map[$type] = $manager;
     }

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/section/section_manager.inc