e107inc/e107

View on GitHub
e107_core/url/page/url.php

Summary

Maintainability
A
0 mins
Test Coverage
F
49%
<?php
/**
 * Copyright (C) e107 Inc (e107.org), Licensed under GNU GPL (http://www.gnu.org/licenses/gpl.txt)
 * $Id$
 * 
 * Custom page routing config
 */
if (!defined('e107_INIT')){ exit; } 
  
class core_page_url extends eUrlConfig
{
    public function config()
    {
        return array(
        
            'config' => array(
                'noSingleEntry' => true,    // [optional] default false; disallow this module to be shown via single entry point when this config is used
                'legacy'         => '{e_BASE}page.php', // [optional] default empty; if it's a legacy module (no single entry point support) - URL to the entry point script
                'format'        => 'get',     // get|path - notify core for the current URL format, if set to 'get' rules will be ignored
                'selfParse'     => true,    // [optional] default false; use only this->parse() method, no core routine URL parsing
                'selfCreate'     => true,    // [optional] default false; use only this->create() method, no core routine URL creating
                'defaultRoute'    => '',         // [optional] default empty; route (no leading module) used when module is found with no additional controller/action information e.g. /news/
                'errorRoute'    => '',         // [optional] default empty; route (no leading module) used when module is found but no inner route is matched, leave empty to force error 404 page
                'urlSuffix'     => '',        // [optional] default empty; string to append to the URL (e.g. .html)
                'mapVars'         => array(),
                'allowVars'     => array(),
            ),
            
            'rules' => array() // rule set array
        );
    }
    
    /**
     * 
     */
    public function create($route, $params = array(), $options = array())
    {
        if(!$params) return 'page.php';
        
        if(is_string($route))
        {
             $route = explode('/', $route, 2);
            
        }
        
            
        if(!varset($route[1])) $route[1] = 'index';
        
        $url = 'page.php?';
        
        if(isset($params['chapter_id']) && !empty($params['chapter_id']))
        {
             $params['id'] = $params['chapter_id'];
        }
        
        switch ($route[0]) 
        {
            case 'book':

                if(!empty($params['book_id']))
                {
                    $params['id'] = $params['book_id'];
                }

                $url .= "bk=".intval($params['id']);    
            break;

            case 'chapter':
                $url .= "ch=".intval($params['id']);    
            break;
            
            case 'view':
            default: 
                ## aliases as retrieved from the DB, map vars to proper values
                if(isset($params['page_title']) && !empty($params['page_title']))
                {
                     $params['name'] = $params['page_title'];
                }
                
                if(isset($params['page_id']) && !empty($params['page_id']))
                {
                     $params['id'] = $params['page_id'];
                }
                
                if('--FROM--' != vartrue($params['page']))
                {
                     $page = varset($params['page']) ? intval($params['page']) : '0';
                }
                else
                {
                     $page = '--FROM--';
                }
                
                $url .= "id=".intval($params['id']).($page ? '.'.$page : '');    
            break;
            
            
        }
        
        
        return $url;
    }

    /**
     * Admin callback
     * Language file not loaded as all language data is inside the lan_eurl.php (loaded by default on administration URL page)
     */
    public function admin()
    {
        // static may be used for performance
        static $admin = array(
            'labels' => array(
                'name' => LAN_EURL_CORE_PAGE, // Module name
                'label' => LAN_EURL_DEFAULT, // Current profile name
                'description' => LAN_EURL_LEGACY, //
                'examples'  => array("{SITEURL}page.php?1","{SITEURL}page.php?id=1")
            ),
            'form' => array(), // Under construction - additional configuration options
            'callbacks' => array(), // Under construction - could be used for e.g. URL generator functionallity
        );
        
        return $admin;
    }
    
    public function parse($pathInfo, $params = array(), eRequest $request = null, eRouter $router = null, $config = array())
    {
        // this config doesn't support parsing, it's done by the module entry script (news.php)
        // this means News are not available via single entry point if this config is currently active
        return false;
    }
}