Section DataItem, defining the data model for sections within a site. More...

Inherits DataItem.

Public Member Functions
	SectionModuleXrefs ($constraint="ORDER BY position, sort_order")

	Modules ($constraint="ORDER BY position, sort_order")

	Content ($constraint="")

	Site ()

	getContentManager ()

	getContent ($identifier)

	getTemplateFile ($identifier)

	getRole ($identifier)

	getPermissions ($identifier)

	getModulesByPosition ($constraint="ORDER BY position, sort_order")

	clearModuleCache ()

	getSectionURL ()
	Returns the Section URL. More...

	getDefaultTemplate ()
	Loads the default template associated with this section. More...

	getDefaultPage ()
	Returns the path to the default page for this section. More...

	getPositions ()
	Retrieves an array of the position names defined in the template for this page. More...

Static Public Member Functions
static	createFromIdentifier ($identifier)

static	findSection ($section_name)

Public Attributes
	$primary_key = "section_id"

	$table = "section"

	$fields

	$relations

	$_content = array()

Detailed Description

Section DataItem, defining the data model for sections within a site.

Author: Andy Green

Definition at line 44 of file section.inc.

Member Function Documentation

◆ clearModuleCache()

Section::clearModuleCache ( )

Definition at line 188 of file section.inc.

      {
           Cache::invalidate("section_module_map_{$this->section_id}");
      }

◆ Content()

Section::Content ( $constraint = "" )

Definition at line 80 of file section.inc.

      {
           return $this->getRelatedList(SectionContent, "", $constraint);
      }

◆ createFromIdentifier()

static Section::createFromIdentifier ( $identifier )

static

Definition at line 95 of file section.inc.

      {
           if (!$identifier) return null;
  
           $site = Site::getSite();
           
           try
           {
                return Query::create(Section, "WHERE section=:identifier AND site_id=:site")
                               ->bind(":identifier", $identifier, ":site", $site->site_id)
                               ->executeSingle();
           }
           catch(Exception $e)
           {
                ComponentManager::fireEvent("SectionNotFound", $identifier);
                throw new FakoliException("Unknown or ambiguous section '$identifier'");
           }         
      }

◆ findSection()

static Section::findSection ( $section_name )

static

Definition at line 145 of file section.inc.

      {
           $site = Site::getSite();
           
           $sections = Query::create(Section, "WHERE section=:section AND site_id=:site")
                ->bind(":section", $section_name, ":site", $site->site_id)
                ->execute();
           
           return (count($sections) > 0) ? $sections[0] : null;
      }

◆ getContent()

Section::getContent ( $identifier )

Definition at line 116 of file section.inc.

      {
           if ($this->_content[$identifier]) return $this->_content[$identifier];
           SectionManager::ensureContentManager();
           
           return SectionContentManagerMap::getManager($this)->getContent($this, $identifier);
      }

◆ getContentManager()

Section::getContentManager ( )

Definition at line 90 of file section.inc.

      {
           return SectionContentManagerMap::getManager($this);
      }

◆ getDefaultPage()

Section::getDefaultPage ( )

Returns the path to the default page for this section.

Definition at line 226 of file section.inc.

      {
           $url = $this->getSectionURL();
           return $url . $this->default_page;
      }

◆ getDefaultTemplate()

Section::getDefaultTemplate ( )

Loads the default template associated with this section.

Returns: string the contents of the template for this section.

Definition at line 213 of file section.inc.

      {
           $directory = $this->Site()->getThemeDirectory();
           $file = $directory . DIRECTORY_SEPARATOR . $this->default_template;
           trace("Template File: $file", 3);
           $template = file_get_contents($file);
  
           return $template;
      }

◆ getModulesByPosition()

Section::getModulesByPosition ( $constraint = "ORDER BY position, sort_order" )

Definition at line 156 of file section.inc.

      {
           $modules = Cache::get("section_module_map_{$this->section_id}");
           if (!$modules)
           {
                $join = new InnerJoin();
                $join->add(Module);
                $join->add(SectionModuleXref);
                
                $result = $join->groupedQuery("WHERE section_id={$this->section_id} $constraint", "SectionModuleXref.position");
                $modules = extractGroupedJoinResults(Module, $result);
                
                // Merge in global modules
                $globals = groupedQuery(Module, "WHERE global=1", "global_position");
                foreach($globals as $position => $modulesAtPosition)
                {
                     if (array_key_exists($position, $modules))
                     {
                          $modules[$position] = removeDuplicates(array_merge($modulesAtPosition, $modules[$position]));
                     }
                     else
                     {
                          $modules[$position] = $modulesAtPosition;
                     }
                }
                
                Cache::put("section_module_map_{$this->section_id}", $modules);
           }
                     
           return $modules;
      }

◆ getPermissions()

Section::getPermissions ( $identifier )

Definition at line 138 of file section.inc.

      {
           $content = is_object($identifier) ? $identifier : $this->getContent($identifier);
           if ($content->permissions) return $content->permissions;
           return $this->default_permissions;
      }

◆ getPositions()

Section::getPositions ( )

Retrieves an array of the position names defined in the template for this page.

Returns: array the positions defined in the template (sorted alphabetically)

Definition at line 236 of file section.inc.

      {
           $template = $this->getDefaultTemplate();
           
           $positionMatches = array();
           
           preg_match_all("/\{position:(.*?)\}/", $template, $positionMatches, PREG_PATTERN_ORDER);
           
           $positions = $positionMatches[1];       
           sort($positions);
           return $positions;
      }    

◆ getRole()

Section::getRole ( $identifier )

Definition at line 131 of file section.inc.

      {
           $content = is_object($identifier) ? $identifier : $this->getContent($identifier);
           if ($content->role) return $content->role;
           return $this->default_role;
      }

◆ getSectionURL()

Section::getSectionURL ( )

Returns the Section URL.

Definition at line 197 of file section.inc.

      {
           global $config;
      
           $url = "http" . (($this->use_SSL) ? "s" : "") . "://{$config['http_host']}/";
           if ($this->section != "/")
           {
                $url .= $this->section . "/";
           }
           return $url;
      }

◆ getTemplateFile()

Section::getTemplateFile ( $identifier )

Definition at line 124 of file section.inc.

      {
           $content = is_object($identifier) ? $identifier : $this->getContent($identifier);
           if ($content->template) return $content->template;
           return $this->default_template;
      }

◆ Modules()

Section::Modules ( $constraint = "ORDER BY position, sort_order" )

Definition at line 75 of file section.inc.

      {
           return $this->crossReference(Module, SectionModuleXref, $constraint);
      }

◆ SectionModuleXrefs()

Section::SectionModuleXrefs ( $constraint = "ORDER BY position, sort_order" )

Definition at line 70 of file section.inc.

      {
           return $this->getRelatedList(SectionModuleXref, "", $constraint);
      }

◆ Site()

Section::Site ( )

Definition at line 85 of file section.inc.

      {
           return $this->getRelated(Site);
      }

Member Data Documentation

◆ $_content

Section::$_content = array()

Definition at line 114 of file section.inc.

◆ $fields

Section::$fields

Initial value:

= array("section_id"               =>   Number,
                              "section"                =>   String,
                              "section_title"               =>   String,
                              "default_template"       =>   String,
                              "default_role"           =>   String,
                              "default_permissions"    =>   String,
                              "default_page"           =>   String,
                              "default_body_class"     =>   String,
                              "site_id"                =>   Number,
                              "use_SSL"                =>   Boolean,
                              "section_type"           =>   String
     )

Definition at line 51 of file section.inc.

◆ $primary_key

Section::$primary_key = "section_id"

Definition at line 46 of file section.inc.

◆ $relations

Section::$relations