StaticPagesController Class Reference
[StaticPages]

Controller for static pages. More...

Inheritance diagram for StaticPagesController:

List of all members.

Public Member Functions
	action_static ($page_data, $page)
	Load and display template.
	get_routes ()
	Return array of urls which are handled by this controller.
	on_event ($name, $params, &$result)
	Process events.
Protected Member Functions
	collect_templates ()
	Find all templates that form static pages.
	collect_templates_in_dir ($dir_path, $template_prefix)

---

Detailed Description

Controller for static pages.

Registers routes to all templates found in /view/templates/{lang}/static

Author:

Gerd Riesselmann

Definition at line 10 of file staticpages.controller.php.

---

Member Function Documentation

StaticPagesController::action_static	(	$	page_data,
		$	page
	)

Load and display template.

Parameters:

	PageData	$page_data
	string	$template

Definition at line 35 of file staticpages.controller.php.

                                                         {
                $path = 'static/' . $page;
                $template_file = TemplatePathResolver::resolve($path);
                if (!file_exists($template_file)) {
                        return CONTROLLER_NOT_FOUND;
                }
                
                $cache = $page_data->get_cache_manager();
                if ($cache) {
                        $cache->set_cache_duration(GyroDate::ONE_DAY);
                }
                $view = ViewFactory::create_view(IViewFactory::CONTENT, $template_file, $page_data);
                $view->render();
        }

StaticPagesController::collect_templates

(

)

[protected]

Find all templates that form static pages.

Returns:

array

Definition at line 55 of file staticpages.controller.php.

                                               {
                if (is_null($this->cache_templates)) {
                        $this->cache_templates = array();
                        $dirs = TemplatePathResolver::get_template_paths();
                        foreach($dirs as $dir) {
                                $statics_dir = $dir . 'static';
                                if (is_dir($statics_dir)) {
                                        $this->collect_templates_in_dir($statics_dir, '');
                                }
                        }
                }
                return $this->cache_templates;
        }

StaticPagesController::collect_templates_in_dir	(	$	dir_path,
		$	template_prefix
	)			[protected]

Definition at line 69 of file staticpages.controller.php.

                                                                                 {
                $it = new DirectoryIterator($dir_path);
                foreach($it as $fileinfo) {
                        if (!$fileinfo->isDot()) {
                                $file = $fileinfo->getFilename();
                                if ($fileinfo->isDir()) {
                                        $this->collect_templates_in_dir($fileinfo->getPathname(), $template_prefix . $file . '/');
                                }
                                else if(substr($file, -8, 8) === '.tpl.php') {
                                        $file = basename(substr($file, 0, -8));
                                        $tpl = $template_prefix . $file;
                                        $path = $template_prefix;
                                        if ($file != 'index') {
                                                $path .= $file;
                                        }
                                        $this->cache_templates[$tpl] = $path;
                                }
                        }
                }
        }

StaticPagesController::get_routes

(

)

Return array of urls which are handled by this controller.

Reimplemented from ControllerBase.

Definition at line 16 of file staticpages.controller.php.

                                     {
                $templates = $this->collect_templates();
                $ret = array();
                foreach ($templates as $template => $path) {
                        // Generates actions with fixed action like ActionMapper::get_path('static_somedir/somefile.html')
                        $ret[] = new StaticPageRoute(STATICPAGES_PREPEND, $path, STATICPAGES_APPEND, $template, $this, 'static');
                }
                // This allows using a parameterized syntax: ActionMapper::get_path('static', array('page' => 'somedir/somefile.html') 
                $ret[] = new StaticPageParamterizedRoute(STATICPAGES_PREPEND . '{page:s}' . STATICPAGES_APPEND, $this, 'static');

                return $ret;
        }

StaticPagesController::on_event	(	$	name,
		$	params,
		&$	result
	)

Process events.

Events processed are:

• gsitemap_site

Reimplemented from ControllerBase.

Definition at line 96 of file staticpages.controller.php.

                                                           {
                if ($name == 'gsitemap_site' && $params == 'main') {
                        $arr = $this->collect_templates();
                        foreach($arr as $template => $path) {
                                $result[] = array(
                                        'url' => ActionMapper::get_url('static', array('page' => $path)),
                                        'lastmod' => filemtime(TemplatePathResolver::resolve('static/' . $template)) 
                                );
                        }
                }
        }                                       

---

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

• gyro/modules/staticpages/controller/staticpages.controller.php