form.inc.php

Go to the documentation of this file.

<?php
//if we dont have an autoload function, add the Form one in.  used for using form as stand alone
if (!function_exists("__autoload"))
{
    function __autoload($class)
    {
        Form::autload($class);
    }
}

class Form
{
    private $fields = array(); 
    private $method = 'post'; 
    private $layout; 
    private $name; 
    private $action; 
    private $onSubmit; 

    public function __construct($layout = null)
    {
        $this->action = $_SERVER['PHP_SELF'];
        $this->layout = $layout === null ? new TableLayout() : $layout;
        $this->name = uniqid('form');
        
        //add our submit field.
        $this->add('HiddenField', 'is_submitted', array(
            'value' => 1
        ));

        if(!($this->layout instanceof Layout))
            throw new Exception("Passed layout object does not implement Layout");
    }

    public function __get($name)
    {
        if(isset($this->$name))
            return $this->$name;
        else
            return false;
    }

    public function __set($name, $value)
    {
        switch($name)
        {
            case 'method':
                $value = strtolower($value);
                if($value != 'post' && $value != 'get') 
                    throw new InvalidValueException();

                $this->method = $value;
                break;

            case 'layout':
                if(!($value instanceof Layout))
                    throw new InvalidValueException();

                $this->layout = $value;
                break;

            case 'action':
            case 'name':
            case 'onSubmit':
            case 'onsubmit':
                $this->$name = $value;
                return true;
                break;

            default:
                return false;
        }
    }

    public function add($type, $name, array $options = array())
    {
        if(array_key_exists($name, $this->fields))
            throw new Exception("Field name $name is not unique.");

        $field = new $type($name, $this, $options);
        $this->fields[$name] = $field;
        
        return $field;
    }

    public function getField($name)
    {
        //throw an error if we dont have it.
        $this->assertFieldExists($fieldName);
            
        return $this->fields[$name];
    }

    public function replaceField($type, $name, $options = array())
    {
        //throw an error if we dont ahve it.
        $this->assertFieldExists($name);

        $field = new $type($name, $this, $options);
        $this->fields[$name] = $field;
    }

    public function addSubmit($title = 'Submit')
    {
        $this->add('ButtonField', 'submitme', array('value' => $title, 'type' => 'submit'));

        return $field;
    }

    public function remove($name)
    {
        if ($this->hasField($name))
            unset($this->fields[$name]);
        else
            throw new Exception("Cannot remove field $name, it doesn't exist.");
    }


    public function isSubmitted()
    {
        return isset($_POST['is_submitted']);
    }

    public function validate()
    {
        foreach($this->fields as $field)
            $field->validate();
    }

    
    public function setData($data)
    {
        if(is_string($data))
        {
            $res =& $this->dbConn->query($data);
            
            if(PEAR::isError($res))
                throw new InvalidQueryException($data);
            
            $data = $res->fetchRow(DB_FETCHMODE_ASSOC);
        }

        if(!is_array($data))
            throw new InvalidValueException();

        foreach($this->fields as $field)
        {
            //we may need to set the data on our individual collection fields.
            if ($field instanceOf CollectionField)
                $field->setFieldsData($data);
            
            //nope, just a simple field.. but still try it on collection fields.
            if(isset($data[$field->name]))
                $field->setData($data[$field->name]);           
        }
    }
    

    public function getData($fieldName = null)
    {
        if($fieldName != null)
        {
            $this->assertFieldExists($fieldName);
            return $this->fields[$fieldName]->getData();
        }

        $ret = array();
        foreach($this->fields as $field)
        {
            $ret[$field->name] = $field->getData();
        }

        return $ret;
    }

    public function hasError()
    {
        $error = false; 
        foreach($this->fields as $field)
            $error = $field->hasError() || $error;

        return $error;
    }

    public function hasField($field)
    {
        return is_object($this->fields[$field]);
    }

    public function needsDrawn()
    {
        return (!$this->isSubmitted() || $this->hasError());
    }

    public function isSubmittedAndValid()
    {
        //if its submitted...
        if ($this->isSubmitted())
        {
            //validate it.
            $this->validate();
            return !$this->hasError();
        }

        //no submit?  no problem.
        return false;
    }

    public function drawIfNeeded()
    {
        if ($this->needsDrawn())
            $this->draw();
    }

    public function drawAll($action = null, $submitText = null)
    {
        //error handling first
        if(!count($this->fields))
            throw new Exception('Form has no fields.');

        //where we sending to?
        $action = $action === null ? $this->action : $action;

        
        //do we add submit buttons?
        if($submitText !== null)
            $this->addSubmit($submitText);

        if ($this->onSubmit)
            $submit = "onSubmit=\"$this->onSubmit\"";

        //start our form
        echo "<form method='$this->method' action='$action' enctype='multipart/form-data' name='$this->name' id='$this->name' $submit>";

        //draw our layout
        $this->layout->drawBeginning();

        //draw our fields
        foreach($this->fields as $field)
            $this->layout->drawField($field);

        //end our layout
        $this->layout->drawEnd();

        echo "</form>";
    } 

    public function draw()
    {
        $this->drawAll();
    }

    public function setError($fieldName, $errorString = null)
    {
        $this->assertFieldExists($fieldName);
        $field = $this->fields[$fieldName];
        $field->forceError();
        
        if($errorString)
            $field->errorMessage = $errorString;
    }

    public function getCss()
    {
        $css = null;

        foreach($this->fields as $field)
            $css .= $field->getCss();

        return $css;
    }

    public function assertFieldExists($fieldName)
    {
        if(!array_key_exists($fieldName, $this->fields))
            throw new InvalidFieldNameException();

        return true;
    }

    public static function autoload($class)
    {
        if(preg_match('/.*Field$/', $class))
        {
            $class = str_replace('field', '-field', strtolower($class));
            require_once("fields/$class.inc.php");
            return true;
        }
        elseif(preg_match('/.*Layout$/', $class))
        {
            $class = str_replace('layout', '-layout', strtolower($class));
            require_once("layouts/$class.inc.php");
            return true;
        }
        elseif(preg_match('/.*Exception$/', $class))
        {
            $class = str_replace('exception', '-exception', strtolower($class));
            require_once("exceptions/$class.inc.php");
            return true;
        }

        return false;
    }
}
?>

---