XoopsObject.php

Go to the documentation of this file.

<?php
namespace Xoops\Core\Kernel;

use Xoops\Core\Kernel\Dtype;

define('XOBJ_DTYPE_TXTBOX', 1);
define('XOBJ_DTYPE_TXTAREA', 2);
define('XOBJ_DTYPE_INT', 3);
define('XOBJ_DTYPE_URL', 4);
define('XOBJ_DTYPE_EMAIL', 5);
define('XOBJ_DTYPE_ARRAY', 6);
define('XOBJ_DTYPE_OTHER', 7);
define('XOBJ_DTYPE_SOURCE', 8);
define('XOBJ_DTYPE_STIME', 9);
define('XOBJ_DTYPE_MTIME', 10);
define('XOBJ_DTYPE_LTIME', 11);
define('XOBJ_DTYPE_FLOAT', 13);
define('XOBJ_DTYPE_DECIMAL', 14);
define('XOBJ_DTYPE_ENUM', 15);

abstract class XoopsObject
{
    public $vars = array();

    public $cleanVars = array();

    private $_isNew = false;

    private $_isDirty = false;

    private $_errors = array();

    private $_filters = array();

    public $plugin_path;

    public function setNew()
    {
        $this->_isNew = true;
    }

    public function unsetNew()
    {
        $this->_isNew = false;
    }

    public function isNew()
    {
        return $this->_isNew;
    }

    public function setDirty()
    {
        $this->_isDirty = true;
    }

    public function unsetDirty()
    {
        $this->_isDirty = false;
    }

    public function isDirty()
    {
        return $this->_isDirty;
    }

    public function initVar($key, $data_type, $value = null, $required = false, $maxlength = null, $options = '')
    {
        $this->vars[$key] = array(
            'value' => $value,
            'required' => $required,
            'data_type' => $data_type,
            'maxlength' => $maxlength,
            'changed' => false,
            'options' => $options
        );
    }

    public function assignVar($key, $value)
    {
        if (isset($key) && isset($this->vars[$key])) {
            $this->vars[$key]['value'] = $value;
        }
    }

    public function assignVars($var_arr)
    {
        if(is_array($var_arr)) foreach ($var_arr as $key => $value) {
            $this->assignVar($key, $value);
        }
    }

    public function setVar($key, $value, $not_gpc = false)
    {
        if (!empty($key) && isset($value) && isset($this->vars[$key])) {
            $this->vars[$key]['value'] = $value;
            $this->vars[$key]['not_gpc'] = $not_gpc;
            $this->vars[$key]['changed'] = true;
            $this->setDirty();
        }
    }

    public function setVars($var_arr, $not_gpc = false)
    {
        if(is_array($var_arr)) foreach ($var_arr as $key => $value) {
            $this->setVar($key, $value, $not_gpc);
        }
    }

    public function destroyVars($var)
    {
        if (empty($var)) {
            return true;
        }
        $var = !is_array($var) ? array($var) : $var;
        foreach ($var as $key) {
            if (!isset($this->vars[$key])) {
                continue;
            }
            $this->vars[$key]['changed'] = null;
        }
        return true;
    }

    public function setFormVars($var_arr = null, $pref = 'xo_', $not_gpc = false)
    {
        $len = strlen($pref);
        if(is_array($var_arr)) foreach ($var_arr as $key => $value) {
            if ($pref == substr($key, 0, $len)) {
                $this->setVar(substr($key, $len), $value, $not_gpc);
            }
        }
    }

    public function getVars()
    {
        return $this->vars;
    }

    public function getValues($keys = null, $format = 's', $maxDepth = 1)
    {
        if (!isset($keys)) {
            $keys = array_keys($this->vars);
        }
        $vars = array();
        if(is_array($keys)) foreach ($keys as $key) {
            if (isset($this->vars[$key])) {
                if (is_object($this->vars[$key]) && is_a($this->vars[$key], 'Xoops\Core\Kernel\XoopsObject')) {
                    if ($maxDepth) {
                        /* @var $obj XoopsObject */
                        $obj = $this->vars[$key];
                        $vars[$key] = $obj->getValues(null, $format, $maxDepth - 1);
                    }
                } else {
                    $vars[$key] = $this->getVar($key, $format);
                }
            }
        }
        return $vars;
    }

    public function getVar($key, $format = 's')
    {
        $ret = null;
        if (!isset($this->vars[$key])) {
            return $ret;
        }
        $ret = Dtype::getVar($this, $key, $format);
        return $ret;
    }

    public function cleanVars($quote = true)
    {
        $ts = \MyTextSanitizer::getInstance();
        $existing_errors = $this->getErrors();
        $this->_errors = array();
        foreach ($this->vars as $k => $v) {
            if (!$v['changed']) {
            } else {
                $this->cleanVars[$k] = Dtype::cleanVar($this, $k, $quote);
            }
        }
        if (count($this->_errors) > 0) {
            $this->_errors = array_merge($existing_errors, $this->_errors);
            return false;
        }
        // $this->_errors = array_merge($existing_errors, $this->_errors);
        $this->unsetDirty();
        return true;
    }

    public function registerFilter($filtername)
    {
        $this->_filters[] = $filtername;
    }

    private function _loadFilters()
    {
        static $loaded;
        if (isset($loaded)) {
            return;
        }
        $loaded = 1;

        $path = empty($this->plugin_path) ? __DIR__ . '/filters' : $this->plugin_path;
        if (\XoopsLoad::fileExists($file = $path . '/filter.php')) {
            include_once $file;
            if(is_array($this->_filters)) foreach ($this->_filters as $f) {
                if (\XoopsLoad::fileExists($file = $path . '/' . strtolower($f) . 'php')) {
                    include_once $file;
                }
            }
        }
    }

    public function loadFilters($method)
    {
        $this->_loadFilters();

        $class = get_class($this);
        $modules_active = \Xoops::getInstance()->getActiveModules();
        if (is_array($modules_active)) foreach ($modules_active as $dirname) {
            $file = \XoopsBaseConfig::get('root-path') . '/modules/' . $dirname . '/filter/' . $class . '.' . $method . '.php';
            if (\XoopsLoad::fileExists($file)) {
                include_once $file;
                $function = $dirname . '_' . $class . '_' . $method;
                if (function_exists($function)) {
                    call_user_func_array($function, array(&$this));
                }
            }
        }
    }

    public function xoopsClone()
    {
        /* @var $clone XoopsObject */
        $class = get_class($this);
        $clone = null;
        $clone = new $class();
        foreach ($this->vars as $k => $v) {
            $clone->assignVar($k, $v['value']); // Only for vars initialized within clone::__construct
        }
        // need this to notify the handler class that this is a newly created object
        $clone->setNew();
        return $clone;
    }

    public function setErrors($err_str)
    {
        if (is_array($err_str)) {
            $this->_errors = array_merge($this->_errors, $err_str);
        } else {
            $this->_errors[] = trim($err_str);
        }
    }

    public function getErrors()
    {
        return $this->_errors;
    }

    public function getHtmlErrors()
    {
        $ret = '<h4>Errors</h4>';
        if (!empty($this->_errors)) {
            foreach ($this->_errors as $error) {
                $ret .= $error . '<br />';
            }
        } else {
            $ret .= 'None<br />';
        }
        return $ret;
    }

    public function toArray()
    {
        return $this->getValues();
    }
}