Move Alias and PropertyReplacement to Syntax namespace

Author: marijnvanwezel

src/Clauses/SetClause.php

@@ -22,8 +22,8 @@
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
 use WikibaseSolutions\CypherDSL\Expressions\Label;
-use WikibaseSolutions\CypherDSL\PropertyReplacement;
 use WikibaseSolutions\CypherDSL\QueryConvertible;
+use WikibaseSolutions\CypherDSL\Syntax\PropertyReplacement;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 
 /**

src/Expressions/Property.php

@@ -21,7 +21,7 @@
 
 namespace WikibaseSolutions\CypherDSL\Expressions;
 
-use WikibaseSolutions\CypherDSL\PropertyReplacement;
+use WikibaseSolutions\CypherDSL\Syntax\PropertyReplacement;
 use WikibaseSolutions\CypherDSL\Traits\TypeTraits\CompositeTypeTraits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\TypeTraits\CompositeTypeTraits\MapTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\TypeTraits\PropertyTypeTraits\BooleanTypeTrait;

src/Patterns/Relationship.php

@@ -25,13 +25,9 @@
 use InvalidArgumentException;
 use LogicException;
 use WikibaseSolutions\CypherDSL\Expressions\Literals\Map;
-use WikibaseSolutions\CypherDSL\Expressions\Variable;
-use WikibaseSolutions\CypherDSL\Traits\CastTrait;
-use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
 use WikibaseSolutions\CypherDSL\Traits\HasPropertiesTrait;
 use WikibaseSolutions\CypherDSL\Traits\HasVariableTrait;
-use WikibaseSolutions\CypherDSL\Types\CompositeTypes\MapType;
 
 /**
  * This class represents an arbitrary relationship.
@@ -41,9 +37,8 @@
  */
 final class Relationship
 {
-    use CastTrait;
-	use ErrorTrait;
     use EscapeTrait;
+
     use HasPropertiesTrait;
     use HasVariableTrait;
 
@@ -76,16 +71,16 @@ final class Relationship
      */
     private ?int $exactHops = null;
 
-	/**
-	 * @var bool Whether to allow arbitrary hops between nodes
-	 */
-	private bool $arbitraryHops = false;
+    /**
+     * @var bool Whether to allow arbitrary hops between nodes
+     */
+    private bool $arbitraryHops = false;
 
-	/**
+    /**
      * @param array $direction The direction of the relationship, should be either:
      *  - Relationship::DIR_RIGHT (for a relation of (a)-->(b))
-	 *  - Relationship::DIR_LEFT (for a relation of (a)<--(b))
-	 *  - Relationship::DIR_UNI (for a relation of (a)--(b))
+     *  - Relationship::DIR_LEFT (for a relation of (a)<--(b))
+     *  - Relationship::DIR_UNI (for a relation of (a)--(b))
      */
     public function __construct(array $direction)
     {
@@ -173,39 +168,39 @@ public function withExactHops(int $exactHops): self
         return $this;
     }
 
-	/**
-	 * Set the number of hops to be an arbitrary number (wildcard).
-	 *
-	 * @param bool $arbitraryHops
-	 * @return $this
-	 */
-	public function setArbitraryHops(bool $arbitraryHops = true): self
-	{
-		if (isset($this->minHops) || isset($this->maxHops) || isset($this->exactHops)) {
-			throw new LogicException("arbitraryHops cannot be used in combination with minHops, maxHops or exactHops");
-		}
-
-		$this->arbitraryHops = $arbitraryHops;
-
-		return $this;
-	}
-
-	/**
-	 * The types to require for this relationship. Will overwrite any previously set types.
-	 *
-	 * @param string[] $types
-	 * @return $this
-	 */
-	public function withTypes(array $types): self
-	{
-		$this->types = $types;
-
-		return $this;
-	}
+    /**
+     * Set the number of hops to be an arbitrary number (wildcard).
+     *
+     * @param bool $arbitraryHops
+     * @return $this
+     */
+    public function setArbitraryHops(bool $arbitraryHops = true): self
+    {
+        if (isset($this->minHops) || isset($this->maxHops) || isset($this->exactHops)) {
+            throw new LogicException("arbitraryHops cannot be used in combination with minHops, maxHops or exactHops");
+        }
+
+        $this->arbitraryHops = $arbitraryHops;
+
+        return $this;
+    }
 
     /**
-	 * Add one or more types to require for this relationship.
-	 *
+     * The types to require for this relationship. Will overwrite any previously set types.
+     *
+     * @param string[] $types
+     * @return $this
+     */
+    public function withTypes(array $types): self
+    {
+        $this->types = $types;
+
+        return $this;
+    }
+
+    /**
+     * Add one or more types to require for this relationship.
+     *
      * @param string ...$type
      * @return $this
      */
@@ -227,54 +222,44 @@ public function getDirection(): array
     }
 
     /**
-     * Returns the properties of this node.
+     * Returns the exact amount of hops configured.
      *
-     * @return MapType
+     * @return int|null
      */
-    public function getProperties(): ?MapType
+    public function getExactHops(): ?int
     {
-        return $this->properties;
+        return $this->exactHops;
     }
 
-	/**
-	 * Returns the exact amount of hops configured.
-	 *
-	 * @return int|null
-	 */
-	public function getExactHops(): ?int
-	{
-		return $this->exactHops;
-	}
-
-	/**
-	 * Returns the maximum amount of hops configured
-	 *
-	 * @return int|null
-	 */
-	public function getMaxHops(): ?int
-	{
-		return $this->maxHops;
-	}
-
-	/**
-	 * Returns the minimum amount of hops configured.
-	 *
-	 * @return int|null
-	 */
-	public function getMinHops(): ?int
-	{
-		return $this->minHops;
-	}
-
-	/**
-	 * Returns the types of the relationship.
-	 *
-	 * @return string[]
-	 */
-	public function getTypes(): array
-	{
-		return $this->types;
-	}
+    /**
+     * Returns the maximum amount of hops configured
+     *
+     * @return int|null
+     */
+    public function getMaxHops(): ?int
+    {
+        return $this->maxHops;
+    }
+
+    /**
+     * Returns the minimum amount of hops configured.
+     *
+     * @return int|null
+     */
+    public function getMinHops(): ?int
+    {
+        return $this->minHops;
+    }
+
+    /**
+     * Returns the types of the relationship.
+     *
+     * @return string[]
+     */
+    public function getTypes(): array
+    {
+        return $this->types;
+    }
 
     /**
      * Returns the string representation of this relationship that can be used directly
@@ -324,8 +309,8 @@ private function relationshipDetailToString(): string
             $conditionInner .= '*' . $this->exactHops;
         } elseif ($this->arbitraryHops) {
             // We have an arbitrary number of hops
-			$conditionInner .= '*';
-		}
+            $conditionInner .= '*';
+        }
 
         if (isset($this->properties)) {
             // Only add the properties if they're not empty

src/Query.php

@@ -54,6 +54,7 @@
 use WikibaseSolutions\CypherDSL\Expressions\Variable;
 use WikibaseSolutions\CypherDSL\Patterns\Node;
 use WikibaseSolutions\CypherDSL\Patterns\Relationship;
+use WikibaseSolutions\CypherDSL\Syntax\PropertyReplacement;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;

src/Alias.php renamed to src/Syntax/Alias.php

@@ -19,9 +19,10 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-namespace WikibaseSolutions\CypherDSL;
+namespace WikibaseSolutions\CypherDSL\Syntax;
 
 use WikibaseSolutions\CypherDSL\Expressions\Variable;
+use WikibaseSolutions\CypherDSL\QueryConvertible;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use function sprintf;
 
@@ -31,7 +32,7 @@
  * @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
  */
-final class Alias
+final class Alias implements QueryConvertible
 {
     /**
      * @var AnyType The original item to be aliased
@@ -55,25 +56,25 @@ public function __construct(AnyType $original, Variable $variable)
         $this->variable = $variable;
     }
 
-	/**
-	 * Gets the original item of the alias.
-	 *
-	 * @return AnyType
-	 */
-	public function getOriginal(): AnyType
-	{
-		return $this->original;
-	}
+    /**
+     * 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;
-	}
+    /**
+     * Gets the variable from the alias.
+     *
+     * @return Variable
+     */
+    public function getVariable(): Variable
+    {
+        return $this->variable;
+    }
 
     /**
      * @inheritDoc

src/PropertyReplacement.php renamed to src/Syntax/PropertyReplacement.php

@@ -19,10 +19,11 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-namespace WikibaseSolutions\CypherDSL;
+namespace WikibaseSolutions\CypherDSL\Syntax;
 
 use WikibaseSolutions\CypherDSL\Expressions\Property;
 use WikibaseSolutions\CypherDSL\Expressions\Variable;
+use WikibaseSolutions\CypherDSL\QueryConvertible;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 

src/Traits/HasPropertiesTrait.php

@@ -23,7 +23,6 @@
 
 use TypeError;
 use WikibaseSolutions\CypherDSL\Expressions\Literals\Map;
-use WikibaseSolutions\CypherDSL\Query;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\MapType;
 
 /**
@@ -65,10 +64,12 @@ public function addProperty(string $key, $property): self
     {
         if (!isset($this->properties)) {
             $this->properties = new Map();
-        }
-
-        if (!$this->properties instanceof Map) {
-            throw new TypeError('$this->properties must be of type PropertyMap to support "addProperty"');
+        } elseif (!$this->properties instanceof Map) {
+            // Adding to a map is not natively supported by the MapType, but it is supported by Map. Syntactically, it
+            // is not possible to add new items to, for instance, a Variable, eventhough it implements MapType. It is
+            // however still useful to be able to add items to objects where a Map is used (that is, an object of
+            // MapType with the {} syntax).
+            throw new TypeError('$this->properties must be of type Map to support "addProperty"');
         }
 
         $this->properties->addProperty($key, $property);
@@ -86,15 +87,16 @@ public function addProperty(string $key, $property): self
      */
     public function addProperties($properties): self
     {
+        self::assertClass('properties', [Map::class, 'array'], $properties);
+
         if (!isset($this->properties)) {
             $this->properties = new Map();
-        }
-
-        if (!$this->properties instanceof Map) {
+        } elseif (!$this->properties instanceof Map) {
             throw new TypeError('$this->properties must be of type PropertyMap to support "addProperty"');
         }
 
-        if (!$properties instanceof Map) {
+        if (is_array($properties)) {
+            // Cast the array to a Map
             $properties = new Map($properties);
         }
 
@@ -112,4 +114,4 @@ public function getProperties(): ?MapType
     {
         return $this->properties;
     }
-}
+}

src/Traits/StringGenerationTrait.php

@@ -29,13 +29,13 @@ trait StringGenerationTrait
     /**
      * Generates a unique random identifier.
      *
-     * @note It is not entirely guaranteed that this function gives a truly unique string. However, because the
-     *  number of possible strings is so huge, it should not be a problem. The returned string will consist of
-	 *  $length (default: 32) hexadecimal digits, prepended with $prefix. Since the prefix is predetermined, it does
-	 *  not count towards the entropy of the returned string. Therefore, given the default length of 32, the change
-	 *  of any two strings generated by this function being the same is 1 / 16^32, or about 1 / 3.4 * 10^38.
-	 *
-	 * @note The returned string is not cryptographically secure.
+     * It is not entirely guaranteed that this function gives a truly unique string. However, because the
+     * number of possible strings is so huge, it should not be a problem. The returned string will consist of
+     * $length (default: 32) hexadecimal digits, prepended with $prefix. Since the prefix is predetermined, it does
+     * not count towards the entropy of the returned string. Therefore, given the default length of 32, the change
+     * of any two strings generated by this function being the same is 1 / 16^32, or about 1 / 3.4 * 10^38.
+     *
+     * @note The returned string is not cryptographically secure.
      *
      * @param string $prefix The prefix to put before the name. Must start with a letter to adhere to cypher namings.
      * @param int|null $length The length of the generated name in bytes.