ComponentPageView Class Reference

ComponentPageView generates the page content for a component page, substituting page fields, menus and associated modules into an HTML template. More...

Public Member Functions
	__construct ($page, $template="")
	Creates a new ComponentPageView object. More...
	drawView ()
	Renders the page. More...

Static Public Member Functions
static	renderPage ($identifier)
	Renders the component page that matches the specified identifier. More...

Public Attributes
	$page
	The ComponentPage object that we are viewing. More...
	$template
	The layout template used to render the page. More...

Detailed Description

ComponentPageView generates the page content for a component page, substituting page fields, menus and associated modules into an HTML template.

Author

andy

Definition at line 48 of file component_page_view.inc.

Constructor & Destructor Documentation

__construct()

ComponentPageView::__construct	(		$page,
			$template = ""
	)

Creates a new ComponentPageView object.

Parameters

ComponentPage	$page	the page to be displayed
string	$template	the template to use (default is to use the template specified by the ComponentPage object)

Definition at line 82 of file component_page_view.inc.

     {
          $this->page = $page;
          $this->template = $template;  
     }

Member Function Documentation

drawView()

ComponentPageView::drawView

(

)

Renders the page.

Definition at line 91 of file component_page_view.inc.

     {
          global $config;
          global $method;
          global $user;
          global $script;
          global $styles;
          global $breadcrumbs;
          global $dialogs;
          global $page;
          global $site;
          global $section;
          global $menu_identifier;
          global $identifier;
          global $section;
          global $css_cache_timestamp;
          global $fontawesome;
          
          $page = $this->page; // Pass through to code include
          
          if ($section)
          {
               $site = $section->Site();
          }
          else
          {
               $site = $page->Site();
          }
          
          if(!$site)
               $site = Site::getSite(); // Pass through to code include
          
          $template = $this->page->getTemplate();
          
          Fakoli::applicationTraceLevel();
          
          try 
          {
               $template = ComponentManager::fireEvent("PreProcessPage", $template);
               
               // If the page has a PHP code include, execute it and insert the contents
               
               ob_start();
               include $page->server_path;
               $output = ob_get_contents();
               ob_end_clean();
          
               $output = ComponentManager::fireEvent("PostProcessContent", $output);
          } 
          catch (DataNotFoundException $e) 
          {
               // AJG: Wrap DataNotFoundExceptions so they don't show a 'this resource is disabled error
               throw new FakoliException($e->getMessage());
          }
          
          $this->page->description .= $output;
 
          Fakoli::coreTraceLevel();
          
          // Populate template fields from the Page object.
          
          $this->page->page_title = $this->page->getTitle();
          
          $bodyClass = $this->page->getBodyClass();
          
          foreach($this->page->getFields() as $field => $type)
          {
               $template = str_replace("{".$field."}", $this->page->get($field), $template);
          }         
          
          $template = str_replace("{body_class}", $bodyClass, $template);
          $template = str_replace("{description}", $output, $template);
          //if (!$title) $title = $this->page->getTitle();
          //$template = str_replace("{page_title}", $title, $template);
          $template = str_replace("{meta_tag_description}", $site->meta_tag_description, $template);
          $template = str_replace("{meta_tag_keyword}", $site->meta_tag_keyword, $template);
          
          $qs = $_SERVER['QUERY_STRING'];
          $identifier = $_REQUEST["identifier"];
          
          $qs = preg_replace("/identifier=[\\w_]+&*/", "", $qs);
          $qs = preg_replace("/_style=\\w+&*/", "", $qs);
          
          // JDG 2/8/2012 - remove "/" before identifier so that it resolves to correct section
          $printLink = "{$this->page->identifier}".appendToQueryString($qs, "_style=print");
          
          $template = str_replace("{printIcon}", 
               "<a href='$printLink' target='_blank'><img src='/fakoli/images/print.gif' style='display: inline-block; vertical-align: middle;border: none'></a>&nbsp;<a href='$printLink' target='_blank'>Print this Page</a>",
               $template);
          
          // Populate the template with the appropriate menu(s).
          
          $menuPositions = array();
          
          preg_match_all("/\{menu:(.*?)\}/", $template, $menuPositions, PREG_SET_ORDER);
          
          $menus = indexedQuery(Menu, "WHERE site_id={$site->site_id}", "identifier");
          
          foreach($menuPositions as $position)
          {
               $output = "";
               
               trace("Substituting Menu at Position {$position[0]} {$position[1]}", 3);
                              
               if (array_key_exists($position[1], $menus))
               {
                    $view = new MenuView($menus[$position[1]]);
                    $menuBody = $view->drawView();
                    if ($menuBody)
                    {
                         $menuCSSClass = $menus[$position[1]]->container_css_class;;
                         $menuCSSClass = $menuCSSClass ? " class='{$menuCSSClass}'" : "";
                         $output .= "<div id='$position[1]'{$menuCSSClass}>";                       
                         $output .= $menuBody; 
                         $output .= "</div>";
                    }              
               }
               
               $template = str_replace($position[0], $output, $template);            
          }
          
          
          
          // Populate the template with associated modules for the page at the correct positions.
          
          $positions = array();
          
          preg_match_all("/\{position:(.*?)\}/", $template, $positions, PREG_SET_ORDER);
          
          $modules = $this->page->getModulesByPosition();
     
          foreach($positions as $position)
          {
               $output = "";
               
               trace("Substituting at Position {$position[0]} {$position[1]}", 3);
                              
               if (array_key_exists($position[1], $modules))
               {
                    $output .= "<div id='$position[1]'>";
                    
                    foreach($modules[$position[1]] as $module)
                    {
                         $view = ModuleView::create($module);
                         $output .= $view->drawView();
                    }
                    
                    $output .= "</div>";                    
               }
               
               $template = str_replace($position[0], $output, $template);
          }
          
          // Direct inclusion of module by path
          // Generally discouraged, but sometimes the best solution
          
          $inclusions = array();
          preg_match_all("/\{include:(.*?\.inc)\}/", $template, $inclusions, PREG_SET_ORDER);
          
          foreach($inclusions as $inclusion)
          {
               trace("Substituting include $inclusion[1]",1);
               $output = Fakoli::evaluateFile($inclusion[1]);
               $template = str_replace($inclusion[0], $output, $template);
          }
          
          // Pull in the script and style dependencies defined by the components
          
          if ($_REQUEST["_style"] != "nude")
          {
               $script = Fakoli::getScripts() . $script;
               $styles = Fakoli::getStyles() . $styles;          
          }
          
          $script = ComponentManager::fireEvent("PostProcessScript", $script);
          $styles = ComponentManager::fireEvent("PostProcessStyles", $styles);
          
          // Populate global variable references
          
          $vars = array();
          
          preg_match_all("/\{var:(.*?)\}/", $template, $vars, PREG_SET_ORDER);
          
          foreach($vars as $var)
          {         
               $expr = $var[0];
               $name = $var[1];
               global ${$name};
                    
               $template = str_replace($expr, ${$name}, $template);
          }
          
          // Populate stored value references
          
          $gets = array();
          
          preg_match_all("/\{get:(.*?)\}/", $template, $gets, PREG_SET_ORDER);
          foreach($gets as $get)
          {
               $expr = $get[0];
               $name = $get[1];
               $value = Fakoli::get($name);
               
               $template = str_replace($expr, $value, $template);
          }
          
          if ($config['prettyURLs'] === false)
          {
               $template = preg_replace("/(href|src|action)=(['\"])\\/?([\\w\\d_]+?)\\?/i", "$1=$2/page.php?identifier=$3&", $template);
               $template = preg_replace("/(href|src|action)=(['\"])\\/?([\\w\\d_]+?)[\"']/i", "$1=$2/page.php?identifier=$3$2", $template);
               $template = preg_replace("/go\\(([\"'])\\/?([\\w\\d_]+?)\\?/", "go($1/page.php?identifier=$2&", $template);
               $template = preg_replace("/go\\(([\"'])\\/?([\\w\\d_]+?)[\"']/", "go($1/page.php?identifier=$2$1", $template);
               
          }
          
          $template = ComponentManager::fireEvent("PostProcessPage", $template);
          
          return $template;
     }

renderPage()

static ComponentPageView::renderPage (   $identifier )

static

Renders the component page that matches the specified identifier.

Automatically redirects to login if the user doesn't have correct permissions.

Parameters

string

$identifier

the identifier of the component page

Definition at line 56 of file component_page_view.inc.

     {
          $page = ComponentPage::findByIdentifier($identifier, "WHERE enabled=1");
 
          $pageView = new ComponentPageView($page, "{$page->template}.tpl");
 
          $page_role = $page->role;
 
          if (!checkRole($page->role))
          {
               LoginManager::storeRedirectPage();
               redirect("/login");
          }
 
          echo $pageView->drawView();
     }

Member Data Documentation

$page

ComponentPageView::$page

The ComponentPage object that we are viewing.

Definition at line 73 of file component_page_view.inc.

$template

ComponentPageView::$template

The layout template used to render the page.

Definition at line 74 of file component_page_view.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/component/component_page_view.inc