Fixed query sorting which now allows for "natural order", Uses php strnatcasecmp(). Added argument results( false ) - false on results() method that allows it to return the full document object or (by default = true) only the document data. Added argument first( false ) - false on first() method that allows it to return the full document object or (by default = true) only the document data. Minor additions to the documentation, changelog and tests.

Author: timothymarois

CHANGELOG.md

@@ -1,6 +1,12 @@
 Change Log
 ==========
 
+### 12/10/2017 - 1.0.10
+* Fixed query `sort` which allows for "natural order", issues before would assume "1" and "10" are equal in value, but this has been resolved with this update. Uses php `strnatcasecmp()`
+* Added argument `results( false )` - `false` on `results()` method that allows it to return the full document object or (by default = `true`) only the document data.
+* Added argument `first( false )` - `false` on `first()` method that allows it to return the full document object or (by default = `true`) only the document data.
+* Minor additions to the documentation.
+
 ### 09/09/2017 - 1.0.9
 * Fixed `customFilter` on #5 issue with array keys not properly resetting.
 * Improved speed of `filter()` since it was running the function closure function twice

README.md

@@ -34,7 +34,7 @@ Use `composer require tmarois/filebase`
 
 If you want to modify the `composer.json` manually, add `"tmarois/filebase" : "^1.0"` to your `required`
 
-You do not need to use composer, just download the files, and include it within your application, it does not have any dependencies, you will just need to keep it updated with any future releases. 
+You do not need to use composer, just download the files, and include it within your application, it does not have any dependencies, you will just need to keep it updated with any future releases.
 
 ## Usage
 
@@ -350,8 +350,8 @@ $usersWithGmail = $db->query()
                     ->results();
 
 
-// this will get the user that has the most page views (and returning 1 result)
-$user = $db->query()->orderBy('page_views', 'DESC')->first();
+// this will return the first user in the list based on ascending order of user name.
+$user = $db->query()->orderBy('name', 'ASC')->first();
 // print out the user name
 echo $user['name'];
 
@@ -361,7 +361,7 @@ $users = $db->query()->where('email','REGEX','/[a-z\d._%+-]+@[a-z\d.-]+\.[a-z]{2
 
 ```
 
-To run the query use `results()` or `resultDocuments()` or `first()` if you want only the first item
+To run the query use `results()` or `resultDocuments()` or if you only want to return the first item use `first()`
 
 ### Methods:
 
@@ -374,8 +374,8 @@ To run the query use `results()` or `resultDocuments()` or `first()` if you want
 These methods execute the query and return results *(do not try to use them together)*
 
 - `first()` Returns only the first query result (if you only want to return 1 item)
-- `results()` This will return all the document data as an array.
-- `resultDocuments()` This will return all the document objects
+- `results()` This will return all the document data as an array. Passing the argument of `false` will be the same as `resultDocuments()` (returning the full document), but default it's set to `true` and only returns the data array of your documents.
+- `resultDocuments()` This will return all the document objects, or you can do `results(false)` which is the alias.
 
 ### Comparison Operators:
 

src/Database.php

@@ -10,7 +10,7 @@ class Database
     * Stores the version of Filebase
     * use $db->getVersion()
     */
-    const VERSION = '1.0.9';
+    const VERSION = '1.0.10';
 
 
     //--------------------------------------------------------------------
@@ -76,6 +76,7 @@ public function version()
     * Then returns you a list of those documents.
     *
     * @param bool $include_documents (include all document objects in array)
+    * @param bool $data_only (if true only return the documents data not the full object)
     *
     * @return array $items
     */

src/Query.php

@@ -119,6 +119,7 @@ protected function addPredicate($logic,$arg)
     /**
     * ->getDocuments()
     *
+    *
     */
     public function getDocuments()
     {
@@ -132,10 +133,17 @@ public function getDocuments()
     /**
     * ->results()
     *
+    * @param bool $data_only - default:true (if true only return the documents data not the full object)
+    *
     */
-    public function results()
+    public function results( $data_only = true )
     {
-        return parent::run()->toArray();
+        if ($data_only === true)
+        {
+            return parent::run()->toArray();
+        }
+
+        return $this->resultDocuments();
     }
 
 
@@ -158,10 +166,18 @@ public function resultDocuments()
     /**
     * ->first()
     *
+    * @param bool $data_only - default:true (if true only return the documents data not the full object)
+    *
     */
-    public function first()
+    public function first( $data_only = true )
     {
-        $results = parent::run()->toArray();
+        if ($data_only === true)
+        {
+            $results = parent::run()->toArray();
+            return current($results);
+        }
+
+        $results = parent::run()->getDocuments();
         return current($results);
     }
 

src/QueryLogic.php

@@ -190,16 +190,22 @@ protected function sort()
 
             if ($sortBy == 'DESC')
             {
-                return $b->field($orderBy) <=> $a->field($orderBy);
+                $propA = $a->field($orderBy);
+                $propB = $b->field($orderBy);
+
+                // strnatcasecmp allows us to test in "natural" order
+                return strnatcasecmp($propB, $propA) <=> strnatcasecmp($propA, $propB);
+                
+                // return $b->field($orderBy) <=> $a->field($orderBy);
             }
 
             return $a->field($orderBy) <=> $b->field($orderBy);
+
         });
 
     }
 
 
-
     //--------------------------------------------------------------------
 
 

tests/QueryTest.php

@@ -432,6 +432,11 @@ public function testWhereIn()
                 'tags' => [
                     'social','network'
                 ]
+            ],
+            'Microsoft'=>[
+                'tags' => [
+                    'windows','xbox','search'
+                ]
             ]
         ];
 
@@ -445,11 +450,26 @@ public function testWhereIn()
 
 
         // test that they are ordered by name ASC (check first, second, and last)
-        $test1 = $db->query()->where('tags','IN','search')->first();
+        $test1 = $db->query()->where('tags','IN','display')->first();
         $test2 = $db->query()->where('tags','IN','network')->first();
+        $test3 = $db->query()->where('tags','IN','windows')->first();
+        $test4 = $db->query()->where('tags','IN','search')->results();
 
+        // testing the object return boolean argument
+        $test5 = $db->query()->where('tags','IN','search')->results(false);
+        $test6 = $db->query()->where('tags','IN','search')->results(true);
+
+        // make sure the results equal the right names
         $this->assertEquals('Google', $test1['name']);
         $this->assertEquals('Facebook', $test2['name']);
+        $this->assertEquals('Microsoft', $test3['name']);
+
+        // check if the method createdAt() exists or not based on the argument boolean
+        $this->assertEquals(true, method_exists($test5[0], 'createdAt'));
+        $this->assertEquals(false, method_exists($test6[0], 'createdAt'));
+
+        // check if the results = 2
+        $this->assertEquals(2, count($test4));
 
         // this will test the IN clause if name matches one of these
         $test3 = $db->query()->where('name','IN',['Google','Facebook'])->results();
@@ -508,6 +528,11 @@ public function testWithoutWhere()
 
         // test that they are ordered by name ASC (check first, second, and last)
         $test1 = $db->query()->orderBy('name', 'DESC')->first();
+        $test2 = $db->query()->orderBy('name', 'DESC')->first( false );
+        $test3 = $db->query()->orderBy('name', 'DESC')->first( true );
+
+        $this->assertEquals(true, method_exists($test2, 'createdAt'));
+        $this->assertEquals(false, method_exists($test3, 'createdAt'));
 
         $this->assertEquals('Yahoo', $test1['name']);
 
@@ -613,6 +638,41 @@ public function testingMissingQueryArguments()
     }
 
 
+
+    //--------------------------------------------------------------------
+
+
+    /**
+    * testUserNameQuery()
+    *
+    *
+    */
+    public function testUserNameQuery()
+    {
+        $db = new \Filebase\Database([
+            'dir' => __DIR__.'/databases/users_names',
+            'cache' => false
+        ]);
+
+        $db->flush(true);
+
+        for ($x = 1; $x <= 10; $x++)
+    	{
+    		$user = $db->get(uniqid());
+    		$user->name = 'John '.$x;
+            $user->contact['email'] = 'john@john.com';
+    		$user->save();
+    	}
+
+        $userAccount = $db->query()->orderBy('name', 'DESC')->first();
+
+        $this->assertEquals('John 10', $userAccount['name']);
+
+        $db->flush(true);
+    }
+
+
+
     //--------------------------------------------------------------------