summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/orm/src/Contract/RewritePathBehavior.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ipl/orm/src/Contract/RewritePathBehavior.php')
-rw-r--r--vendor/ipl/orm/src/Contract/RewritePathBehavior.php20
1 files changed, 20 insertions, 0 deletions
diff --git a/vendor/ipl/orm/src/Contract/RewritePathBehavior.php b/vendor/ipl/orm/src/Contract/RewritePathBehavior.php
new file mode 100644
index 0000000..b5b0385
--- /dev/null
+++ b/vendor/ipl/orm/src/Contract/RewritePathBehavior.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace ipl\Orm\Contract;
+
+use ipl\Orm\Behavior;
+
+interface RewritePathBehavior extends Behavior
+{
+ /**
+ * Rewrite the given relation path
+ *
+ * The result must be returned otherwise (NULL is returned) the original path is kept as is.
+ *
+ * @param string $path
+ * @param ?string $relation The absolute path of the model. For reference only, don't include it in the result
+ *
+ * @return ?string
+ */
+ public function rewritePath(string $path, ?string $relation = null): ?string;
+}