1 files changed, 142 insertions, 0 deletions
diff --git a/plugins/SegmentEditor/SegmentFormatter.php b/plugins/SegmentEditor/SegmentFormatter.php
new file mode 100644
index 0000000000..54dcc20c99
--- /dev/null
+++ b/plugins/SegmentEditor/SegmentFormatter.php
@@ -0,0 +1,142 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\SegmentEditor;
+
+use Exception;
+use Piwik\Config;
+use Piwik\Db;
+use Piwik\Piwik;
+use Piwik\Segment;
+use Piwik\Segment\SegmentExpression;
+
+/**
+ */
+class SegmentFormatter
+{
+    /**
+     * @var SegmentList
+     */
+    private $segmentList;
+
+    private $matchesMetric = array(
+        SegmentExpression::MATCH_EQUAL => 'General_OperationEquals',
+        SegmentExpression::MATCH_NOT_EQUAL => 'General_OperationNotEquals',
+        SegmentExpression::MATCH_LESS_OR_EQUAL => 'General_OperationAtMost',
+        SegmentExpression::MATCH_GREATER_OR_EQUAL => 'General_OperationAtLeast',
+        SegmentExpression::MATCH_LESS => 'General_OperationLessThan',
+        SegmentExpression::MATCH_GREATER => 'General_OperationGreaterThan',
+    );
+
+    private $matchesDimension = array(
+        SegmentExpression::MATCH_EQUAL => 'General_OperationIs',
+        SegmentExpression::MATCH_NOT_EQUAL => 'General_OperationIsNot',
+        SegmentExpression::MATCH_CONTAINS => 'General_OperationContains',
+        SegmentExpression::MATCH_DOES_NOT_CONTAIN => 'General_OperationDoesNotContain',
+        SegmentExpression::MATCH_STARTS_WITH => 'General_OperationStartsWith',
+        SegmentExpression::MATCH_ENDS_WITH => 'General_OperationEndsWith'
+    );
+
+    private $operators = array(
+        SegmentExpression::BOOL_OPERATOR_AND => 'General_And',
+        SegmentExpression::BOOL_OPERATOR_OR => 'General_Or',
+        SegmentExpression::BOOL_OPERATOR_END => '',
+    );
+
+    public function __construct(SegmentList $segmentList)
+    {
+        $this->segmentList = $segmentList;
+    }
+
+    public function getHumanReadable($segmentString, $idSite)
+    {
+        if (empty($segmentString)) {
+            return Piwik::translate('SegmentEditor_DefaultAllVisits');
+        }
+
+        $segment = new SegmentExpression($segmentString);
+        $expressions = $segment->parseSubExpressions();
+
+        $readable = '';
+        foreach ($expressions as $expression) {
+            $operator = $expression[SegmentExpression::INDEX_BOOL_OPERATOR];
+            $operand  = $expression[SegmentExpression::INDEX_OPERAND];
+            $name     = $operand[SegmentExpression::INDEX_OPERAND_NAME];
+
+            $segment = $this->segmentList->findSegment($name, $idSite);
+
+            if (empty($segment)) {
+                throw new Exception(sprintf("The segment '%s' does not exist.", $name));
+            }
+
+            $readable .= $segment['name'] . ' ';
+            $readable .= $this->getTranslationForComparison($operand, $segment['type']) . ' ';
+            $readable .= $this->getFormattedValue($operand);
+            $readable .= $this->getTranslationForBoolOperator($operator) . ' ';
+        }
+
+        $readable = trim($readable);
+
+        return $readable;
+    }
+
+    private function getTranslationForComparison($operand, $segmentType)
+    {
+        $operator = $operand[SegmentExpression::INDEX_OPERAND_OPERATOR];
+
+        $translation = $operator;
+
+        if ($operator === SegmentExpression::MATCH_IS_NULL_OR_EMPTY) {
+            return Piwik::translate('SegmentEditor_SegmentOperatorIsNullOrEmpty');
+        }
+
+        if ($operator === SegmentExpression::MATCH_IS_NOT_NULL_NOR_EMPTY) {
+            return Piwik::translate('SegmentEditor_SegmentOperatorIsNotNullNorEmpty');
+        }
+
+        if ($segmentType === 'dimension' && !empty($this->matchesDimension[$operator])) {
+            $translation = Piwik::translate($this->matchesDimension[$operator]);
+        }
+        if ($segmentType === 'metric' && !empty($this->matchesMetric[$operator])) {
+            $translation = Piwik::translate($this->matchesMetric[$operator]);
+        }
+
+        return strtolower($translation);
+    }
+
+    private function getFormattedValue($operand)
+    {
+        $operator = $operand[SegmentExpression::INDEX_OPERAND_OPERATOR];
+
+        if ($operator === SegmentExpression::MATCH_IS_NULL_OR_EMPTY
+            || $operator === SegmentExpression::MATCH_IS_NOT_NULL_NOR_EMPTY) {
+            return '';
+        }
+
+        $value = $operand[SegmentExpression::INDEX_OPERAND_VALUE];
+
+        if (empty($value)) {
+            $value = '';
+        }
+
+        return '"' . $value . '" ';
+    }
+
+    private function getTranslationForBoolOperator($operator)
+    {
+        $translation = '';
+
+        if (!empty($this->operators[$operator])) {
+            $translation = Piwik::translate($this->operators[$operator]);
+        } elseif (!empty($operator)) {
+            $translation = $operator;
+        }
+
+        return $translation;
+    }
+}