Page Class Reference

Inheritance diagram for Page:

Collaboration diagram for Page:

Public Member Functions
	PageModuleXrefs ($constraint="ORDER BY position, sort_order")
	Modules ($constraint="ORDER BY position, sort_order")
	Site ()
	getModulesByPosition ($constraint="ORDER BY position, sort_order")
	getTemplate ()
	Loads the template associated with this page. More...
	getPositions ()
	Retrieves an array of the position names defined in the template for this page. More...
	getBodyClass ()
	Page ()
	search ($params, $range=null)
	DataItems must implement this method to provide search functionality. More...

Static Public Member Functions
static	findByIdentifier ($identifier)

Public Attributes
	$fields
	$relations
	$versioned_fields = array("page_title", "description", "meta_tag_description", "meta_tag_keyword", "author")

Detailed Description

Definition at line 42 of file page.inc.

Member Function Documentation

findByIdentifier()

static Page::findByIdentifier (   $identifier )

static

Definition at line 85 of file page.inc.

     {
          $match = Query::create(Page, "WHERE identifier=:id")
                           ->bind(":id", $identifier)
                           ->executeSingle();
 
          return $match;
     }    

getBodyClass()

Page::getBodyClass

(

)

Definition at line 204 of file page.inc.

     {
          if (Fakoli::$bodyClass) return Fakoli::$bodyClass;
          
          global $section;
          if ($section)
          {
               $content = $section->getContent($this->identifier);
               if ($content) return $content->body_class ? $content->body_class : $section->default_body_class;
          }
     
          return "";
     }

getModulesByPosition()

Page::getModulesByPosition

(

$constraint = "ORDER BY position, sort_order"

)

Definition at line 94 of file page.inc.

     {
          global $section;
          global $identifier;
          
          $join = new InnerJoin();
          $join->add(Module);
          $join->add(PageModuleXref);
          
          $result = $join->groupedQuery("WHERE page_id={$this->page_id} $constraint", "PageModuleXref.position");
          $modules = extractGroupedJoinResults(Module, $result);
 
          // If no modules have been set, use the section defaults
          if (count($modules) == 0 && $section)
          {
               $content = $section->getContent($identifier);
               if ($content) $modules = $content->getModulesByPosition($constraint);
          }
          
          if (count($modules) == 0 && $section)
          {
               $modules = $section->getModulesByPosition($constraint);
          }
          
          // 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;
               }
          }
          
          return $modules;
     }

getPositions()

Page::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 191 of file page.inc.

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

getTemplate()

Page::getTemplate

(

)

Loads the template associated with this page.

Returns

string the contents of the template for this page.

Definition at line 140 of file page.inc.

     {
          global $config;
          global $section;
          
          $style = $_REQUEST["_style"];
          $site = $this->Site();
          if (!$site)
          {
               $site = Site::getSite();
          }
          
          $templateFile = "";
          
          switch($style)
          {
          case 'print':
               $templateFile = $site->print_template;
               break;
 
          case 'popup':
               $templateFile = $site->popup_template;
               break;
               
          case 'mobile':
               $templateFile = $site->mobile_template;
               
          case 'nude':
               return "<h2>{page_title}</h2>{description}";
          }
          
          if ($section)
          {
               if (!$templateFile) $templateFile = $section->getTemplateFile($this->identifier);
          }
 
          if (!$templateFile) $templateFile = $this->template;
          if (!$templateFile) $templateFile = $site->default_template;
                    
          $templateFile = ComponentManager::fireEvent("OverrideTemplate", $templateFile);
 
          $base = $site->getThemeDirectory();
          $template = file_get_contents("{$base}/{$templateFile}");
 
          return $template;
     }

Modules()

Page::Modules

(

$constraint = "ORDER BY position, sort_order"

)

Definition at line 75 of file page.inc.

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

Page()

Page::Page

(

)

Definition at line 232 of file page.inc.

     {
          $this->primary_key = "page_id";
          $this->table = "page";
          
          $this->default_format = "{page_title}";
          
          $this->DataItem(func_get_args());
     }

PageModuleXrefs()

Page::PageModuleXrefs

(

$constraint = "ORDER BY position, sort_order"

)

Definition at line 70 of file page.inc.

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

search()

Page::search	(		$params,
			$range = null
	)

DataItems must implement this method to provide search functionality.

Parameters

mixed	$params	either search text or a SearchParameters object
array	$range	an array of primary key IDs to which the search must be constrained

Implements Searchable.

Definition at line 242 of file page.inc.

     {
          trace("Searching Pages", 3);
          
          if ($range)
          {
               $range = " AND {$this->primary_key} IN (".implode($range, ", ").")";
          }
          
          if (is_object($params))
          {
               $search = clone $params;
               $search->target = $this;
               $search->remapField("title", "page_title");
               $search->remapField("keywords", "meta_tag_keyword");             
               $search->remapField("publication_date", "created_date");
               
               if (!$search->get("text", "like"))
               {
                    $search->secondaryFields("meta_tag_keyword", "description");
               }
 
               
               $constraint = $search->generateConstraint();
               $constraint .= $constraint ? " AND published=1 AND exclude_from_search=0" : " WHERE published=1 AND exclude_from_search=0";
               $constraint .= $range;
               
               $pages = Query::create(Page, $constraint)
                                ->execute();
          }
          else
          {
               $params = "%$params%";
               $pages = Query::create(Page, "WHERE (page_title like :a OR description LIKE :b) AND published=1 AND exclude_from_search=0 $range")
                                ->bind(":a", $params, ":b", $params)
                                ->execute();
          }
                                     
          return SearchManager::wrap($pages, PageSearchResult);
     }

Site()

Page::Site

(

)

Definition at line 80 of file page.inc.

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

Member Data Documentation

$fields

Page::$fields

Initial value:

= array("page_id"                  =>   Number,
                              "identifier"             =>   String,
                              "page_title"             =>   String,
                              "description"            =>   HTML,
                              "site_id"                =>  Number,
                              "template"                    =>   String,
                              "meta_tag_description"   =>   Text,
                              "meta_tag_keyword"       =>   String,
                              "php_code_file"               =>   String,
                              "role"                   =>   String,
                              "published"                   =>   Boolean,
                              "exclude_from_search"    =>   Boolean,
                              "created_date"                =>   Date,
                              "edited_date"            =>   Timestamp,
                              "author"                 =>  String
     )

Definition at line 45 of file page.inc.

$relations

Page::$relations

Initial value:

= array("PageModuleXrefs"     =>   PageModuleXref,
                                 "Modules"             =>   Module,
                                 "Site"                =>   Site)

Definition at line 64 of file page.inc.

$versioned_fields

Page::$versioned_fields = array("page_title", "description", "meta_tag_description", "meta_tag_keyword", "author")

Definition at line 68 of file page.inc.

---

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

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