Changeset 8117

Timestamp:

03/27/08 17:48:20 (7 months ago)

Author:

francois

Message:

sfPropelFinderPlugin Added joins

Files:

• plugins/sfPropelFinderPlugin/README (modified) (4 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (8 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (5 diffs)

plugins/sfPropelFinderPlugin/README

@@ -75 +75 @@
-// Finding all Articles where published_at less than time()
-$articles = $articleFinder->wherePublishedAt('<', time())->find();
+// The whereXXX method accepts simple or composed column names
+$articles = $articleFinder->whereArticle_PublishedAt('<', time())->find();
-}}}
-
@@ -117 +119 @@
-The syntax should remind you of `sfFinder` and `sfTestBrowser`.
-
+=== Joins ===
+
+{{{
+#!php
+<?php
+$article1 = new Article();
+$article1->setTitle('Hello, world!');
+$article1->setCategory($category1);
+$article1->save();
+$author1 = new Author();
+$author1->setName('John');
+$author1->save();
+$comment = new Comment();
+$comment->setContent('You rock!');
+$comment->setArticle($article1);
+$comment->setAuthor($author1);
+$comment->save();
+// Add a join statement
+// No need to tell the finder which columns to use for the join, just the related Class
+// After all, the columns of the FK are already defined in the schema
+$article = sfPropelFinder::from('Article')->
+  joinComment()->
+  whereComment_Content('foo')->
+  findOne();
+// You can chain joins if you want to make it more complex
+$article = sfPropelFinder::from('Article')->
+  joinComment()->
+  joinAuthor()->
+  whereAuthor_Name('You rock!')->
+  findOne();
+}}}
+
-=== Writing your own business logic into a finder ===
-
@@ -144 +178 @@
-== TODO ==
-
-Handle Joins
+Allow hydrating of related objects (doSelectJoinXXX equivalent)
- * Add more magic!
- * Merge with sfPropelImpersonatorPlugin?
@@ -152 +186 @@
-=== 2008-03-27 | Trunk ===
-
+ * francois: Added `sfPropelFinder::joinXXX()` method
+ * francois: Added `sfPropelFinder::join()` method
+ * francois: added complete `whereClassName_ColumnName()` syntax
- * francois: Added `sfPropelFinder::count()` method
- 

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -13 +13 @@
-{
-  protected $peerClass = null;
-  protected $mapBuilder = null;
-  protected $databaseMap = null;
-  protected $tableMap = null;
-  protected $columnMaps = null;
-  protected $criteria = null;
+  protected $relations = null;
-  
-  public function getPeerClass()
@@ -26 +24 @@
-  public function setPeerClass($peerClass)
-  {
+    $this->relations[]= $peerClass;
-    return $this->peerClass = $peerClass;
-  }
-  
-  public function getMapBuilder()
-  {
-    return $this->mapBuilder;
-  }
-  
-  public function setMapBuilder($mapBuilder)
-  {
-    return $this->mapBuilder = $mapBuilder;
-  }
-  
@@ -56 +45 @@
-    $mapBuilder = call_user_func(array($this->peerClass, 'getMapBuilder'));
-    $mapBuilder->doBuild();
-
-
-
-
-
+
-  }
-  
@@ -85 +70 @@
-    
-    return $ret;
-    
-  }
-  
@@ -158 +142 @@
-  }
-  
+  public function join($column1, $column2, $operator = null)
+  {
+    $this->criteria->addJoin($column1, $column2, $operator);
+    
+    return $this;
+  }
+  
-  public function __call($name, $arguments)
-  {
@@ -163 +154 @@
-    if(strpos($name, 'where') === 0)
-    {
-
+
+
+
+
+
+
+
+
+
+
-      $comparison = Criteria::EQUAL;
-      switch (count($arguments))
@@ -185 +185 @@
-          throw new Exception('{sfPropelFinder} whereXXX can only be called with one or two arguments');
-      }
-
+return 
-    }
-    
@@ -197 +197 @@
-        $order = Criteria::ASC;
-      }
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    try
-    {
-this->
+
-      return $column;
-    }
-    catch (PropelException $e)
-    {
-this->
+
-    }
-  }

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -9 +9 @@
- */
-
+/*
+You need a model built with a running database to run these tests.
+The tests expect a model similar to this one:
+
+    propel:
+      article:
+        id:          ~
+        title:       varchar(255)
+        category_id: ~
+      category:
+        id:          ~
+        name:        varchar(255)
+      comment:
+        id:          ~
+        content:     varchar(255)
+        article_id:  ~
+        author_id:   ~
+      author:
+        id:          ~
+        name:        varchar(255)
+
+Beware that the tables for these models will be emptied by the tests, so use a test database connection.
+*/
+
-// Autofind the first available app environment
-$sf_root_dir = realpath(dirname(__FILE__).'/../../../../');
@@ -39 +63 @@
-ArticlePeer::doDeleteAll();
-
-42
+53
-
-$t->diag('find()');
@@ -202 +226 @@
-
-$article = sfPropelFinder::from('Article')->whereTitle('abc')->findOne();
-
+
+
+
-$article = sfPropelFinder::from('Article')->whereTitle('def')->findOne();
-$t->is($article->getId(), $article2->getId(), 'whereXXX() adds a WHERE condition on the XXX column');
@@ -212 +238 @@
-$t->is(count($articles), 3, 'whereXXX() accepts a text comparator and is permissive on syntax');
-
+
-$t->diag('orderBy() magic');
-try
@@ -272 +299 @@
-$article = sfPropelFinder::from('Article')->orderByTitle('desc')->findOne();
-$t->is($article->getTitle(), 'ccccc', 'orderByXXX() orders by column and takes an order as argment');
+
+$t->diag('join() magic');
+
+list($column1, $column2) = sfPropelFinder::from('Article')->getRelation('Category');
+$t->is($column1, ArticlePeer::CATEGORY_ID, 'getRelation() guesses the two parts of a relation properly for many-to-one relationships');
+$t->is($column2, CategoryPeer::ID, 'getRelation() guesses the two parts of a relation properly for many-to-one relationships');
+list($column1, $column2) = sfPropelFinder::from('Article')->getRelation('Comment');
+$t->is($column1, CommentPeer::ARTICLE_ID, 'getRelation() guesses the two parts of a relation properly for one-to-many relationships');
+$t->is($column2, ArticlePeer::ID, 'getRelation() guesses the two parts of a relation properly for one-to-many relationships');
+ArticlePeer::doDeleteAll();
+CategoryPeer::doDeleteAll();
+$category1 = new Category();
+$category1->setName('cat1');
+$category1->save();
+$category2 = new Category();
+$category2->setName('cat2');
+$category2->save();
+$article1 = new Article();
+$article1->setTitle('aaaaa');
+$article1->setCategory($category1);
+$article1->save();
+$article2 = new Article();
+$article2->setTitle('bbbbb');
+$article2->setCategory($category1);
+$article2->save();
+$article3 = new Article();
+$article3->setTitle('ccccc');
+$article3->setCategory($category2);
+$article3->save();
+$nbArticles = sfPropelFinder::from('Article')->joinCategory()->where(CategoryPeer::NAME, 'cat1')->count();
+$t->is($nbArticles, 2, 'joinXXX() allows to join to another table (many-to-one)');
+$nbArticles = sfPropelFinder::from('Article')->joinCategory()->where(CategoryPeer::NAME, 'cat2')->count();
+$t->is($nbArticles, 1, 'joinXXX() allows to join to another table (many-to-one)');
+$article = sfPropelFinder::from('Article')->joinCategory()->where(CategoryPeer::NAME, 'cat2')->findOne();
+$t->is($article->getTitle(), 'ccccc', 'joinXXX() allows to join to another table (many-to-one)');
+ArticlePeer::doDeleteAll();
+CommentPeer::doDeleteAll();
+$article1 = new Article();
+$article1->setTitle('aaaaa');
+$article1->setCategory($category1);
+$article1->save();
+$article2 = new Article();
+$article2->setTitle('bbbbb');
+$article2->setCategory($category1);
+$article2->save();
+$comment = new Comment();
+$comment->setContent('foo');
+$comment->setArticle($article2);
+$comment->save();
+$nbArticles = sfPropelFinder::from('Article')->joinComment()->where(CommentPeer::CONTENT, 'foo')->count();
+$t->is($nbArticles, 1, 'joinXXX() allows to join to another table (one-to-many)');
+$article = sfPropelFinder::from('Article')->joinComment()->where(CommentPeer::CONTENT, 'foo')->findOne();
+$t->is($article->getTitle(), 'bbbbb', 'joinXXX() allows to join to another table (one-to-many)');
+
+ArticlePeer::doDeleteAll();
+CommentPeer::doDeleteAll();
+AuthorPeer::doDeleteAll();
+$article1 = new Article();
+$article1->setTitle('aaaaa');
+$article1->setCategory($category1);
+$article1->save();
+$author1 = new Author();
+$author1->setName('John');
+$author1->save();
+$comment = new Comment();
+$comment->setContent('foo');
+$comment->setArticle($article1);
+$comment->setAuthor($author1);
+$comment->save();
+$article = sfPropelFinder::from('Article')->joinComment()->joinAuthor()->where(AuthorPeer::NAME, 'John')->findOne();
+$t->is($article->getTitle(), 'aaaaa', 'you can chan several joinXXX() statements');