[Bugfix] Nest page meta by default

lindyhopchris · lindyhopchris · commit 07e6930bc0d3 · 2017-05-19T15:41:08.000+01:00
This matches the previous version of this package, that always
nested the page meta. By adding this back in, the upgrade path
is better. The improvement here is nesting can be turned off if
required.

Nesting the meta is a better default anyway because it avoids
collisions with other meta keys that are being included in the
document's top-level meta key.
diff --git a/UPGRADE-0.8.md b/UPGRADE-0.8.md
@@ -311,7 +311,7 @@ class Adapter extends EloquentAdapter
 {
   public function __construct(StandardStrategy $paging)
   {
-    $paging->withMetaKey('page')->withUnderscoredMetaKeys();
+    $paging->withPerPageKey('limit')->withUnderscoredMetaKeys();
     parent::__construct(new Post(), $paging);
   }
 }
diff --git a/src/Pagination/StandardStrategy.php b/src/Pagination/StandardStrategy.php
@@ -85,6 +85,7 @@ public function __construct(FactoryInterface $factory, LinkFactoryInterface $lin
     {
         $this->factory = $factory;
         $this->linkFactory = $linkFactory;
+        $this->metaKey = QueryParametersParserInterface::PARAM_PAGE;
     }
 
     /**
@@ -98,6 +99,17 @@ public function withPageKey($key)
         return $this;
     }
 
+    /**
+     * @param $key
+     * @return $this
+     */
+    public function withPerPageKey($key)
+    {
+        $this->perPageKey = $key;
+
+        return $this;
+    }
+
     /**
      * @param $cols
      * @return $this;
@@ -132,15 +144,15 @@ public function withUnderscoredMetaKeys()
     /**
      * Set the key for the paging meta.
      *
-     * Use this if you need to 'nest' the paging meta in a sub-key of the JSON API
-     * document's top-level meta object.
+     * Use this to 'nest' the paging meta in a sub-key of the JSON API document's top-level meta object.
+     * A string sets the key to use for nesting. Use `null` to indicate no nesting.
      *
-     * @param $key
+     * @param string|null $key
      * @return $this
      */
     public function withMetaKey($key)
     {
-        $this->metaKey = $key;
+        $this->metaKey = $key ?: null;
 
         return $this;
     }
@@ -170,7 +182,7 @@ protected function getPageKey()
      */
     protected function getPerPage(Collection $collection)
     {
-        return $collection->get($this->getPerPageKey());
+        return (int) $collection->get($this->getPerPageKey());
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ class Adapter extends EloquentAdapter`
`311`	`311`	`{`
`312`	`312`	`public function __construct(StandardStrategy $paging)`
`313`	`313`	`{`
`314`		`- $paging->withMetaKey('page')->withUnderscoredMetaKeys();`
	`314`	`+ $paging->withPerPageKey('limit')->withUnderscoredMetaKeys();`
`315`	`315`	`parent::__construct(new Post(), $paging);`
`316`	`316`	`}`
`317`	`317`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ public function __construct(FactoryInterface $factory, LinkFactoryInterface $lin`
`85`	`85`	`{`
`86`	`86`	`$this->factory = $factory;`
`87`	`87`	`$this->linkFactory = $linkFactory;`
	`88`	`+ $this->metaKey = QueryParametersParserInterface::PARAM_PAGE;`
`88`	`89`	`}`
`89`	`90`
`90`	`91`	`/**`
`@@ -98,6 +99,17 @@ public function withPageKey($key)`
`98`	`99`	`return $this;`
`99`	`100`	`}`
`100`	`101`
	`102`	`+ /**`
	`103`	`+ * @param $key`
	`104`	`+ * @return $this`
	`105`	`+ */`
	`106`	`+ public function withPerPageKey($key)`
	`107`	`+ {`
	`108`	`+ $this->perPageKey = $key;`
	`109`	`+`
	`110`	`+ return $this;`
	`111`	`+ }`
	`112`	`+`
`101`	`113`	`/**`
`102`	`114`	`* @param $cols`
`103`	`115`	`* @return $this;`
`@@ -132,15 +144,15 @@ public function withUnderscoredMetaKeys()`
`132`	`144`	`/**`
`133`	`145`	`* Set the key for the paging meta.`
`134`	`146`	`*`
`135`		`- * Use this if you need to 'nest' the paging meta in a sub-key of the JSON API`
`136`		`- * document's top-level meta object.`
	`147`	`+ * Use this to 'nest' the paging meta in a sub-key of the JSON API document's top-level meta object.`
	`148`	+ * A string sets the key to use for nesting. Use `null` to indicate no nesting.
`137`	`149`	`*`
`138`		`- * @param $key`
	`150`	`+ * @param string\|null $key`
`139`	`151`	`* @return $this`
`140`	`152`	`*/`
`141`	`153`	`public function withMetaKey($key)`
`142`	`154`	`{`
`143`		`- $this->metaKey = $key;`
	`155`	`+ $this->metaKey = $key ?: null;`
`144`	`156`
`145`	`157`	`return $this;`
`146`	`158`	`}`
`@@ -170,7 +182,7 @@ protected function getPageKey()`
`170`	`182`	`*/`
`171`	`183`	`protected function getPerPage(Collection $collection)`
`172`	`184`	`{`
`173`		`- return $collection->get($this->getPerPageKey());`
	`185`	`+ return (int) $collection->get($this->getPerPageKey());`
`174`	`186`	`}`
`175`	`187`
`176`	`188`	`/**`