Merge pull request #37 from transistive/name-generation

WIP: Big PR adding a lot of stuff to improve quality of life

Author: marijnvanwezel

src/Alias.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace WikibaseSolutions\CypherDSL;
+
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use function sprintf;
+
+/**
+ * Represents aliasing an expression or variable.
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/clauses/return/#return-column-alias
+ * @see https://neo4j.com/docs/cypher-manual/current/clauses/with/#with-introduce-variables
+ */
+class Alias implements AnyType
+{
+    /**
+     * @var AnyType The original item to be aliased
+     */
+    private AnyType $original;
+
+    /**
+     * @var Variable The new variable aliasing the original
+     */
+    private Variable $variable;
+
+    /**
+     * Alias constructor.
+     *
+     * @param AnyType $original The original item to be aliased
+     * @param Variable $variable The new variable aliasing the original
+     */
+    public function __construct(AnyType $original, Variable $variable)
+    {
+        $this->original = $original;
+        $this->variable = $variable;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toQuery(): string
+    {
+        return sprintf("%s AS %s", $this->original->toQuery(), $this->variable->toQuery());
+    }
+
+    /**
+     * Gets the original item of the alias.
+     *
+     * @return AnyType
+     */
+    public function getOriginal(): AnyType
+    {
+        return $this->original;
+    }
+
+    /**
+     * Gets the variable from the alias.
+     *
+     * @return Variable
+     */
+    public function getVariable(): Variable
+    {
+        return $this->variable;
+    }
+}

src/Assignment.php

@@ -46,7 +46,7 @@ class Assignment extends BinaryOperator
      */
     public function __construct(AnyType $left, AnyType $right)
     {
-        $this->assertClass('left', [Property::class, Variable::class], $left);
+        self::assertClass('left', [Property::class, Variable::class], $left);
 
         parent::__construct($left, $right, false);
     }

src/BinaryOperator.php

@@ -21,17 +21,20 @@
 
 namespace WikibaseSolutions\CypherDSL;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 
 /**
  * This class represents the application of a binary operator, such as "+", "/" and "*".
  */
 abstract class BinaryOperator implements QueryConvertable
 {
+    use AliasableTrait;
+
     /**
      * @var bool Whether to insert parentheses around the expression
      */
-    private bool $insertParentheses = true;
+    private bool $insertParentheses;
 
     /**
      * @var AnyType The left-hand of the expression

src/Clauses/CreateClause.php

@@ -21,7 +21,6 @@
 
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
-use WikibaseSolutions\CypherDSL\Assignment;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\StructuralType;
 
@@ -35,20 +34,18 @@ class CreateClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var StructuralType[]|Assignment[] The patterns to create
+     * @var StructuralType[] The patterns to create
      */
     private array $patterns = [];
 
     /**
      * Add a pattern to create.
      *
-     * @param StructuralType|Assignment $pattern The pattern to create
+     * @param StructuralType $pattern The pattern to create
      * @return CreateClause
      */
-    public function addPattern($pattern): self
+    public function addPattern(StructuralType $pattern): self
     {
-        $this->assertClass('pattern', [StructuralType::class, Assignment::class], $pattern);
-
         $this->patterns[] = $pattern;
 
         return $this;

src/Clauses/MatchClause.php

@@ -21,7 +21,6 @@
 
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
-use WikibaseSolutions\CypherDSL\Assignment;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\StructuralType;
 
@@ -35,7 +34,7 @@ class MatchClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var StructuralType[]|Assignment[] List of patterns
+     * @var StructuralType[] List of patterns
      */
     private array $patterns = [];
 
@@ -52,13 +51,11 @@ public function getPatterns(): array
     /**
      * Add a pattern to the match clause.
      *
-     * @param StructuralType|Assignment $pattern
+     * @param StructuralType $pattern
      * @return MatchClause
      */
-    public function addPattern($pattern): self
+    public function addPattern(StructuralType $pattern): self
     {
-        $this->assertClass('pattern', [StructuralType::class, Assignment::class], $pattern);
-
         $this->patterns[] = $pattern;
 
         return $this;

src/Clauses/MergeClause.php

@@ -22,7 +22,6 @@
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
-use WikibaseSolutions\CypherDSL\Assignment;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\StructuralType;
 
 /**
@@ -35,9 +34,9 @@ class MergeClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var StructuralType|Assignment|null $pattern The pattern to merge
+     * @var StructuralType|null $pattern The pattern to merge
      */
-    private $pattern = null;
+    private ?StructuralType $pattern = null;
 
     /**
      * @var Clause|null $createClause The clause to execute when the pattern is created
@@ -82,13 +81,11 @@ public function getPattern(): ?StructuralType
     /**
      * Sets the pattern to merge.
      *
-     * @param StructuralType|Assignment $pattern The pattern to merge
+     * @param StructuralType $pattern The pattern to merge
      * @return MergeClause
      */
-    public function setPattern($pattern): self
+    public function setPattern(StructuralType $pattern): self
     {
-        $this->assertClass('pattern', [StructuralType::class, Assignment::class], $pattern);
-
         $this->pattern = $pattern;
 
         return $this;

src/Clauses/OptionalMatchClause.php

@@ -21,7 +21,6 @@
 
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
-use WikibaseSolutions\CypherDSL\Assignment;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\StructuralType;
 
@@ -35,7 +34,7 @@ class OptionalMatchClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var StructuralType[]|Assignment[] List of patterns
+     * @var StructuralType[] List of patterns
      */
     private array $patterns = [];
 
@@ -52,13 +51,11 @@ public function getPatterns(): array
     /**
      * Add a pattern to the optional match clause.
      *
-     * @param StructuralType|Assignment $pattern
+     * @param StructuralType $pattern
      * @return OptionalMatchClause
      */
-    public function addPattern($pattern): self
+    public function addPattern(StructuralType $pattern): self
     {
-        $this->assertClass('pattern', [StructuralType::class, Assignment::class], $pattern);
-
         $this->patterns[] = $pattern;
 
         return $this;

src/Clauses/SkipClause.php

@@ -79,4 +79,4 @@ protected function getSubject(): string
 
         return "";
     }
-}
+}

src/Functions/FunctionCall.php

@@ -22,6 +22,7 @@
 namespace WikibaseSolutions\CypherDSL\Functions;
 
 use WikibaseSolutions\CypherDSL\QueryConvertable;
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\MapType;
@@ -35,6 +36,8 @@
  */
 abstract class FunctionCall implements QueryConvertable
 {
+    use AliasableTrait;
+
     /**
      * Produces a raw function call. This enables the usage of unimplemented functions in your
      * Cypher queries. The parameters of this function are not type-checked.

src/Functions/LocalDateTime.php

@@ -23,7 +23,6 @@
 
 use WikibaseSolutions\CypherDSL\Traits\LocalDateTimeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
-use WikibaseSolutions\CypherDSL\Types\PropertyTypes\DateType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\LocalDateTimeType;
 
 /**