pronto/core/page.php

Go to the documentation of this file.

<?php
class Page_Base
{
        var $web;
        var $db;
        var $validator;
        var $sql;
        var $models;
        var $plugins;
        var $ajax;

        var $module_name; // if this controller is part of a module...

        var $template;
        var $template_layout;

        function Page_Base()
        {
                $this->web     =& Registry::get('pronto:web');
                $this->db      =& Registry::get('pronto:db:main');
                $this->sql     =  new SQL_Generator($this); 
                $this->models  =  new stdClass;
                $this->plugins =  new stdClass;

                $this->validator =& Registry::get('pronto:validator');

                $this->template = new Template();
                $this->set_module('');
                $this->set_layout('layout.php');

                // check if we're in AJAX mode or not
                $this->set_ajax(!!$this->param('_ajax', $this->web->ajax));
                $this->template->set('_ajax', $this->ajax);

                // if form data/errors are present in the session, pass them to
                // the template and remove from the session.
                if(isset($_SESSION['form_data'])) {
                        $this->template->set('data', $_SESSION['form_data']);
                        $this->template->set('errors', $_SESSION['form_errors']);
                        unset($_SESSION['form_data'], $_SESSION['form_errors']);
                }

                // load in plugins
                $this->plugins =& Registry::get('pronto:plugins');
        }

        function set_module($name)
        {
                $this->module_name = $name;
                $this->template->set_module($name);
        }

        function set_ajax($enable=true)
        {
                $this->ajax = $enable;
                if(is_object($this->web)) $this->web->ajax = $this->ajax;
        }


        /********************************************************************
         *
         * MODEL/PLUGIN IMPORTERS
         *
         ********************************************************************/
 
        function import_model($name)
        {
                foreach(func_get_args() as $name) {
                        $this->models->$name =& Factory::model($name);
                        if($this->models->$name === false) {
                                trigger_error("Model $name does not exist");
                                die;
                        }
                }
        }

        function &import_plugin($name)
        {
                foreach(func_get_args() as $name) {
                        $class =& Factory::plugin($name, 'page');
                        if($class === false) {
                                trigger_error("Plugin $name does not exist");
                                die;
                        }
                }
                // reload $this->plugins
                $this->plugins =& Registry::get('pronto:plugins');
                if($class) return $class;
        }

        /********************************************************************
         *
         * HTTP CONTROLS
         *
         ********************************************************************/

        function redirect($url)
        {
                $this->web->redirect($url);
        }

        function redirect_to_referrer($default_url='')
        {
                if(!$default_url) $default_url = url('/');
                $url = $_SERVER['HTTP_REFERER'] ? $_SERVER['HTTP_REFERER'] : $default_url;
                if($this->ajax) {
                        $this->ajax_render('', array('redirect_url'=>$url));
                } else {
                        $this->web->redirect($url);
                }
        }

        function return_to_form($url, $data, $errors=array()) {
                if($this->ajax) {
                        $vars = array('errors' => $errors);
                        $this->ajax_render('', $vars);
                } else {
                        $_SESSION['form_data']   = $data;
                        $_SESSION['form_errors'] = $errors;
                        if($url) {
                                $this->redirect($url);
                        } else {
                                $this->redirect_to_referrer();
                        }
                }
        }

        /********************************************************************
         *
         * FLASH MESSAGE CONTROL
         *
         ********************************************************************/

        function flash($message)
        {
                if(!empty($message)) $_SESSION['_FLASH_MESSAGE'] = $message;
        }

        function flash_get()
        {
                return $_SESSION['_FLASH_MESSAGE'];
        }

        function flash_isset()
        {
                return !empty($_SESSION['_FLASH_MESSAGE']);
        }

        function flash_clear()
        {
                unset($_SESSION['_FLASH_MESSAGE']);
        }

        /********************************************************************
         *
         * REQUEST VARIABLE RETRIEVAL / MANIPULATION
         *
         ********************************************************************/

        function param($key, $default='')
        {
                $req = Registry::get('pronto:request_args');
                if(isset($req[$key])) {
                        return $this->validator->prepare_input($req[$key]);
                }
                return $default;
        }

        function params()
        {
                $a = array();
                foreach(func_get_args() as $k) {
                        $a[] = $this->param($k);
                }
                return $a;
        }

        function load_input($req='')
        {
                if(!is_array($req)) $req = Registry::get('pronto:request_args');
                $ret = array();
                foreach($req as $k=>$v) {
                        $ret[$k] = $this->validator->prepare_input($v);
                }
                return $ret;
        }

        function path_args($shift=0)
        {
                return array_slice(explode('/', $this->web->context->path), $shift);
        }

        function param_set($key, $val)
        {
                $ra =& Registry::get('pronto:request_args');
                $ra[$key] = $val;
                Registry::set('pronto:request_args', $ra);
        }

        function param_unset($key)
        {
                $ra =& Registry::get('pronto:request_args');
                unset($ra[$key]);
                Registry::set('pronto:request_args', $ra);
        }

        /********************************************************************
         *
         * TEMPLATE VARIABLES/RENDERING
         *
         ********************************************************************/

        function tget($key)
        {
                return $this->template->get($key);
        }
        function tset($key, $var)
        {
                $this->template->set($key, $var);
        }
        function tunset($key)
        {
                $this->template->un_set($key, $var);
        }
        function tisset($key)
        {
                return $this->template->is_set($key);
        }

        function set_layout($filename)
        {
                $this->template_layout = $filename;
        }

        function render_element($pagename, $element, $args=array(), $merge_vars=true)
        {
                $page =& Factory::page($pagename);
                if(!is_object($page)) {
                        trigger_error("$pagename is not a valid Page name");
                }
                if(method_exists($page, '__init__')) {
                        call_user_func(array(&$page, '__init__'));
                }
                $content = call_user_func_array(array(&$page, "ELEM_$element"), $args);

                // can't merge vars if we're called as a class (eg, Page::render_element())
                if($this && $merge_vars) {
                        // merge in template variables from the rendered element
                        foreach($page->template->variables as $k=>$v) $this->tset($k, $v);
                }

                return $content;
        }

        function fetch($filename, $vars=array(), $language=false)
        {
                return $this->template->fetch($filename, $vars, $language);
        }

        function render($filename, $vars=array(), $layout='')
        {
                if($layout === '') $layout = $this->template_layout;

                if($this->ajax) {
                        $this->ajax_render($filename);
                } else {
                        $this->web->render($this->template, $filename, $vars, $layout);
                }
        }

        function render_string($content, $vars=array(), $layout='')
        {
                if($layout === '') $layout = $this->template_layout;

                $vars['CONTENT_FOR_LAYOUT'] = $content;
                $this->web->render($this->template, DIR_FS_APP.DS.'templates'.DS.$layout, $vars);
        }

        function ajax_render($filename, $jsvars=array())
        {
                $this->web->ajax_render($this->template, $filename, $jsvars);
        }

        function ajax_exec($js='')
        {
                $this->web->ajax_exec($js);
        }

        /********************************************************************
         *
         * DEFAULT ACTION HANDLERS
         *
         ********************************************************************/

        function GET()
        {
                $this->web->notfound();
        }

        /*
         * The default POST action handler.  To be overridden by subclasses.
         */
        function POST()
        {
                $this->web->notfound();
        }

        /*
         * The default PUT action handler.  To be overridden by subclasses.
         */
        function PUT()
        {
                $this->web->notfound();
        }

        /*
         * The default DELETE action handler.  To be overridden by subclasses.
         */
        function DELETE()
        {
                $this->web->notfound();
        }

        /*
         * The default HEAD action handler.  To be overridden by subclasses.
         */
        function HEAD()
        {
                $this->web->notfound();
        }
}

?>

---