pronto/core/model.php

Go to the documentation of this file.

<?php
class Model_Base
{
        var $db      = null;
        var $web     = null;
        var $cache   = null;
        var $depends = null;
        var $plugins = null;

        var $context = null;

        /*
         * Variables below are to be overridden by subclasses
         */

        var $table        = null;
        var $pk           = 'id';
        var $default_sort = 'id';
        var $per_page     = 50;
        var $enable_cache = false;

        var $files = null;

        function Model_Base()
        {
                $this->db    =& Registry::get('pronto:db:main');
                $this->cache =& Registry::get('pronto:cache');
                $this->web   =& Registry::get('pronto:web');
                $this->validator =& Registry::get('pronto:validator');

                // this isn't a very smart inflector -- best to explicitly set the
                // table name in the model itself
                if(is_null($this->table) || empty($this->table)) {
                        $this->table = strtolower(substr(get_class($this),1)).'s';
                }

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

                if(method_exists($this, '__init__')) {
                        $this->__init__();
                }
        }

        function depend($model)
        {
                foreach(func_get_args() as $name) {
                        if(isset($this->depends->$name)) continue;
                        $this->depends->$name =& Factory::model($name);
                }
        }

        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;
        }

        function validate_for_insert($data)
        {
                return false;
        }

        function validate_for_update($data)
        {
                return false;
        }

        function validate($data, $is_update=false)
        {
                if($is_update) {
                        return $this->validate_for_update($data);
                }
                return $this->validate_for_insert($data);
        }

        function purify($data)
        {
                require_once(DIR_FS_PRONTO.DS.'extlib'.DS.'safehtml'.DS.'safehtml.php');
                foreach($data as $k=>$v) {
                        if(is_array($v)) {
                                // PHP4 doesn't like self::purify()
                                $data[$k] = Model::purify($v);
                        } else if(class_exists('safehtml')) {
                                $purifier = new safehtml();
                                $data[$k] = $purifier->parse($v);
                        }
                }
                return $data;
        }

        function sanitize($data)
        {
                $data = $this->purify($data);
                return $data;
        }

        function create()
        {
                return array();
        }

        function get($id)
        {
                if($this->enable_cache && $this->cache) {
                        $key = 'model_'.get_class($this)."_{$this->pk}_$id";
                        $item =& $this->cache->get($key);
                        if(!$item) {
                                $item = $this->get_record($id);
                                $this->cache->set($key, $item);
                        }
                        return $item;
                }
                return $this->get_record($id);
        }

        function invalidate($id)
        {
                if(!is_array($id)) $id = array($id);
                foreach($id as $i) {
                        if($this->enable_cache && $this->cache) {
                                $key = 'model_'.get_class($this)."_{$this->pk}_$i";
                                $this->cache->delete($key);
                        }
                }
        }

        function get_record($id)
        {
                return $this->get_bare($id);
        }

        function get_bare($id)
        {
                return $this->db->get_item("SELECT * FROM {$this->table} WHERE \"{$this->pk}\"=%i LIMIT 1", array($id));
        }

        function get_multi($ids, $ignore_empty=true)
        {
                $data = array();
                foreach($ids as $id) {
                        $rec = $this->get($id);
                        if($rec || !$ignore_empty) $data[] = $rec;
                }
                return $data;
        }

        function get_value($id, $column)
        {
                return $this->db->get_value("SELECT \"$column\" FROM {$this->table} WHERE \"{$this->pk}\"=%i LIMIT 1", array($id));
        }

        function get_by($column, $value)
        {
                if(!is_array($column)) $column = array($column);
                if(!is_array($value))  $value  = array($value);

                $where = array();
                foreach($column as $c) $where[] = "\"{$c}\"='%s'";
                $where = implode(' AND ', $where);

                $id = $this->db->get_value("SELECT \"{$this->pk}\" FROM {$this->table} WHERE $where LIMIT 1", $value);
                return $this->get($id);
        }

        function get_all_by($column, $value)
        {
                if(!is_array($column)) $column = array($column);
                if(!is_array($value))  $value  = array($value);

                $where = array();
                foreach($column as $c) $where[] = "\"{$c}\"='%s'";
                $where = implode(' AND ', $where);

                $ids = $this->db->get_values("SELECT \"{$this->pk}\" FROM {$this->table} WHERE $where ORDER BY {$this->default_sort}", $value);
                return $this->get_multi($ids);
        }

        function get_all()
        {
                $ids = $this->db->get_values("SELECT \"{$this->pk}\" FROM {$this->table} ORDER BY {$this->default_sort}");
                return $this->get_multi($ids);
        }

        function get_or_404($id)
        {
                $data = $this->get($id);
                if($data === false) {
                        $this->web->notfound();
                }
                return $data;
        }

        function delete($id)
        {
                $this->invalidate($id);
                return $this->db->execute("DELETE FROM {$this->table} WHERE \"{$this->pk}\"=%i", array($id));
        }

        function insert($data)
        {
                $data = $this->sanitize($data);
                return $this->db->insert_row($this->table, $data);
        }

        function update($data)
        {
                $this->invalidate($data['id']);
                $data = $this->sanitize($data);
                return $this->db->update_row($this->table, $data, $this->pk."='%s'", array($data[$this->pk]));
        }

        function list_params()
        {
                return array(
                        'from'       => $this->table,
                        'exprs'      => array(),
                        'gexprs'     => array(),
                        'select'     => '*',
                        'where'      => '',
                        'group_by'   => '',
                        'having'     => '',
                        'order'      => $this->default_sort,
                        'limit'      => $this->per_page,
                );
        }

        function __call($name, $args)
        {
                switch(true) {
                        case substr($name, 0, 4) == 'get_':
                                $field = substr($name, 4);
                                return $this->db->get_value("SELECT \"$field\" FROM {$this->table} WHERE \"{$this->pk}\"='%s'", array($args[0]));
                        case substr($name, 0, 4) == 'set_':
                                $field = substr($name, 4);
                                $this->db->execute("UPDATE {$this->table} SET \"$field\"='%s' WHERE \"{$this->pk}\"='%s'", array($args[1],$args[0]));
                                $this->invalidate($args[0]);
                                return true;
                }
                trigger_error("Method does not exist: $name");
        }

        function save($data)
        {
                if($data['id']) {
                        return $this->update($data);
                } else {
                        return $this->insert($data);
                }
        }

        function load($id)
        {
                return $this->get($id);
        }

        function create_record()
        {
                return $this->create();
        }

        function enum_schema()
        {
                return $this->list_params();
        }
}

?>

---