Merge pull request #13 from ADmad/setorder

Allow passing records to setOrder() in multiple formats.

Author: ADmad

src/Model/Behavior/SequenceBehavior.php

@@ -261,35 +261,51 @@ public function beforeDelete(Event $event, Entity $entity)
     /**
      * Set order for list of records provided.
      *
-     * @param array $data Data.
+     * Records can be provided as array of entities or array of associative
+     * arrays like `[['id' => 1], ['id' => 2]]` or array of primary key values
+     * like `[1, 2]`.
+     *
+     * @param array|\Cake\Datasource\EntityInterface $records Records.
      *
      * @return bool
      */
-    public function setOrder($data)
+    public function setOrder(array $records)
     {
         $config = $this->config();
         $table = $this->_table;
 
-        $order = $this->_config['start'];
-        foreach ($data as $key => $record) {
-            $data[$key][$this->_config['order']] = $order++;
-        }
-
         $table->removeBehavior('Sequence');
 
-        $return = $table->connection()->transactional(function ($connection) use ($table, $data) {
-            $entities = $table->newEntities($data);
+        $return = $table->connection()->transactional(
+            function ($connection) use ($table, $records, $config) {
+                $order = $this->_config['start'];
+                $field = $this->_config['order'];
+
+                foreach ($records as $record) {
+                    if (is_scalar($record)) {
+                        $record = [$table->primaryKey() => $record];
+                    }
+
+                    if (is_array($record)) {
+                        $entity = $table->newEntity();
+                        $record = $entity->set($record, ['guard' => false]);
+                        $record->isNew(false);
+                    }
 
-            foreach ($entities as $entity) {
-                $entity->isNew(false);
-                $r = $table->save($entity, ['atomic' => false, 'validate' => false]);
-                if ($r === false) {
-                    return false;
+                    $record->set($field, $order++);
+
+                    $r = $table->save(
+                        $record,
+                        ['atomic' => false, 'checkRules' => false]
+                    );
+                    if ($r === false) {
+                        return false;
+                    }
                 }
-            }
 
-            return true;
-        });
+                return true;
+            }
+        );
 
         $table->addBehavior('Sequence.Sequence', $config);
 

tests/TestCase/Model/Behavior/SequenceBehaviorTest.php

@@ -6,10 +6,16 @@
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 
+class Item extends Entity
+{
+    protected $_accessible = ['*' => true, 'id' => false];
+}
+
 class Items extends Table
 {
     public function initialize(array $config)
     {
+        $this->entityClass('Sequence\Test\TestCase\Model\Behavior\Item');
         $this->addBehavior('Sequence.Sequence', ['start' => 0]);
     }
 }
@@ -38,7 +44,11 @@ public function initialize(array $config)
 
 class SequenceTest extends TestCase
 {
-    public $fixtures = ['plugin.Sequence.Items', 'plugin.Sequence.GroupedItems', 'plugin.Sequence.KeywordItems'];
+    public $fixtures = [
+        'plugin.Sequence.Items',
+        'plugin.Sequence.GroupedItems',
+        'plugin.Sequence.KeywordItems',
+    ];
 
     /**
      * [testSave description].
@@ -242,6 +252,7 @@ public function testSetOrder()
             'className' => 'Sequence\Test\TestCase\Model\Behavior\Items',
         ]);
 
+        // Array of arrays
         $result = $Items->setOrder([
             ['id' => 4],
             ['id' => 3],
@@ -252,6 +263,29 @@ public function testSetOrder()
         $this->assertTrue($result);
         $this->assertOrder([4, 3, 2, 1, 5], $Items);
 
+        // Array of ids
+        $result = $Items->setOrder([5, 4, 2, 1, 3]);
+        $this->assertTrue($result);
+        $this->assertOrder([5, 4, 2, 1, 3], $Items);
+
+        // Array of entities
+        $entities = $Items->newEntities(
+            [
+                ['id' => 4],
+                ['id' => 3],
+                ['id' => 2],
+                ['id' => 1],
+                ['id' => 5],
+            ],
+            ['accessibleFields' => ['id' => true]]
+        );
+        foreach ($entities as &$entity) {
+            $entity->isNew(false);
+        }
+        $result = $Items->setOrder($entities);
+        $this->assertTrue($result);
+        $this->assertOrder([4, 3, 2, 1, 5], $Items);
+
         $GroupedItems = TableRegistry::get('GroupedItems', [
             'table' => 'grouped_items',
             'alias' => 'GroupedItems',