From d2e46c17edc1fb2cb6e12f6ff010e6f7145f1b7c Mon Sep 17 00:00:00 2001
From: Rostislav Wolny <rosta@mailpoet.com>
Date: Wed, 16 Sep 2020 13:06:25 +0200
Subject: [PATCH] Add dummy dynamic segments filters

[MAILPOET-3077]
---
 lib/Entities/DynamicSegmentFilterEntity.php   |  7 +++++
 .../Exceptions/InvalidFilterException.php     | 17 ++++++++++
 .../DynamicSegments/Filters/EmailAction.php   | 31 +++++++++++++++++++
 .../DynamicSegments/Filters/Filter.php        |  9 ++++++
 .../DynamicSegments/Filters/UserRole.php      | 18 +++++++++++
 .../Filters/WooCommerceCategory.php           | 20 ++++++++++++
 .../Filters/WooCommerceProduct.php            | 20 ++++++++++++
 7 files changed, 122 insertions(+)
 create mode 100644 lib/Segments/DynamicSegments/Exceptions/InvalidFilterException.php
 create mode 100644 lib/Segments/DynamicSegments/Filters/EmailAction.php
 create mode 100644 lib/Segments/DynamicSegments/Filters/Filter.php
 create mode 100644 lib/Segments/DynamicSegments/Filters/UserRole.php
 create mode 100644 lib/Segments/DynamicSegments/Filters/WooCommerceCategory.php
 create mode 100644 lib/Segments/DynamicSegments/Filters/WooCommerceProduct.php

diff --git a/lib/Entities/DynamicSegmentFilterEntity.php b/lib/Entities/DynamicSegmentFilterEntity.php
index c5d2ca66a8..3a09bbbcd2 100644
--- a/lib/Entities/DynamicSegmentFilterEntity.php
+++ b/lib/Entities/DynamicSegmentFilterEntity.php
@@ -50,6 +50,13 @@ class DynamicSegmentFilterEntity {
     return $this->filterData;
   }
 
+  /**
+   * @return mixed|null
+   */
+  public function getFilterDataParam(string $name) {
+    return $this->filterData[$name] ?? null;
+  }
+
   /**
    * @return string|null
    */
diff --git a/lib/Segments/DynamicSegments/Exceptions/InvalidFilterException.php b/lib/Segments/DynamicSegments/Exceptions/InvalidFilterException.php
new file mode 100644
index 0000000000..40e2fdaabe
--- /dev/null
+++ b/lib/Segments/DynamicSegments/Exceptions/InvalidFilterException.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace MailPoet\Segments\DynamicSegments\Exceptions;
+
+use MailPoet\InvalidStateException;
+
+class InvalidFilterException extends InvalidStateException {
+
+  const MISSING_TYPE = 1;
+  const INVALID_TYPE = 2;
+  const MISSING_ROLE = 3;
+  const MISSING_ACTION = 4;
+  const MISSING_NEWSLETTER_ID = 5;
+  const MISSING_CATEGORY_ID = 6;
+  const MISSING_PRODUCT_ID = 7;
+
+};
diff --git a/lib/Segments/DynamicSegments/Filters/EmailAction.php b/lib/Segments/DynamicSegments/Filters/EmailAction.php
new file mode 100644
index 0000000000..2caee69f20
--- /dev/null
+++ b/lib/Segments/DynamicSegments/Filters/EmailAction.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace MailPoet\Segments\DynamicSegments\Filters;
+
+use MailPoetVendor\Doctrine\DBAL\Query\QueryBuilder;
+
+class EmailAction implements Filter {
+  const ACTION_OPENED = 'opened';
+  const ACTION_NOT_OPENED = 'notOpened';
+  const ACTION_CLICKED = 'clicked';
+  const ACTION_NOT_CLICKED = 'notClicked';
+
+  /** @var string */
+  private $action;
+
+  /** @var int */
+  private $newsletterId;
+
+  /** @var int|null */
+  private $linkId;
+
+  public function __construct(string $action, int $newsletterId, int $linkId = null) {
+    $this->action = $action;
+    $this->newsletterId = $newsletterId;
+    $this->linkId = $linkId;
+  }
+
+  public function apply(QueryBuilder $queryBuilder): QueryBuilder {
+    return $queryBuilder;
+  }
+}
diff --git a/lib/Segments/DynamicSegments/Filters/Filter.php b/lib/Segments/DynamicSegments/Filters/Filter.php
new file mode 100644
index 0000000000..53e4741175
--- /dev/null
+++ b/lib/Segments/DynamicSegments/Filters/Filter.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace MailPoet\Segments\DynamicSegments\Filters;
+
+use MailPoetVendor\Doctrine\DBAL\Query\QueryBuilder;
+
+interface Filter {
+  public function apply(QueryBuilder $queryBuilder): QueryBuilder;
+}
diff --git a/lib/Segments/DynamicSegments/Filters/UserRole.php b/lib/Segments/DynamicSegments/Filters/UserRole.php
new file mode 100644
index 0000000000..54a7e41fc1
--- /dev/null
+++ b/lib/Segments/DynamicSegments/Filters/UserRole.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace MailPoet\Segments\DynamicSegments\Filters;
+
+use MailPoetVendor\Doctrine\DBAL\Query\QueryBuilder;
+
+class UserRole implements Filter {
+  /** @var string */
+  private $role;
+
+  public function __construct(string $role) {
+    $this->role = $role;
+  }
+
+  public function apply(QueryBuilder $queryBuilder): QueryBuilder {
+    return $queryBuilder;
+  }
+}
diff --git a/lib/Segments/DynamicSegments/Filters/WooCommerceCategory.php b/lib/Segments/DynamicSegments/Filters/WooCommerceCategory.php
new file mode 100644
index 0000000000..1b03972e7e
--- /dev/null
+++ b/lib/Segments/DynamicSegments/Filters/WooCommerceCategory.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace MailPoet\Segments\DynamicSegments\Filters;
+
+use MailPoetVendor\Doctrine\DBAL\Query\QueryBuilder;
+
+class WooCommerceCategory implements Filter {
+  const ACTION_CATEGORY = 'purchasedCategory';
+
+  /** @var int */
+  private $categoryId;
+
+  public function __construct(int $categoryId) {
+    $this->categoryId = $categoryId;
+  }
+
+  public function apply(QueryBuilder $queryBuilder): QueryBuilder {
+    return $queryBuilder;
+  }
+}
diff --git a/lib/Segments/DynamicSegments/Filters/WooCommerceProduct.php b/lib/Segments/DynamicSegments/Filters/WooCommerceProduct.php
new file mode 100644
index 0000000000..403dfcbfe4
--- /dev/null
+++ b/lib/Segments/DynamicSegments/Filters/WooCommerceProduct.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace MailPoet\Segments\DynamicSegments\Filters;
+
+use MailPoetVendor\Doctrine\DBAL\Query\QueryBuilder;
+
+class WooCommerceProduct implements Filter {
+  const ACTION_PRODUCT = 'purchasedProduct';
+
+  /** @var int */
+  private $productId;
+
+  public function __construct(int $productId) {
+    $this->productId = $productId;
+  }
+
+  public function apply(QueryBuilder $queryBuilder): QueryBuilder {
+    return $queryBuilder;
+  }
+}