Params name free transformation

README.md

@@ -260,6 +260,22 @@ This way, when you do a *'refresh'*, you can fetch more results than if you are
 
 To configure that, set `$perPage = [15, 5]`. That way it'll fetch 15 when you do a `previous_cursor`, and 5 when you do a normal fetch or a `next_cursor`. 
 
+## Customizing param names
+
+On the config, change `identifier_name` to change the word `cursor`. Examples: `cursor`, `id`, `pointer`, etc. 
+
+Change `navigation_names` to change the words `['previous', 'next']`.
+Examples:  `['before', 'after']` , `['min', 'max']`
+
+##### Transforming the result:
+Edit `transform_name` to format the string differently:
+
+- For `previousCursor` use 'camel_case'
+- For `previous-cursor` use 'kebab_case'.
+- For `previous_cursor` use 'snake_case'.
+
+Using `null` defaults to camelCase.
+
 ## API Docs
 
 ### Paginator custom options

config/cursor_pagination.php

@@ -39,12 +39,13 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Camel Case Names
+    | Transform Name
     |--------------------------------------------------------------------------
     |
-    | Use camel case instead of snake case.
+    | Specify a global function to be called to format the original snake_case.
+    | Can use Laravel's Helper functions.
     |
-    | Examples: previousCursor (camel) instead of previous_cursor (snake)
+    | Examples: 'camel_case', 'kebab_case', 'snake_case'.
     */
-    'camel_case'       => false,
+    'transform_name'   => 'snake_case',
 ];

src/CursorPaginator.php

@@ -114,35 +114,41 @@ public static function resolveCurrentCursor(Request $request = null)
     public static function cursorQueryNames()
     {
         $ident = config('cursor_pagination.identifier_name');
+        $ident = ucfirst($ident);
         list($prev, $next) = config('cursor_pagination.navigation_names');
 
         return [
-            self::formatNames("{$prev}_$ident"),
-            self::formatNames("{$next}_$ident"),
+            self::formatNames("{$prev}$ident"),
+            self::formatNames("{$next}$ident"),
         ];
     }
 
     /**
-     * @return array
+     * @param string $name
+     *
+     * @return string
      */
-    public function getCursorQueryNames()
+    protected static function formatNames($name)
     {
-        if (is_null($this->cursor_queue_names)) {
-            $this->cursor_queue_names = static::cursorQueryNames();
+        $transform_name = config('cursor_pagination.transform_name', null);
+
+        if (!is_null($transform_name)) {
+            return call_user_func($transform_name, $name);
         }
 
-        return $this->cursor_queue_names;
+        return $name;
     }
 
-    protected static function formatNames($name)
+    /**
+     * @return array
+     */
+    public function getCursorQueryNames()
     {
-        $camel_case = config('cursor_pagination.camel_case', false);
-
-        if ($camel_case) {
-            return camel_case($name);
+        if (is_null($this->cursor_queue_names)) {
+            $this->cursor_queue_names = static::cursorQueryNames();
         }
 
-        return $name;
+        return $this->cursor_queue_names;
     }
 
     public function nextCursor()

tests/CursorNameTest.php

@@ -8,18 +8,24 @@ class CursorNameTest extends TestCase
 {
     public function test_camel_case()
     {
-        config(['cursor_pagination.camel_case' => false]);
+        config(['cursor_pagination.transform_name' => 'snake_case']);
         list($prev_name, $next_name) = CursorPaginator::cursorQueryNames();
 
         $this->assertContains('_', $prev_name);
         $this->assertContains('_', $next_name);
 
-        config(['cursor_pagination.camel_case' => true]);
+        config(['cursor_pagination.transform_name' => 'camel_case']);
         list($prev_name, $next_name) = CursorPaginator::cursorQueryNames();
 
         $this->assertNotContains('_', $prev_name);
         $this->assertNotContains('_', $next_name);
 
-        config(['cursor_pagination.camel_case' => false]);
+        config(['cursor_pagination.transform_name' => 'kebab_case']);
+        list($prev_name, $next_name) = CursorPaginator::cursorQueryNames();
+
+        $this->assertContains('-', $prev_name);
+        $this->assertContains('-', $next_name);
+
+        config(['cursor_pagination.transform_name' => null]);
     }
 }

tests/Fixtures/config/simple.php

@@ -11,7 +11,7 @@
     | of the array will be results per page when it's fetching previous, and
     | the second one is for next and normal fetches.
     */
-    'per_page'  => 5,
+    'per_page'         => 5,
     /*
     |--------------------------------------------------------------------------
     | Identifier name
@@ -38,13 +38,14 @@
     'navigation_names' => ['previous', 'next'],
 
     /*
-    |--------------------------------------------------------------------------
-    | Camel Case Names
-    |--------------------------------------------------------------------------
-    |
-    | Use camel case instead of snake case.
-    |
-    | Examples: previousCursor (camel) instead of previous_cursor (snake)
-    */
-    'camel_case'       => false,
+   |--------------------------------------------------------------------------
+   | Transform Name
+   |--------------------------------------------------------------------------
+   |
+   | Specify a global function to be called to format the original snake_case.
+   | Can use Laravel's Helper functions.
+   |
+   | Examples: 'camel_case', 'kebab_case', 'snake_case'.
+   */
+    'transform_name'   => 'snake_case',
 ];