From ae738ccb97d1ef32e2cde7e3548d57ec0e6b4c7a Mon Sep 17 00:00:00 2001
From: doctrine <doctrine@625475ce-881a-0410-a577-b389adb331d8>
Date: Sun, 6 Aug 2006 20:46:12 +0000
Subject: [PATCH] Some new manual code examples

---
 Doctrine/Form.php                             |  1 +
 Doctrine/Hydrate.php                          | 29 ++++++++++++++++++-
 Doctrine/Iterator/Normal.php                  | 19 ++++++++++++
 Doctrine/Validator.php                        | 21 +++++++++++++-
 ...arted - Record identifiers - Composite.php |  8 +++++
 ...started - Record identifiers - Natural.php |  7 +++++
 ...le definition - Data types and lengths.php | 27 +++++++++++++++++
 ...etting table definition - Introduction.php | 14 +++++++++
 ...Getting started - Starting new project.php |  4 +--
 manual/documentation.php                      |  7 +++++
 manual/highlight.php                          |  2 +-
 manual/top.php                                |  5 +++-
 tests/RawSqlTestCase.php                      |  4 +--
 13 files changed, 140 insertions(+), 8 deletions(-)
 create mode 100644 manual/codes/Getting started - Record identifiers - Composite.php
 create mode 100644 manual/codes/Getting started - Record identifiers - Natural.php
 create mode 100644 manual/codes/Getting started - Setting table definition - Data types and lengths.php
 create mode 100644 manual/codes/Getting started - Setting table definition - Introduction.php

diff --git a/Doctrine/Form.php b/Doctrine/Form.php
index 6f527a644..31c6e3e42 100644
--- a/Doctrine/Form.php
+++ b/Doctrine/Form.php
@@ -32,6 +32,7 @@ class Doctrine_Form implements Iterator {
         if( ! in_array("autoincrement",$e) && ! in_array("protected",$e)) {
             if($enum) {
                 $elements[$column] = "<select name='data[$column]'>\n";
+				$elements[$column] .= "	  <option value='-'>-</option>\n";
                 foreach($enum as $k => $v) {
                     if($this->record->get($column) == $v) {
                         $str = 'selected';
diff --git a/Doctrine/Hydrate.php b/Doctrine/Hydrate.php
index 676c28922..a9867b1a9 100644
--- a/Doctrine/Hydrate.php
+++ b/Doctrine/Hydrate.php
@@ -1,6 +1,33 @@
 <?php
+/* 
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
 Doctrine::autoload('Doctrine_Access');
-
+/**
+ * Doctrine_Hydrate is a base class for Doctrine_RawSql and Doctrine_Query.
+ * Its purpose is to populate object graphs.
+ *
+ *
+ * @package     Doctrine ORM
+ * @url         www.phpdoctrine.com
+ * @license     LGPL
+ */
 class Doctrine_Hydrate extends Doctrine_Access {
     /**
      * @var array $fetchmodes               an array containing all fetchmodes
diff --git a/Doctrine/Iterator/Normal.php b/Doctrine/Iterator/Normal.php
index 9e0b42733..4e218951a 100644
--- a/Doctrine/Iterator/Normal.php
+++ b/Doctrine/Iterator/Normal.php
@@ -1,4 +1,23 @@
 <?php
+/* 
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
 Doctrine::autoload('Doctrine_Iterator');
 
 class Doctrine_Iterator_Normal extends Doctrine_Iterator {
diff --git a/Doctrine/Validator.php b/Doctrine/Validator.php
index 684389982..3fe0356ef 100644
--- a/Doctrine/Validator.php
+++ b/Doctrine/Validator.php
@@ -1,7 +1,26 @@
 <?php
+/* 
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.phpdoctrine.com>.
+ */
 /**
  * Doctrine_Validator
- * Doctrine_Session uses this class for transaction validation
+ * Doctrine_Validator performs validations in record properties
  *
  * @package     Doctrine ORM
  * @url         www.phpdoctrine.com
diff --git a/manual/codes/Getting started - Record identifiers - Composite.php b/manual/codes/Getting started - Record identifiers - Composite.php
new file mode 100644
index 000000000..91cb4901d
--- /dev/null
+++ b/manual/codes/Getting started - Record identifiers - Composite.php	
@@ -0,0 +1,8 @@
+<?php
+class Groupuser extends Doctrine_Record {
+    public function setTableDefinition() {
+        $this->hasColumn("user_id", "integer" 20, "primary");
+        $this->hasColumn("group_id", "integer", 20, "primary");
+    }
+}
+?>
diff --git a/manual/codes/Getting started - Record identifiers - Natural.php b/manual/codes/Getting started - Record identifiers - Natural.php
new file mode 100644
index 000000000..0631fd9e0
--- /dev/null
+++ b/manual/codes/Getting started - Record identifiers - Natural.php	
@@ -0,0 +1,7 @@
+<?php
+class User extends Doctrine_Record {
+    public function setTableDefinition() {
+        $this->hasColumn("name","string",200,"primary");
+    }
+}
+?>
diff --git a/manual/codes/Getting started - Setting table definition - Data types and lengths.php b/manual/codes/Getting started - Setting table definition - Data types and lengths.php
new file mode 100644
index 000000000..89fbc5267
--- /dev/null
+++ b/manual/codes/Getting started - Setting table definition - Data types and lengths.php	
@@ -0,0 +1,27 @@
+<?php
+class Article extends Doctrine_Record {
+    public function setTableDefinition() {
+        // few mapping examples:
+
+        // maps into VARCHAR(100) on mysql
+        $this->hasColumn("title","string",100);
+        
+        // maps into TEXT on mysql
+        $this->hasColumn("content","string",4000);
+
+        // maps into TINYINT on mysql
+        $this->hasColumn("type","integer",1);
+
+        // maps into INT on mysql
+        $this->hasColumn("type2","integer",11);
+
+        // maps into BIGINT on mysql
+        $this->hasColumn("type3","integer",20);
+
+        // maps into TEXT on mysql
+        // (serialized and unserialized automatically by doctrine)
+        $this->hasColumn("types","array",4000);
+
+    }
+}
+?>
diff --git a/manual/codes/Getting started - Setting table definition - Introduction.php b/manual/codes/Getting started - Setting table definition - Introduction.php
new file mode 100644
index 000000000..43e846f0c
--- /dev/null
+++ b/manual/codes/Getting started - Setting table definition - Introduction.php	
@@ -0,0 +1,14 @@
+<?php
+class Email extends Doctrine_Record {
+    public function setTableDefinition() {
+        // setting custom table name:
+        $this->setTableName('emails');
+
+        $this->hasColumn("address",         // name of the column
+                         "string",          // column type
+                         "200",             // column length
+                         "notblank|email"   // validators / constraints
+                         );
+    }
+}
+?>
diff --git a/manual/docs/Getting started - Starting new project.php b/manual/docs/Getting started - Starting new project.php
index 1d257e3b9..a291b2f46 100644
--- a/manual/docs/Getting started - Starting new project.php	
+++ b/manual/docs/Getting started - Starting new project.php	
@@ -2,9 +2,9 @@ Doctrine_Record is the basic component of every doctrine-based project.
 There should be atleast one Doctrine_Record for each of your database tables.
 Doctrine_Record follows <a href="http://www.martinfowler.com/eaaCatalog/activeRecord.html">Active Record pattern</a>.
 <br \><br \>
-Doctrine auto-creates database tables and always adds a primary key column named 'id' to tables. Only thing you need to for creating database tables 
+Doctrine auto-creates database tables and always adds a primary key column named 'id' to tables that doesn't have any primary keys specified. Only thing you need to for creating database tables
 is defining a class which extends Doctrine_Record and setting a setTableDefinition method with hasColumn() method calls.
 <br \><br \>
 Consider we want to create a database table called 'user' with columns id(primary key), name, username, password and created. You only need couple of lines of code
-to create a simple CRUD (Create, Retrieve, Update, Delete) application for this database table.
+to create a simple up-and-running model.
 
diff --git a/manual/documentation.php b/manual/documentation.php
index edfc59fff..930f57e01 100644
--- a/manual/documentation.php
+++ b/manual/documentation.php
@@ -88,7 +88,14 @@ $menu = array("Getting started" =>
                                         "Introduction",
                                         "Data types and lengths",
                                         "Constraints and validators",
+                                        "Enum emulation"
                                         ),
+                        "Record identifiers" => array(
+                                        "Introduction",
+                                        "Autoincremented",
+                                        "Natural",
+                                        "Composite",
+                                        "Sequential")
                         ),
            "Basic Components" =>
                         array(
diff --git a/manual/highlight.php b/manual/highlight.php
index d0e2c2af7..d23d2f08c 100644
--- a/manual/highlight.php
+++ b/manual/highlight.php
@@ -472,7 +472,7 @@ class PHP_Highlight
 
             case T_COMMENT:
             case T_DOC_COMMENT:
-            case T_ML_COMMENT:
+            //case T_ML_COMMENT:
                 return $this->highlight['comment'];
             break;
 
diff --git a/manual/top.php b/manual/top.php
index 7de1cb637..17f8ec567 100644
--- a/manual/top.php
+++ b/manual/top.php
@@ -13,7 +13,10 @@
 <table width="100%" cellspacing=0 cellpadding=0>
     <tr>
         <td align="right">
-        <a href="index.php">main</a> | <a href="documentation.php">documentation</a> | <a href="https://sourceforge.net/project/showfiles.php?group_id=160015">download</a> | <a href="faq.php">FAQ</a> | <a href="about.php">about</a> | <a href="http://www.phpbbserver.com/phpdoctrine/">forums</a>
+        <?php
+        // https://sourceforge.net/project/showfiles.php?group_id=160015
+        ?>
+        <a href="index.php">main</a> | <a href="documentation.php">documentation</a> | <a href="download.php">download</a> | <a href="faq.php">FAQ</a> | <a href="about.php">about</a> | <a href="http://www.phpbbserver.com/phpdoctrine/">forums</a>
         </td>
         <td width=30>
         </td>
diff --git a/tests/RawSqlTestCase.php b/tests/RawSqlTestCase.php
index 23329e97a..1a6bdb321 100644
--- a/tests/RawSqlTestCase.php
+++ b/tests/RawSqlTestCase.php
@@ -61,10 +61,10 @@ class Doctrine_RawSql_TestCase extends Doctrine_UnitTestCase {
 
         $query->addComponent("entity", "Entity");
         $query->addComponent("phonenumber", "Entity.Phonenumber");
-
+        
         $coll = $query->execute();
         $this->assertEqual($coll->count(), 11);
-        
+
         $count = $this->dbh->count();
         
         $coll[4]->Phonenumber[0]->phonenumber;