summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php')
-rw-r--r--vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php39
1 files changed, 39 insertions, 0 deletions
diff --git a/vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php b/vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php
new file mode 100644
index 0000000..b6f545b
--- /dev/null
+++ b/vendor/ipl/orm/src/Contract/RewriteColumnBehavior.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace ipl\Orm\Contract;
+
+use ipl\Orm\ColumnDefinition;
+
+interface RewriteColumnBehavior extends RewriteFilterBehavior
+{
+ /**
+ * Rewrite the given column
+ *
+ * The result must be returned otherwise (NULL is returned) the original column is kept as is.
+ *
+ * @param mixed $column
+ * @param ?string $relation The absolute path of the model. For reference only, don't include it in the result
+ *
+ * @return mixed
+ */
+ public function rewriteColumn($column, ?string $relation = null);
+
+ /**
+ * Get whether {@see rewriteColumn} might return an otherwise unknown column or expression
+ *
+ * @param string $name
+ *
+ * @return bool
+ */
+ public function isSelectableColumn(string $name): bool;
+
+ /**
+ * Rewrite the given column definition
+ *
+ * @param ColumnDefinition $def
+ * @param string $relation The absolute path of the model. For reference only, don't include it in the result
+ *
+ * @return void
+ */
+ public function rewriteColumnDefinition(ColumnDefinition $def, string $relation): void;
+}