Added RepresentationCollectionFinderProviderInterface

src/grid/RepresentationCollectionFinder.php

@@ -22,7 +22,7 @@
  *
  * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
  */
-class RepresentationCollectionFinder
+class RepresentationCollectionFinder implements RepresentationCollectionFinderInterface
 {
     private $module;
     private $controller;
@@ -86,10 +86,14 @@ public function findOrFail()
         return $collection;
     }
 
-    public static function forCurrentRoute(string $representationsLocation)
+    public static function forCurrentRoute(string $representationsLocation): RepresentationCollectionFinderInterface
     {
         $controller = Yii::$app->controller;
 
+        if ($controller->module instanceof RepresentationCollectionFinderProviderInterface) {
+            return $controller->module->getRepresentationCollectionFinder();
+        }
+
         $module = $controller->module->id;
         $controller = Inflector::id2camel($controller->id);
 

src/grid/RepresentationCollectionFinderInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace hipanel\grid;
+
+use hiqdev\higrid\representations\RepresentationCollection;
+use hiqdev\higrid\representations\RepresentationCollectionInterface;
+use yii\base\InvalidConfigException;
+
+/**
+ * Interface RepresentationCollectionFinderInterface provides an API to find
+ * representation collections in conformance to the current HTTP request
+ *
+ * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
+ */
+interface RepresentationCollectionFinderInterface
+{
+    /**
+     * @return RepresentationCollectionInterface|RepresentationCollection
+     */
+    public function find();
+
+    /**
+     * @throws InvalidConfigException When collection does not exist for the route
+     * @return RepresentationCollection|RepresentationCollectionInterface
+     */
+    public function findOrFail();
+
+    /**
+     * @return RepresentationCollectionInterface|RepresentationCollection
+     */
+    public function findOrFallback();
+}

src/grid/RepresentationCollectionFinderProviderInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace hipanel\grid;
+
+interface RepresentationCollectionFinderProviderInterface
+{
+    public function getRepresentationCollectionFinder(): RepresentationCollectionFinderInterface;
+}