Integer::$value is now a string, Literal::literal accepts objects, rename ExclusiveOr->ExclusiveDisjunction

Author: Wout Gevaert

src/Expressions/Literals/Integer.php

@@ -11,6 +11,7 @@
 
 use WikibaseSolutions\CypherDSL\Traits\TypeTraits\PropertyTypeTraits\IntegerTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\IntegerType;
+use TypeError;
 
 /**
  * Represents an integer literal.
@@ -20,25 +21,34 @@ final class Integer implements IntegerType
     use IntegerTypeTrait;
 
     /**
-     * @var int The value
+     * @var string The value
      */
-    private int $value;
+    private string $value;
 
     /**
-     * @param int $value The value
+     * @param int|string $value The value
      * @internal This function is not covered by the backwards compatibility guarantee of php-cypher-dsl
      */
-    public function __construct(int $value)
+    public function __construct($value)
     {
-        $this->value = $value;
+        if (!is_int($value) && !is_string($value)) {
+            throw new TypeError('An integer should be given as a string or integer, '.gettype($value).' received.');
+        }
+        $this->value = filter_var($value, FILTER_SANITIZE_NUMBER_INT);
+
+        if (is_string($value) && $this->value !== $value) {
+           throw new TypeError(
+               'A non-integer string has been provided: "'.$value.'", should be something like "'.$this->value.'".'
+           );
+        }
     }
 
     /**
-     * Returns the integer value.
+     * Returns a string representation of the integer value.
      *
-     * @return int
+     * @return string
      */
-    public function getValue(): int
+    public function getValue(): string
     {
         return $this->value;
     }
@@ -48,6 +58,6 @@ public function getValue(): int
      */
     public function toQuery(): string
     {
-        return (string)$this->value;
+        return $this->value;
     }
 }

src/Expressions/Literals/Literal.php

@@ -69,8 +69,12 @@ public static function literal($literal)
             return array_is_list($literal) ? self::list($literal) : self::map($literal);
         }
 
+        if (is_object($literal) && method_exists($literal, '__toString')) {
+            return self::string($literal->__toString());
+        }
+
         throw new InvalidArgumentException(
-            "The literal type " . is_object($literal) ? get_class($literal) : gettype($literal) . " is not supported by Cypher"
+            "The literal type " . get_debug_type($literal) . " is not supported by Cypher"
         );
     }
 
@@ -153,8 +157,11 @@ public static function float(float $value): Float_
      * @param array $value
      * @return List_
      */
-    public static function list(array $value): List_
+    public static function list(iterable $value): List_
     {
+        if (is_object($value)) {
+            $value = iterator_to_array($value);
+        }
         return new List_(array_map([self::class, 'toAnyType'], $value));
     }
 

src/Expressions/Literals/Map.php

@@ -43,7 +43,7 @@ final class Map implements MapType
      */
     public function __construct(array $elements = [])
     {
-        self::assertClassArray('properties', AnyType::class, $elements);
+        self::assertClassArray('elements', AnyType::class, $elements);
         $this->elements = $elements;
     }
 

src/Expressions/Operators/ExclusiveDisjunction.php

@@ -10,12 +10,12 @@
 namespace WikibaseSolutions\CypherDSL\Expressions\Operators;
 
 /**
- * Represents the application of the exclusive or (XOR) operator.
+ * Represents the application of the exclusive disjunction (XOR) operator.
  *
  * @see https://s3.amazonaws.com/artifacts.opencypher.org/openCypher9.pdf (page 50)
  * @see https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean
  */
-final class ExclusiveOr extends BooleanBinaryOperator
+final class ExclusiveDisjunction extends BooleanBinaryOperator
 {
     /**
      * @inheritDoc

src/Expressions/Operators/ModuloDivision.php

@@ -11,6 +11,7 @@
 
 /**
  * Represents the application of the modulo division (%) operator.
+ * This operator is sometimes simply called "modulo operator".
  *
  * @see https://s3.amazonaws.com/artifacts.opencypher.org/openCypher9.pdf (page 48)
  * @see https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical

src/Patterns/Relationship.php

@@ -301,7 +301,7 @@ private function relationshipDetailToString(): string
 
         if (isset($this->properties)) {
             // Only add the properties if they're not empty
-            if (!$this->properties instanceof Map || $this->properties->getProperties() !== []) {
+            if (!$this->properties instanceof Map || $this->properties->getElements() !== []) {
                 $map = $this->properties->toQuery();
 
                 if ($conditionInner !== "") {

src/Query.php

@@ -257,7 +257,7 @@ public static function float(float $value): Float_
      * @param array $value
      * @return List_
      */
-    public static function list(array $value): List_
+    public static function list(iterable $value): List_
     {
         return self::literal()::list($value);
     }
@@ -437,9 +437,9 @@ public function returning($expressions, bool $distinct = false): self
 
         $expressions = array_map(function ($expression): AnyType {
             // If it has a variable, we want to put the variable in the RETURN clause instead of the
-            // object itself. Theoretically, a node could be returned directly, but this is extremely
-            // rare. If a user wants to do this, they can use the ReturnClause class directly.
-            return $expression instanceof HasVariable ? $expression->getVariable() : $expression;
+            // object itself. Theoretically, a node could be returned directly (i.e. "RETURN (n)"),
+            // but this is extremely rare. If a user wants to do this, they can use the ReturnClause class directly.
+            return $expression instanceof Pattern ? $expression->getVariable() : $expression;
         }, $expressions);
 
         $returnClause->setColumns($expressions);
@@ -501,7 +501,7 @@ public function delete($structures, bool $detach = false): self
     /**
      * Creates the DETACH DELETE clause.
      *
-     * @param string|Variable|HasVariable|(string|Variable|HasVariable)[] $variables The variables to delete, including relationships
+     * @param string|Variable|Pattern|(string|Variable|Pattern)[] $variables The variables to delete, including nodes, relationships and paths
      *
      * @return $this
      * @see https://neo4j.com/docs/cypher-manual/current/clauses/delete/
@@ -724,9 +724,9 @@ public function with($expressions): self
         }
 
         foreach ($expressions as $maybeAlias => $expression) {
-            $this->assertClass('expression', AnyType::class, $expression);
+            $this->assertClass('expression', [AnyType::class, Pattern::class], $expression);
 
-            if ($expression instanceof Node) {
+            if ($expression instanceof Pattern) {
                 $expression = $expression->getVariable();
             }
 

src/Traits/EscapeTrait.php

@@ -46,8 +46,8 @@ trait EscapeTrait
     private static function escape(string $name): string
     {
         if ($name === "") {
-            // Although some versions of Neo4j do not crash when the empty string is used as a name, there is no real
-            // reason to ever use the empty string as a name
+            // Although some versions of Neo4j do not crash when the empty string is used as a name,
+            // there is no real reason to ever use the empty string as a name
             throw new InvalidArgumentException("A name cannot be the empty string");
         }
 

src/Traits/TypeTraits/PropertyTypeTraits/BooleanTypeTrait.php

@@ -23,7 +23,7 @@
 
 use WikibaseSolutions\CypherDSL\Expressions\Operators\Conjunction;
 use WikibaseSolutions\CypherDSL\Expressions\Operators\Disjunction;
-use WikibaseSolutions\CypherDSL\Expressions\Operators\ExclusiveOr;
+use WikibaseSolutions\CypherDSL\Expressions\Operators\ExclusiveDisjunction;
 use WikibaseSolutions\CypherDSL\Expressions\Operators\Negation;
 use WikibaseSolutions\CypherDSL\Traits\CastTrait;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
@@ -57,9 +57,9 @@ public function or($right, bool $insertParentheses = true): Disjunction
     /**
      * @inheritDoc
      */
-    public function xor($right, bool $insertParentheses = true): ExclusiveOr
+    public function xor($right, bool $insertParentheses = true): ExclusiveDisjunction
     {
-        return new ExclusiveOr($this, self::toBooleanType($right), $insertParentheses);
+        return new ExclusiveDisjunction($this, self::toBooleanType($right), $insertParentheses);
     }
 
     /**

src/Types/PropertyTypes/BooleanType.php

@@ -23,7 +23,7 @@
 
 use WikibaseSolutions\CypherDSL\Expressions\Operators\Conjunction;
 use WikibaseSolutions\CypherDSL\Expressions\Operators\Disjunction;
-use WikibaseSolutions\CypherDSL\Expressions\Operators\ExclusiveOr;
+use WikibaseSolutions\CypherDSL\Expressions\Operators\ExclusiveDisjunction;
 use WikibaseSolutions\CypherDSL\Expressions\Operators\Negation;
 use WikibaseSolutions\CypherDSL\Traits\TypeTraits\PropertyTypeTraits\BooleanTypeTrait;
 
@@ -57,9 +57,9 @@ public function or($right, bool $insertParentheses = true): Disjunction;
      *
      * @param BooleanType|bool $right
      * @param bool $insertParentheses
-     * @return ExclusiveOr
+     * @return ExclusiveDisjunction
      */
-    public function xor($right, bool $insertParentheses = true): ExclusiveOr;
+    public function xor($right, bool $insertParentheses = true): ExclusiveDisjunction;
 
     /**
      * Negate this expression (using the NOT operator).