SectionContent Class Reference

Inherits DataItem.

Public Member Functions
	Section ()
	SectionContentModuleXrefs ($constraint="ORDER BY position, sort_order")
	getModulesByPosition ($constraint="ORDER BY position, sort_order")
	getTemplate ()
	Loads the default template associated with this section. More...
	getPositions ()
	Retrieves an array of the position names defined in the template for this page. More...
	getBodyClass ()
	Returns any custom body CSS classes defined for this section content. More...
	addToSection ($section_folder)
	Add this SectionContent to the specified Section. More...

Static Public Member Functions
static	getMappedContent ($identifier)

Public Attributes
	$primary_key = "section_content_id"
	$table = "section_content"
	$fields
	$relations

Detailed Description

Definition at line 250 of file section.inc.

Member Function Documentation

addToSection()

SectionContent::addToSection

(

$section_folder

)

Add this SectionContent to the specified Section.

This is intended for newly created SectionContent and will throw an exception if the section_id field is already populated, or if there is already a SectionContent item with the same identifier mapped to the the target section

Parameters

string

$section_folder

the folder identifying the target Section

Definition at line 387 of file section.inc.

     {
          if ($this->section_id)
          {
               throw new FakoliException("Attempt to map section content that is already mapped to a section");
          }
          
          $section = Section::findSection($section_folder);
          if (!$section)
          {
               throw new FakoliException("Unrecognized section '$section_folder'");
          }
          
          if (SectionManager::isInSection($section_folder, $this->identifier)) return;
          
          $this->section_id = $section->section_id;
          $this->save();
     }

getBodyClass()

SectionContent::getBodyClass

(

)

Returns any custom body CSS classes defined for this section content.

Definition at line 374 of file section.inc.

     {
          return $this->body_class ? $this->body_class : $this->Section()->default_body_class;
     }

getMappedContent()

static SectionContent::getMappedContent (   $identifier )

static

Definition at line 324 of file section.inc.

     {
          $content = Query::create(SectionContent, "WHERE identifier=:i")
                              ->bind(":i", $identifier)
                              ->execute();
          
          return $content;
     }

getModulesByPosition()

SectionContent::getModulesByPosition

(

$constraint = "ORDER BY position, sort_order"

)

Definition at line 283 of file section.inc.

     {
          if (!$this->section_content_id)
          {
               // Mocked SectionContent object
               return array();
          }
          
          $modules = Cache::get("section_content_module_map_{$this->section_content_id}");
          if (!$modules)
          {
               $join = new InnerJoin();
               $join->add(Module);
               $join->add(SectionContentModuleXref);
                    
               $result = $join->groupedQuery("WHERE section_content_id={$this->section_content_id} $constraint", "SectionContentModuleXref.position");
               $modules = extractGroupedJoinResults(Module, $result);
                    
               if (count($modules) > 0)
               {
                    // 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;
     }

getPositions()

SectionContent::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 358 of file section.inc.

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

getTemplate()

SectionContent::getTemplate

(

)

Loads the default template associated with this section.

Returns

string the contents of the template for this section.

Definition at line 338 of file section.inc.

     {
          global $config;
          
          if ($this->template)
          {
               $template = file_get_contents("{$config['homedir']}/templates/{$this->template}");
          }
          else
          {
               $template = $this->Section()->getDefaultTemplate();
          }
          
          return $template;
     }

Section()

SectionContent::Section

(

)

Definition at line 272 of file section.inc.

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

SectionContentModuleXrefs()

SectionContent::SectionContentModuleXrefs

(

$constraint = "ORDER BY position, sort_order"

)

Definition at line 278 of file section.inc.

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

Member Data Documentation

$fields

SectionContent::$fields

Initial value:

= array("section_content_id"  =>   Number,
                              "section_id"             =>   String,
                              "identifier"             =>   String,
                              "role"                        =>   String,
                              "permissions"            =>   String,
                              "template"                    =>   String,
                              "body_class"             =>   String,
                              "override_page_title"    =>  String,
                              "use_SSL"                =>   Boolean)

Definition at line 257 of file section.inc.

$primary_key

SectionContent::$primary_key = "section_content_id"

Definition at line 252 of file section.inc.

$relations

SectionContent::$relations

Initial value:

= array(
                              "Section"                     =>   Section,
                              "SectionContentModuleXrefs"   =>   SectionContentModuleXref
     )

Definition at line 267 of file section.inc.

$table

SectionContent::$table = "section_content"

Definition at line 253 of file section.inc.

---

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

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