Changeset 29166

Timestamp:

04/15/10 23:52:48 (3 years ago)

Author:

sergiovier

Message:

Added support to associative arrays. Added some unit test to sfDataSourceArray and fixed some documentation.

Files:

• plugins/sfDataSourcePlugin/trunk/README (modified) (3 diffs)
• plugins/sfDataSourcePlugin/trunk/lib/sfDataSourceArray.class.php (modified) (7 diffs)
• plugins/sfDataSourcePlugin/trunk/test/unit/datasource/sfDataSourceArrayTest.php (modified) (5 diffs)

plugins/sfDataSourcePlugin/trunk/README

@@ -3 +3 @@
-
-This plugin allows to read various data sources in a unified way. These data sources can be filtered and sorted in a generic way, 
-be 
+
-
-
+ (simple and associative)
-You are however free to add more implementations, for example to process csv or xml data. Provided is also an imap implementation,
-but this is also unsupported.
@@ -64 +64 @@
---------
-
-
+
+
+
-
-
+
-
-Array
@@ -94 +96 @@
-TODO: show more difficult schema's and relations
-
-n
+
-RequireColumn is called automatically when you select columns for your grid, which in its turn will automatically join
-related tables. Sorting on foreign fields or filtering on any table is now easy, because the model is aware of the relations. 

plugins/sfDataSourcePlugin/trunk/lib/sfDataSourceArray.class.php

@@ -107 +107 @@
-    $this->originalData = $data;
-    $this->data = $this->originalData;
-
+
-  }
-
@@ -125 +125 @@
-    }
-
-
+
+
+
+
-  }
-
@@ -172 +175 @@
-  /**
-   * requireColumn checks if the source contains the desired column.
- 
+
-   * the DataSource doesn't have any model-data to base its decision on
- 
+
-   * @see sfDataSourceInterface::requireColumn()
-   */
@@ -195 +198 @@
-    usort($this->data, array($this, 'sortCallback'));
-  }
-
+
-  /**
-   * Callback method used by usort(). Compares two arrays by the current
@@ -217 +220 @@
-    }
-  }
-
+
-  /**
-   * @see sfDataSourceInterface
@@ -224 +227 @@
-  {
-    // TODO: because of this, you should first Filter before you sort!
- 
+
-    $this->data = array();
-
+
-    $this->requireColumn($columnName);
-
@@ -241 +244 @@
-  //TODO: implement filtering on an array
-  protected function filterCallback($row)
-  
+
-    throw new Exception('This method has not been finished yet');
-  }
-
+
-}

plugins/sfDataSourcePlugin/trunk/test/unit/datasource/sfDataSourceArrayTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-3
+5
-
-$data = array(
@@ -29 +29 @@
-{
-  new sfDataSourceArray(array(
- 
+
-    array('id' => 2, 'surname' => 'Stefan'),
-    array('id' => 3, 'name' => 'Jonathan'),
@@ -42 +42 @@
-{
-  new sfDataSourceArray(array(
- 
+
-    'id' => 2, 'surname' => 'Stefan',
-    'id' => 3, 'name' => 'Jonathan',
@@ -55 +55 @@
-{
-  new sfDataSourceArray(array(
- 
+
-    'id' => 2, 'surname' => 'Stefan',
-    'id' => 3, 'name' => 'Jonathan',
@@ -273 +273 @@
-}
-
+
+// associative arrays
+$t->diag('support for associative arrays');
+
+$associative_data = array(
+  'first'  => array('id' => 1, 'name' => 'Fabien'),
+  'second' => array('id' => 2, 'name' => 'Francois'),
+  'third'  => array('id' => 3, 'name' => 'Jonathan'),
+);
+$s = new sfDataSourceArray($associative_data);
+try
+{
+  $s->requireColumn('name');
+  $t->pass('sfDataSourceArray accepts existing column (name) of an array');
+}
+catch (Exception $e)
+{
+  $t->fail('sfDataSourceArray accepts existing column (name) of an array');
+}
+try
+{
+  $s->requireColumn('anyColumn');
+  $t->fail('sfDataSourceArray does not accept columns that are not in the array');
+}
+catch (LogicException $e)
+{
+  $t->pass('sfDataSourceArray does not accept columns that are not in the array');
+}
+
+$t->is(array_keys(iterator_to_array($s, true)), range(0, 2), 'sfDataSourceArray implements the SeekableIterator interface');
+$t->is(count(iterator_to_array($s)), 3, 'sfDataSourceArray implements the SeekableIterator interface');
+
+$s->seek(1);
+$t->is($s['id'], 2, 'sfDataSourceArray implements the SeekableIterator interface');
+$t->is($s['name'], 'Francois', 'sfDataSourceArray implements the SeekableIterator interface');
+
+try
+{
+  $s->seek(30);
+  $t->fail('->seek() throws an "OutOfBoundsException" when the given index is too large');
+}
+catch (OutOfBoundsException $e)
+{
+  $t->pass('->seek() throws an "OutOfBoundsException" when the given index is too large');
+}
+
+try
+{
+  $s->seek(-1);
+  $t->fail('->seek() throws an "OutOfBoundsException" when the given index is too small');
+}
+catch (OutOfBoundsException $e)
+{
+  $t->pass('->seek() throws an "OutOfBoundsException" when the given index is too small');
+}
+$t->is(count($s), 3, 'sfDataSourceArray implements the Countable interface');
+
+
+$s = new sfDataSourceArray($associative_data);
+$s->setLimit(3);
+$values = array();
+foreach ($s as $row)
+{
+  $values[] = $row['id'];
+}
+$t->is($values, range(1,3), '->setLimit() limits the records returned by the iterator');
+
+
+$s = new sfDataSourceArray($associative_data);
+
+$t->is($s['id'], 1, 'sfDataSourceArray implements the ArrayAccess interface');
+$t->is($s['name'], 'Fabien', 'sfDataSourceArray implements the ArrayAccess interface');
+$t->ok(isset($s['id']), 'sfDataSourceArray implements the ArrayAccess interface');
+$t->ok(!isset($s['foobar']), 'sfDataSourceArray implements the ArrayAccess interface');
+$s->next();
+$t->is($s['id'], 2, 'sfDataSourceArray implements the ArrayAccess interface');
+$t->is($s['name'], 'Francois', 'sfDataSourceArray implements the ArrayAccess interface');
+
+try
+{
+  $s['name'] = 'Foobar';
+  $t->fail('sfDataSourceArray throws a "LogicException" when fields are set using ArrayAccess');
+}
+catch (LogicException $e)
+{
+  $t->pass('sfDataSourceArray throws a "LogicException" when fields are set using ArrayAccess');
+}
+try
+{
+  unset($s['name']);
+  $t->fail('sfDataSourceArray throws a "LogicException" when fields are unset using ArrayAccess');
+}
+catch (LogicException $e)
+{
+  $t->pass('sfDataSourceArray throws a "LogicException" when fields are unset using ArrayAccess');
+}
+
+foreach ($s as $k => $v);
+
+try
+{
+  $s['name'];
+  $t->fail('sfDataSourceArray throws an "OutOfBoundsException" when fields are accessed after iterating');
+}
+catch (OutOfBoundsException $e)
+{
+  $t->pass('sfDataSourceArray throws an "OutOfBoundsException" when fields are accessed after iterating');
+}
+try
+{
+  isset($s['name']);
+  $t->fail('sfDataSourceArray throws an "OutOfBoundsException" when fields are accessed after iterating');
+}
+catch (OutOfBoundsException $e)
+{
+  $t->pass('sfDataSourceArray throws an "OutOfBoundsException" when fields are accessed after iterating');
+}