summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/orm/src/Behavior
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--vendor/ipl/orm/src/Behavior.php12
-rw-r--r--vendor/ipl/orm/src/Behavior/Binary.php116
-rw-r--r--vendor/ipl/orm/src/Behaviors.php238
3 files changed, 366 insertions, 0 deletions
diff --git a/vendor/ipl/orm/src/Behavior.php b/vendor/ipl/orm/src/Behavior.php
new file mode 100644
index 0000000..45b5e87
--- /dev/null
+++ b/vendor/ipl/orm/src/Behavior.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace ipl\Orm;
+
+/**
+ * Interface Behavior
+ *
+ * @internal Used for type hinting only. Concrete behaviors are supposed to implement contracts from ipl\Orm\Contract
+ */
+interface Behavior
+{
+}
diff --git a/vendor/ipl/orm/src/Behavior/Binary.php b/vendor/ipl/orm/src/Behavior/Binary.php
new file mode 100644
index 0000000..98a4bf4
--- /dev/null
+++ b/vendor/ipl/orm/src/Behavior/Binary.php
@@ -0,0 +1,116 @@
+<?php
+
+namespace ipl\Orm\Behavior;
+
+use ipl\Orm\Contract\PropertyBehavior;
+use ipl\Orm\Contract\QueryAwareBehavior;
+use ipl\Orm\Contract\RewriteFilterBehavior;
+use ipl\Orm\Query;
+use ipl\Sql\Adapter\Pgsql;
+use ipl\Stdlib\Filter\Condition;
+use UnexpectedValueException;
+
+use function ipl\Stdlib\get_php_type;
+
+/**
+ * Support hex filters for binary columns and PHP resource (in) / bytea hex format (out) transformation for PostgreSQL
+ */
+class Binary extends PropertyBehavior implements QueryAwareBehavior, RewriteFilterBehavior
+{
+ /**
+ * Properties for {@see rewriteCondition()} to support hex filters for each adapter
+ *
+ * Set in {@see setQuery()} from the {@see $properties} array because the latter is reset for adapters other than
+ * {@see Pgsql}, so {@see fromDb()} and {@see toDb()} don't run for them.
+ *
+ * @var array
+ */
+ protected $rewriteSubjects;
+
+ public function fromDb($value, $key, $_)
+ {
+ if ($value !== null) {
+ if (is_resource($value)) {
+ return stream_get_contents($value);
+ }
+
+ return $value;
+ }
+
+ return null;
+ }
+
+ /**
+ * @throws UnexpectedValueException If value is a resource
+ */
+ public function toDb($value, $key, $_)
+ {
+ if (is_resource($value)) {
+ throw new UnexpectedValueException(sprintf('Unexpected resource for %s', $key));
+ }
+
+ if ($value === '*') {
+ /**
+ * Support IS (NOT) NULL filter transformation.
+ * {@see \ipl\Sql\Compat\FilterProcessor::assemblePredicate()}
+ */
+ return $value;
+ }
+
+ /**
+ * TODO(lippserd): If the filter is moved to a subquery, the value has already been processed.
+ * This is because our filter processor is unfortunately doing the transformation twice at the moment:
+ *
+ * {@link https://github.com/Icinga/ipl-orm/issues/48}
+ *
+ * {@see \ipl\Orm\Compat\FilterProcessor::requireAndResolveFilterColumns()}
+ */
+ if (substr($value, 0, 2) === '\\x') {
+ return $value;
+ }
+
+ return sprintf('\\x%s', bin2hex($value));
+ }
+
+ public function setQuery(Query $query)
+ {
+ $this->rewriteSubjects = $this->properties;
+
+ if (! $query->getDb()->getAdapter() instanceof Pgsql) {
+ // Only process properties if the adapter is PostgreSQL.
+ $this->properties = [];
+ }
+ }
+
+ public function rewriteCondition(Condition $condition, $relation = null)
+ {
+ /**
+ * TODO(lippserd): Duplicate code because {@see RewriteFilterBehavior}s come after {@see PropertyBehavior}s.
+ * {@see \ipl\Orm\Compat\FilterProcessor::requireAndResolveFilterColumns()}
+ */
+ $column = $condition->metaData()->get('columnName');
+ if (isset($this->rewriteSubjects[$column])) {
+ $value = $condition->getValue();
+
+ if (empty($this->properties) && is_resource($value)) {
+ // Only for PostgreSQL.
+ throw new UnexpectedValueException(sprintf('Unexpected resource for %s', $column));
+ }
+
+ // ctype_xdigit expects strings.
+ $value = (string) $value;
+ /**
+ * Although this code path is also affected by the duplicate behavior evaluation stated in {@see toDb()},
+ * no further adjustments are needed as ctype_xdigit returns false for binary and bytea hex strings.
+ */
+ if (ctype_xdigit($value)) {
+ if (empty($this->properties) && substr($value, 0, 2) !== '\\x') {
+ // Only for PostgreSQL.
+ $condition->setValue(sprintf('\\x%s', $value));
+ } else {
+ $condition->setValue(hex2bin($value));
+ }
+ }
+ }
+ }
+}
diff --git a/vendor/ipl/orm/src/Behaviors.php b/vendor/ipl/orm/src/Behaviors.php
new file mode 100644
index 0000000..5c54350
--- /dev/null
+++ b/vendor/ipl/orm/src/Behaviors.php
@@ -0,0 +1,238 @@
+<?php
+
+namespace ipl\Orm;
+
+use ArrayIterator;
+use ipl\Orm\Contract\PersistBehavior;
+use ipl\Orm\Contract\PropertyBehavior;
+use ipl\Orm\Contract\RetrieveBehavior;
+use ipl\Orm\Contract\RewriteColumnBehavior;
+use ipl\Orm\Contract\RewriteFilterBehavior;
+use ipl\Orm\Contract\RewritePathBehavior;
+use ipl\Stdlib\Filter;
+use IteratorAggregate;
+use Traversable;
+
+class Behaviors implements IteratorAggregate
+{
+ /** @var array Registered behaviors */
+ protected $behaviors = [];
+
+ /** @var RetrieveBehavior[] Registered retrieve behaviors */
+ protected $retrieveBehaviors = [];
+
+ /** @var PersistBehavior[] Registered persist behaviors */
+ protected $persistBehaviors = [];
+
+ /** @var PropertyBehavior[] Registered property behaviors */
+ protected $propertyBehaviors = [];
+
+ /** @var RewriteFilterBehavior[] Registered rewrite filter behaviors */
+ protected $rewriteFilterBehaviors = [];
+
+ /** @var RewriteColumnBehavior[] Registered rewrite column behaviors */
+ protected $rewriteColumnBehaviors = [];
+
+ /** @var RewritePathBehavior[] Registered rewrite path behaviors */
+ protected $rewritePathBehaviors = [];
+
+ /**
+ * Add a behavior
+ *
+ * @param PersistBehavior|PropertyBehavior|RetrieveBehavior|RewriteFilterBehavior $behavior
+ */
+ public function add(Behavior $behavior)
+ {
+ $this->behaviors[] = $behavior;
+
+ if ($behavior instanceof PropertyBehavior) {
+ $this->retrieveBehaviors[] = $behavior;
+ $this->persistBehaviors[] = $behavior;
+ $this->propertyBehaviors[] = $behavior;
+ } else {
+ if ($behavior instanceof RetrieveBehavior) {
+ $this->retrieveBehaviors[] = $behavior;
+ }
+
+ if ($behavior instanceof PersistBehavior) {
+ $this->persistBehaviors[] = $behavior;
+ }
+ }
+
+ if ($behavior instanceof RewriteFilterBehavior) {
+ $this->rewriteFilterBehaviors[] = $behavior;
+ }
+
+ if ($behavior instanceof RewriteColumnBehavior) {
+ $this->rewriteColumnBehaviors[] = $behavior;
+ }
+
+ if ($behavior instanceof RewritePathBehavior) {
+ $this->rewritePathBehaviors[] = $behavior;
+ }
+ }
+
+ /**
+ * Iterate registered behaviors
+ *
+ * @return ArrayIterator
+ */
+ public function getIterator(): Traversable
+ {
+ return new ArrayIterator($this->behaviors);
+ }
+
+ /**
+ * Apply all retrieve behaviors on the given model
+ *
+ * @param Model $model
+ */
+ public function retrieve(Model $model)
+ {
+ foreach ($this->retrieveBehaviors as $behavior) {
+ $behavior->retrieve($model);
+ }
+ }
+
+ /**
+ * Apply all persist behaviors on the given model
+ *
+ * @param Model $model
+ */
+ public function persist(Model $model)
+ {
+ foreach ($this->persistBehaviors as $behavior) {
+ $behavior->persist($model);
+ }
+ }
+
+ /**
+ * Transform the retrieved key's value by use of all property behaviors
+ *
+ * @param mixed $value
+ * @param string $key
+ *
+ * @return mixed
+ */
+ public function retrieveProperty($value, $key)
+ {
+ foreach ($this->propertyBehaviors as $behavior) {
+ $value = $behavior->retrieveProperty($value, $key);
+ }
+
+ return $value;
+ }
+
+ /**
+ * Transform the to be persisted key's value by use of all property behaviors
+ *
+ * @param mixed $value
+ * @param string $key
+ *
+ * @return mixed
+ */
+ public function persistProperty($value, $key)
+ {
+ foreach ($this->propertyBehaviors as $behavior) {
+ $value = $behavior->persistProperty($value, $key);
+ }
+
+ return $value;
+ }
+
+ /**
+ * Rewrite the given filter condition
+ *
+ * @param Filter\Condition $condition
+ * @param string $relation Absolute path (with a trailing dot) of the model
+ *
+ * @return Filter\Rule|null
+ */
+ public function rewriteCondition(Filter\Condition $condition, $relation = null)
+ {
+ $filter = null;
+ foreach ($this->rewriteFilterBehaviors as $behavior) {
+ $replacement = $behavior->rewriteCondition($filter ?: $condition, $relation);
+ if ($replacement !== null) {
+ $filter = $replacement;
+ }
+ }
+
+ return $filter;
+ }
+
+ /**
+ * Rewrite the given relation path
+ *
+ * @param string $path
+ * @param string $relation Absolute path of the model
+ *
+ * @return string|null
+ */
+ public function rewritePath($path, $relation = null)
+ {
+ $newPath = null;
+ foreach ($this->rewritePathBehaviors as $behavior) {
+ $replacement = $behavior->rewritePath($newPath ?: $path, $relation);
+ if ($replacement !== null) {
+ $newPath = $replacement;
+ }
+ }
+
+ return $newPath;
+ }
+
+ /**
+ * Rewrite the given column
+ *
+ * @param string $column
+ * @param string $relation Absolute path of the model
+ *
+ * @return mixed
+ */
+ public function rewriteColumn($column, $relation = null)
+ {
+ $newColumn = null;
+ foreach ($this->rewriteColumnBehaviors as $behavior) {
+ $replacement = $behavior->rewriteColumn($newColumn ?: $column, $relation);
+ if ($replacement !== null) {
+ $newColumn = $replacement;
+ }
+ }
+
+ return $newColumn;
+ }
+
+ /**
+ * Rewrite the given column definition
+ *
+ * @param ColumnDefinition $def
+ * @param string $relation Absolute path of the model
+ *
+ * @return void
+ */
+ public function rewriteColumnDefinition(ColumnDefinition $def, string $relation): void
+ {
+ foreach ($this->rewriteColumnBehaviors as $behavior) {
+ $behavior->rewriteColumnDefinition($def, $relation);
+ }
+ }
+
+ /**
+ * Get whether the given column is selectable
+ *
+ * @param string $column
+ *
+ * @return bool
+ */
+ public function isSelectableColumn(string $column): bool
+ {
+ foreach ($this->rewriteColumnBehaviors as $behavior) {
+ if ($behavior->isSelectableColumn($column)) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+}