Changeset 10123

Timestamp:

07/04/08 19:00:48 (5 months ago)

Author:

francois

Message:

sfPropelFinderPlugin Added support for with() in findPk() (and documented the method)

Files:

• plugins/sfPropelFinderPlugin/README (modified) (3 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (2 diffs)

plugins/sfPropelFinderPlugin/README

@@ -487 +487 @@
-}}}
-
+=== Finding Objects From A Primary Key ===
+
+{{{
+#!php
+<?php
+$article = sfPropelFinder::from('Article')->findPk(123);
+// is equivalent to
+$article = ArticlePeer::retrieveByPk(123);
+
+// But it's longer to write so what's the point?
+// You can hydrate related objects by using with()
+// So you need a single query to retrieve an object and its related objects
+$article = sfPropelFinder::from('Article')->
+  with('Category', 'I18n')->
+  findPk(123);
+
+// Also works for objects with composite primary keys
+$articleI18n = sfPropelFinder::from('ArticleI18n')->findPk(array(123, 'fr'));
+}}}
+
-=== Hacking the finder ===
-
@@ -517 +537 @@
- * Put as a parent class in the PeerBuilder so that every Peer class can be a finder
- * Merge with sfPropelImpersonatorPlugin!
- * Add support for `with()` in `findPk()` (and document the method)
- * Handle complex queries with And and Or
- * Add a `__toString()` method which returns a var_export() of the results, or a description of the conditions if not yet executed
@@ -527 +546 @@
-=== 2008-07-04 | Trunk ===
-
+ * francois: Added support for `with()` in `findPk()` (and documented the method)
- * francois: Added the ability to do left, right, and inner joins in a simple way
- * francois: Made `join()` useless if there is an explicit `where()` on the table afterwards

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -330 +330 @@
-  public function findPk($pk, $con = null)
-  {
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-    else
-    {
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-  
@@ -1059 +1090 @@
-      return $this->join(substr($name, 4), $arguments);
-    }
-
-
-
+
+
-      $joinType = strtoupper(substr($name, 0, $pos)) . ' JOIN';
-      array_push($arguments, $joinType);

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -65 +65 @@
-ArticlePeer::doDeleteAll();
-
-2
+5
-
-$t->diag('find()');
@@ -226 +226 @@
-$t->is(count($articles), 2, 'findPk() returns the objects with the primary keys matching the arguments');
-
+$article = $finder->with('Category')->findPk($article2->getId());
+$t->cmp_ok(strpos($finder->getLatestQuery(), 'SELECT article.ID, article.VERSION, article.TITLE, article.CATEGORY_ID, category.ID, category.NAME FROM article, category'), '===', 0, 'findPk() is compatible with with()');
+
+ArticlePeer::doDeleteAll();
+
+$article1 = new Article();
+$article1->setTitle('foo');
+$article1->setCulture('fr');
+$article1->setContent('Bar');
+$article1->save();
+$articlei18n1 = $article1->getCurrentArticleI18n();
+try
+{
+  $articleI18n = sfPropelFinder::from('ArticleI18n')->findPk($articlei18n1->getId());
+  $t->fail('findPk() expects an array of values for objects with composite primary keys');
+}
+catch(Exception $e)
+{
+  $t->pass('findPk() expects an array of values for objects with composite primary keys');
+}
+$articleI18n = sfPropelFinder::from('ArticleI18n')->findPk(array($articlei18n1->getId(), $articlei18n1->getCulture()));
+$t->ok($articleI18n->equals($articlei18n1), 'findPk() retrieves objects with composite primary keys based on an array of Pks');
+
-$t->diag('Instanciation possibilities');
+
+ArticlePeer::doDeleteAll();
+
+$article1 = new Article();
+$article1->setTitle('foo');
+$article1->save();
+
+$article2 = new Article();
+$article2->setTitle('foo2');
+$article2->save();
+
+$article3 = new Article();
+$article3->setTitle('foo3');
+$article3->save();
-
-$finder = new sfPropelFinder('Article');