Change StructuralTypes things

Author: Wout Gevaert

src/Functions/RawFunction.php

@@ -28,7 +28,6 @@
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\NumeralTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\StringTypeTrait;
-use WikibaseSolutions\CypherDSL\Traits\StructuralTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\MapType;

src/Types/StructuralTypes/HasPropertiesType.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * Cypher DSL
+ * Copyright (C) 2021  Wikibase Solutions
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+namespace WikibaseSolutions\CypherDSL\Types\StructuralTypes;
+
+use WikibaseSolutions\CypherDSL\PropertyMap;
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use function is_array;
+
+interface HasPropertiesType extends StructuralType
+{
+    /**
+     * Add the given property to the properties of this object.
+     *
+     * @param string $key The name of the property
+     * @param AnyType $value The value of the property
+     *
+     * @return static
+     */
+    public function withProperty(string $key, AnyType $value): self;
+
+    /**
+     * Add the given properties to the properties of this object.
+     *
+     * @param PropertyMap|array $properties
+     *
+     * @return static
+     */
+    public function withProperties($properties): self;
+}

src/Types/StructuralTypes/HasRelationshipsType.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * Cypher DSL
+ * Copyright (C) 2021  Wikibase Solutions
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+namespace WikibaseSolutions\CypherDSL\Types\StructuralTypes;
+
+use WikibaseSolutions\CypherDSL\Patterns\Node;
+use WikibaseSolutions\CypherDSL\Patterns\Path;
+use WikibaseSolutions\CypherDSL\PropertyMap;
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use WikibaseSolutions\CypherDSL\Variable;
+
+/**
+ * Represents a structural type in Cypher that can have relationships.
+ *
+ * Those are:
+ *
+ * - node
+ * - path
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/syntax/values/#structural-types
+ */
+interface HasRelationshipsType extends StructuralType
+{
+    /**
+     * Adds a new relationship from the end of the structural type to the node pattern.
+     *
+     * @param RelationshipType $relationship
+     * @param Node|Path $nodeOrPath
+     * @return Path
+     */
+    public function relationship(RelationshipType $relationship, StructuralType $nodeOrPath): Path;
+
+    /**
+     * Adds a new relationship to the node pattern at the end of the structural type to form a path.
+     *
+     * @param NodeType|Path $nodeOrPath The node to attach to the end of the structural type
+     * @param string|null $type The type of the relationship
+     * @param array|PropertyMap|null $properties The properties to attach to the relationship
+     * @param string|Variable|null $name The name fo the relationship
+     *
+     * @return Path
+     */
+    public function relationshipTo(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path;
+
+    /**
+     * Adds a new relationship from the node pattern at the end of the structural type to form a path.
+     *
+     * @param NodeType|Path $nodeOrPath The node to attach to the end of the structural type.
+     * @param string|null $type The type of the relationship
+     * @param array|PropertyMap|null $properties The properties to attach to the relationship
+     * @param string|Variable|null $name The name fo the relationship
+     *
+     * @return Path
+     */
+    public function relationshipFrom(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path;
+
+    /**
+     * Adds a new unidirectional relationship to the node pattern at the end of the structural type to form a path.
+     *
+     * @param NodeType|Path $nodeOrPath The node to attach to the end of the structural type.
+     * @param string|null $type The type of the relationship
+     * @param array|PropertyMap|null $properties The properties to attach to the relationship
+     * @param string|Variable|null $name The name fo the relationship
+     *
+     * @return Path
+     */
+    public function relationshipUni(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path;
+}

src/Types/StructuralTypes/NodeType.php

@@ -24,6 +24,6 @@
 /**
  * Represents the type "node".
  */
-interface NodeType extends StructuralType
+interface NodeType extends HasRelationshipsType, HasPropertiesType
 {
 }

src/Types/StructuralTypes/PathType.php

@@ -24,6 +24,6 @@
 /**
  * Represents the type "path".
  */
-interface PathType extends StructuralType
+interface PathType extends HasRelationshipsType
 {
 }

src/Types/StructuralTypes/RelationshipType.php

@@ -26,6 +26,6 @@
 /**
  * Represents the type "relationship".
  */
-interface RelationshipType extends AnyType
+interface RelationshipType extends HasPropertiesType
 {
 }

src/Types/StructuralTypes/StructuralType.php

@@ -47,47 +47,4 @@
  */
 interface StructuralType extends AnyType
 {
-    /**
-     * Adds a new relationship from the end of the structural type to the node pattern.
-     * @param RelationshipType $relationship
-     * @param Node|Path $nodeOrPath
-     * @return Path
-     */
-    public function relationship(RelationshipType $relationship, StructuralType $nodeOrPath): Path;
-
-    /**
-     * Adds a new relationship to the node pattern at the end of the structural type to form a path.
-     *
-     * @param NodeType|Path $nodeOrPath The node to attach to the end of the structural type
-     * @param string|null $type The type of the relationship
-     * @param array|PropertyMap|null $properties The properties to attach to the relationship
-     * @param string|Variable|null $name The name fo the relationship
-     *
-     * @return Path
-     */
-    public function relationshipTo(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path;
-
-    /**
-     * Adds a new relationship from the node pattern at the end of the structural type to form a path.
-     *
-     * @param NodeType|Path $nodeOrPath The node to attach to the end of the structural type.
-     * @param string|null $type The type of the relationship
-     * @param array|PropertyMap|null $properties The properties to attach to the relationship
-     * @param string|Variable|null $name The name fo the relationship
-     *
-     * @return Path
-     */
-    public function relationshipFrom(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path;
-
-    /**
-     * Adds a new unidirectional relationship to the node pattern at the end of the structural type to form a path.
-     *
-     * @param NodeType|Path $nodeOrPath The node to attach to the end of the structural type.
-     * @param string|null $type The type of the relationship
-     * @param array|PropertyMap|null $properties The properties to attach to the relationship
-     * @param string|Variable|null $name The name fo the relationship
-     *
-     * @return Path
-     */
-    public function relationshipUni(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path;
 }

src/Variable.php

@@ -50,10 +50,6 @@
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PointType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\TimeType;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\NodeType;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\PathType;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\RelationshipType;
-use WikibaseSolutions\CypherDSL\Types\StructuralTypes\StructuralType;
 
 /**
  * Represents a variable.
@@ -68,9 +64,7 @@ class Variable implements
     LocalDateTimeType,
     LocalTimeType,
     MapType,
-    NodeType,
     NumeralType,
-    PathType,
     PointType,
     StringType,
     TimeType
@@ -146,36 +140,4 @@ public function toQuery(): string
     {
         return self::escape($this->getName());
     }
-
-    /**
-     * @inheritDoc
-     */
-    public function relationship(RelationshipType $relationship, StructuralType $nodeOrPath): Path
-    {
-        return (new Path((new Node())->named($this)))->relationship($relationship, $nodeOrPath);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function relationshipTo(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path
-    {
-        return (new Path((new Node())->named($this)))->relationshipTo($nodeOrPath, $type, $properties, $name);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function relationshipFrom(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path
-    {
-        return (new Path((new Node())->named($this)))->relationshipFrom($nodeOrPath, $type, $properties, $name);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function relationshipUni(StructuralType $nodeOrPath, ?string $type = null, $properties = null, $name = null): Path
-    {
-        return (new Path((new Node())->named($this)))->relationshipUni($nodeOrPath, $type, $properties, $name);
-    }
 }