abstract-field.inc.php

Go to the documentation of this file.

<?php
require_once('field.inc.php');

abstract class AbstractField implements Field
{
    public $name = ''; 
    protected $title = ''; 
    protected $value = ''; 
    protected $attribs = array(); 
    protected $required = false; 
    protected $regExp = ''; 
    protected $errorMessage = ''; 
    protected $hasError = false; 
    protected $parentForm = ''; 
    public $definition = '';

    
    public function __construct($name, Form &$parentForm, array $attribs = array())
    {
        $this->name = $name;
        $this->parentForm = $parentForm;

        $this->required = false;
        $this->parseExtras($attribs);
        $this->title = array_key_exists('title', $attribs) ? $attribs['title'] : ucwords(str_replace('_', ' ', $name));
        $this->errorMessage = "The $this->title field had an error.";
        
        if(!isset($this->attribs['id']))
            $this->attribs['id'] = $this->name;

        $this->hasError = null;
    }

    public function __get($name)
    {
        if(isset($this->$name) || is_null($this->$name))
            return $this->$name;
        else if(array_key_exists($name, $this->attribs))
            return $this->attribs[$name];

        return false;
    }

    public function __set($name, $value)
    {
        if($name == 'value')
            $this->setData($value);
        else if(isset($this->$name))
            $this->$name = $value;
        else
            $this->attribs[$name] = $value;

        return true;
    }

    public function validate()
    {
        $this->setDataFromRequest();

        $this->hasError = false;
        
        if($this->required && $this->value == null)
        {
            $this->hasError = true;
            $this->errorMessage = "The $this->title field is required.";
        }
        
        if($this->regExp && !$this->hasError)
        {
            list($this->regExp, $this->errorMessage) = 
                array_values($this->convertSpecialRegex($this->regExp, $this->errorMessage));

            # Error if the string doesn't match the regex, or if the value is empty (required fields are handled above)
            $this->hasError = !((bool)preg_match($this->regExp, $this->value) || $this->value == null);
        }
    }

    public function getTitle()
    {
        if ($this->definition == '')
            return $this->title;
        else
            return "<acronym title=\"$this->definition\">$this->title</acronym>";
    }

    public function hasError()
    {
        if($this->hasError === null)
            throw new NotValidatedException($this);

        return (bool)$this->hasError;
    }

    public function forceError()
    {
        $this->hasError = true;
    }

    public function getSqlImpl()
    {
        return "$this->name = '$this->value'";
    }

    public function setData($value)
    {
        $this->value = $value;
    }

    public function getData()
    {
        return $this->value;
    }

    public function getJs()
    {
        return null; # No-Op
    }

    public function getCss()
    {
        return null; # No-Op
    }

    public function addAttributes(array $attr)
    {
        $this->attribs = array_merge($this->attribs, $attr);
    }


    protected function parseExtras(array $data)
    {
        $this->attribs = array(); # clear out any existing value

        foreach($data as $key => $value)
            $this->__set($key, $value);
    }


    protected function extrasAsAttributes()
    {
        $ret = array();
            
        foreach(array_change_key_case($this->attribs, CASE_LOWER) as $key => $value)
            $ret[] = "$key=\"$value\"";
        return implode(' ', $ret);
    }

    protected function setDataFromRequest()
    {
        if(isset($_REQUEST[$this->name]))
            $this->value = $_REQUEST[$this->name];
    }

    
    protected function convertSpecialRegex($regExp, $defaultError)
    {
        $error = $defaultError;
        switch($regExp)
        {
            case 'number':
                $regExp = '/^-?[0-9]+$/';
                $error = "The $this->title field must be a number.";
                break;

            case 'float':
                $regExp = '/^-?([0-9]*\.)?[0-9]+$/';
                $error = "The $this->title field must be a number.";
                break;

            case 'alpha':
                $regExp = '/^[A-Za-z]*$/';
                $error = "The $this->title field must consist of only alphabetic characters.";
                break;

            case 'alphanumeric':
                $regExp = '/^[A-Za-z0-9]*$/';
                $error = "The $this->title field must consist of only alpha numeric characters.";
                break;
            
            case 'email':
                $regExp = '/^[a-z0-9]+([_\\.-][a-z0-9]+)*@([a-z0-9]+([\.-][a-z0-9]+)*)+\\.[a-z]{2,}$/i';
                $error = "The $this->title field must be a real email.";
                break;
        }
        
        return array('regexp' => $regExp, 'message' => $error);
    }

    protected static function assertAttributeIsArray(&$value)
    {
        if(!is_array($value))
            throw new InvalidAttributeValueException($value, 'An Array'); 
    }

    protected static function assertAttributeIsObject($type, &$value)
    {
        if(!($value instanceof $type))
            throw new InvalidAttributeValueException($value, $type); 
    }
}
?>

---