Doctrine

Timestamp:

10/02/08 07:07:08 (9 months ago)

Author:

jwage

Message:

[1.1] fixes #255 Added ability to validate a group of fields

Location:

branches/1.1

Files:

• lib/Doctrine/Record/Abstract.php (modified) (1 diff)
• lib/Doctrine/Table.php (modified) (4 diffs)
• lib/Doctrine/Validator.php (modified) (1 diff)
• lib/Doctrine/Validator/Unique.php (modified) (2 diffs)
• tests/run.php (modified) (1 diff)
• tests/Ticket/255TestCase.php (added)
• UPGRADE_TO_1_1 (modified) (2 diffs)

branches/1.1/lib/Doctrine/Record/Abstract.php

@@ -113 +113 @@
         }
     }
+
+    /**
+     * Specify an array of fields that are unique and will be validated as such
+     *
+     * @return void
+     */
+    public function unique()
+    {
+        $args = func_get_args();
+
+        if (count($args) == 1) {
+            $fields = (array) $args[0];
+        } else if (count($args) > 1) {
+            $fields = $args;
+        } else {
+            throw new Doctrine_Record_Exception('You must specify the fields to make a unique constraint on.');
+        }
+
+        return $this->_table->unique($fields);
+    }
+
     public function setAttribute($attr, $value)
     {

branches/1.1/lib/Doctrine/Table.php

@@ -84 +84 @@
 
     /**
+     * Array of unique sets of fields. These values are validated on save
+     *
+     * @var array $_uniques
+     */
+    protected $_uniques = array();
+
+    /**
      * @var array $_fieldNames            an array of field names. used to look up field names
      *                                    from column names.
@@ -807 +814 @@
 
         return false;
+    }
+
+    /**
+     * Add set of fields to be unique. Will automatically create unique
+     * index and validate the values on save
+     *
+     * @param array $fields 
+     * @return void
+     */
+    public function unique($fields)
+    {
+        $name = implode('_', $fields) . '_unqidx';
+        $definition = array('type' => 'unique', 'fields' => $fields);
+        $this->addIndex($name, $definition);
+
+        $this->_uniques[] = $fields;
     }
 
@@ -1753 +1776 @@
 
     /**
+     * Validate all the unique sets of fields for the given Doctrine_Record instance
+     *
+     * @param Doctrine_Record $record
+     */
+    public function validateUniques(Doctrine_Record $record)
+    {
+        $errorStack = $record->getErrorStack();
+        $validator = Doctrine_Validator::getValidator('unique');
+        $validator->invoker = $record;
+
+        foreach ($this->_uniques as $fields)
+        {
+            $validator->field = $fields;
+            $values = array();
+            foreach ($fields as $field) {
+                $values[] = $record->$field;
+            }
+            if ( ! $validator->validate($values)) {
+                foreach ($fields as $field) {
+                    $errorStack->add($field, $validator);
+                }
+            }
+        }
+    }
+
+    /**
      * getColumnCount
      *
@@ -1815 +1864 @@
     {
         return $this->getColumnNames((array) $this->getIdentifier());
+    }
+
+    /**
+     * Get array of sets of unique fields
+     *
+     * @return array $uniques
+     */
+    public function getUniques()
+    {
+        return $this->_uniques;
     }
 

branches/1.1/lib/Doctrine/Validator.php

@@ -77 +77 @@
             $table->validateField($fieldName, $value, $record);
         }
+        $table->validateUniques($record);
     }
 

branches/1.1/lib/Doctrine/Validator/Unique.php

@@ -48 +48 @@
         }
 
-        $sql   = 'SELECT ' . $pks . ' FROM ' . $table->getTableName() . ' WHERE ' . $this->field . ' = ?';
-        
-        $values = array();
-        $values[] = $value;
+        $sql   = 'SELECT ' . $pks . ' FROM ' . $table->getTableName();
+        if (is_array($this->field)) {
+            $sql .= ' WHERE ' . implode(' = ? AND ', $this->field) . ' = ?';
+            $values = $value;
+        } else {
+            $sql .= ' WHERE ' . $this->field . ' = ?';
+            $values = array();
+            $values[] = $value;
+        }
         
         // If the record is not new we need to add primary key checks because its ok if the 
@@ -63 +68 @@
             }
         }
-        
+
         $stmt  = $table->getConnection()->getDbh()->prepare($sql);
         $stmt->execute($values);

branches/1.1/tests/run.php

@@ -28 +28 @@
 $tickets->addTestCase(new Doctrine_Ticket_Njero_TestCase());
 $tickets->addTestCase(new Doctrine_Ticket_Ayoub_TestCase());
+$tickets->addTestCase(new Doctrine_Ticket_255_TestCase());
 $tickets->addTestCase(new Doctrine_Ticket_381_TestCase());
 $tickets->addTestCase(new Doctrine_Ticket_384_TestCase());

branches/1.1/UPGRADE_TO_1_1

@@ -93 +93 @@
 -------------------
 
-You can now convert a Doctrine_Collection in to a key value array made up of the values from the two specified columns.
+[r5032](http://trac.doctrine-project.org/changeset/5032) - You can now convert a Doctrine_Collection in to a key value array made up of the values from the two specified columns.
 
     $q = Doctrine_Query::create()
@@ -114 +114 @@
     )
     */
+
+Doctrine Validation
+-------------------
+
+[r5033](http://trac.doctrine-project.org/changeset/5033) - You can now specify a unique validator on a set of fields. The argument of the unique() function can either be an array of fields or an argument for each field.
+
+    public function setTableDefinition()
+    {
+        $this->hasColumn('username', 'string', 255);
+        $this->hasColumn('email_address', 'string', 255);
+
+        $this->unique('username', 'email_address');
+    }