Skip to the content.

Gyro-PHP > Documentation

• Home
• Downloads
• Tutorials
• Showcases
• Documentation
• Report Bug

gyro/core/model/base/dbfield.cls.php

Go to the documentation of this file.

<?php
/**
 * Base class to represent a field
 * 
 * @author Gerd Riesselmann
 * @ingroup Model
 */
class DBField implements IDBField {
        /**
         * Indicates this field may not be NULL 
         */
        const NOT_NULL = 1;
        /**
         * Indicates this field is internal. This flag can be checked when building UI or on updates 
         */
        const INTERNAL = 8;
        
        /**
         * Name of the field
         *
         * @var string
         */
        protected $name = '';
        /**
         * Default value
         *
         * @var mixed
         */
        protected $default_value = null;
        /**
         * Is a null value allowed here?
         *
         * @var bool
         */
        protected $policy;
        /**
         * Connection for this field
         * 
         * @var string|IDBDriver
         */
        protected $connection;
        /**
         * Parent table for field
         * 
         * @var IDBTable
         */
        protected $table;
        
        public function __construct($name, $default_value = null, $policy = self::NONE, $connection = DB::DEFAULT_CONNECTION) {
                $this->name = $name;
                $this->default_value = $default_value;
                $this->policy = $policy;
                $this->connection = $connection;
        }
        
        /**
         * Returns name
         *
         * @return string
         */
        public function get_field_name() {
                return $this->name;
        }

        /**
         * Returns the default value for this field
         *
         * @return mixed
         */
        public function get_field_default() {
                return $this->default_value;
        }

        /**
         * Returns true, if field has default value
         */
        public function has_default_value() {
                return !$this->is_null($this->default_value);
        }
        
        /**
         * Returns true, if null values are allowed
         *
         * @return bool
         */
        public function get_null_allowed() {
                return !Common::flag_is_set($this->policy, self::NOT_NULL);
        }
        
        /**
         * Returns true, if the value passed fits the fields restrictions
         *
         * @param mixed $value
         * @return Status
         */
        public function validate($value) {
                $ret = new Status();
                if ($this->is_null($value) && !$this->has_default_value() && !$this->get_null_allowed()) {
                        $field_tr = $this->get_field_name_translation();
                        $msg = tr('%field may not be empty', 'core', array('%field' => $field_tr));
                        $ret->append($msg);
                }
                return $ret;
        }
        
        /**
         * Translate field name
         * 
         * @return string
         */
        protected function get_field_name_translation() {
                $translations = array('global');
                $table = $this->get_table();
                if ($table) {
                        array_unshift($translations, $table->get_table_name());
                }
                return tr($this->get_field_name(), $translations);
        }
        
        /**
         * Reformat passed value to DB format
         *
         * @param mixed $value
         * @return string
         */
        public function format($value) {
                if ($this->is_null($value)) {
                        return $this->do_format_null($value);
                }
                else {
                        return $this->do_format_not_null($value);
                }
        }

        /**
         * Format values that are NULL
         * 
         * @param mixed $value
         * @return string
         */
        protected function do_format_null($value) {
                return 'NULL';
        } 
        
        /**
         * Format values that are not NULL
         * 
         * @param mixed $value
         * @return string
         */
        protected function do_format_not_null($value) {
                return $this->quote($value);
        } 
        
        /**
         * Format for use in WHERE clause
         *  
         * @param mixed $value
         * @return string
         */
        public function format_where($value) {
                return $this->format($value);
        }

        /**
         * Allow replacements for field in select from clause
         */
        public function format_select() {
                return $this->get_field_name();
        }       

        /**
         * Transform result from SELECT to native
         * 
         * @param mixed $value
         * @return mixed    
         */
        public function convert_result($value) {
                return $value;
        }
        
        /**
         * Reads value from array (e.g $_POST) and converts it into something meaningfull
         */
        public function read_from_array($arr) {
                return Arr::get_item($arr, $this->get_field_name(), null);
        }
        
        /**
         * Set connection of field
         * 
         * @param string|IDBDriver $connection
         * @return void
         */
        public function set_connection($connection) {
                $this->connection = $connection;
        }

        /**
         * Returns connection
         * @return string|IDBDriver
         */
        protected function get_connection() {
                return $this->connection;
        }
        
        /**
         * Set table field belongs to
         * 
         * @attention The table may not be set, fields must be aware of this!
         * 
         * @param IDBTable $table
         * @return void
         */
        public function set_table($table) {
                $this->table = $table;
        }       

        /**
         * Get table field belongs to
         * 
         * @return IDBTable
         */
        public function get_table() {
                return $this->table;
        }       
        
        /**
         * Return policy
         *
         * @return int
         */
        public function get_policy() {
                return $this->policy;   
        }
        
        /**
         * Set policy
         *
         * @param int $policy
         */
        public function set_policy($policy) {
                $this->policy = $policy;
        }
        
        /**
         * Returns true, if client has given policy
         *
         * @param int $policy
         * @return bool
         */
        public function has_policy($policy) {
                $ret = Common::flag_is_set($this->policy, $policy);
                return $ret;
        }
        
        /**
         * Quote value
         */
        protected function quote($value) {
                return DB::quote(Cast::string($value), $this->get_connection()); 
        }
        
        /**
         * Returns true if $value is NULL or DBNull
         */
        protected function is_null($value) {
                return is_null($value) || $value instanceof DBNull;
        }
}

Imprint