refs #4633 rename segment filter to segment, fixed a bug re visitTime and extracted code into a filter

5 files changed, 46 insertions, 46 deletions

diff --git a/core/DataTable/Filter/AddSegmentFilter.php b/core/DataTable/Filter/AddSegmentByLabel.php
index 48093284a9..a841f18c9a 100644
--- a/core/DataTable/Filter/AddSegmentFilter.php
+++ b/core/DataTable/Filter/AddSegmentByLabel.php
@@ -17,12 +17,12 @@ use Piwik\Development;
  *
  * **Basic usage example**
  *
- *     $dataTable->filter('AddSegmentFilter', array('segmentName'));
- *     $dataTable->filter('AddSegmentFilter', array(array('segmentName1', 'segment2'), ';');
+ *     $dataTable->filter('AddSegmentByLabel', array('segmentName'));
+ *     $dataTable->filter('AddSegmentByLabel', array(array('segmentName1', 'segment2'), ';');
  *
  * @api
  */
-class AddSegmentFilter extends BaseFilter
+class AddSegmentByLabel extends BaseFilter
 {
     private $segments;
     private $delimiter;
@@ -48,7 +48,7 @@ class AddSegmentFilter extends BaseFilter
     }
 
     /**
-     * See {@link AddSegmentFilter}.
+     * See {@link AddSegmentByLabel}.
      *
      * @param DataTable $table
      */
@@ -58,7 +58,7 @@ class AddSegmentFilter extends BaseFilter
         $segments  = $this->segments;
 
         if (empty($segments)) {
-            $msg = 'AddSegmentFilter is called without having any segments defined';
+            $msg = 'AddSegmentByLabel is called without having any segments defined';
             Development::error($msg);
             return;
         }
diff --git a/core/DataTable/Filter/AddSegmentFilterByLabelMapping.php b/core/DataTable/Filter/AddSegmentByLabelMapping.php
index 8a69376938..95d6e05c79 100644
--- a/core/DataTable/Filter/AddSegmentFilterByLabelMapping.php
+++ b/core/DataTable/Filter/AddSegmentByLabelMapping.php
@@ -18,11 +18,11 @@ use Piwik\DataTable\BaseFilter;
  *
  * **Basic usage example**
  *
- *     $dataTable->filter('AddSegmentFilterByLabelMapping', array('segmentName', array('1' => 'smartphone, '2' => 'desktop')));
+ *     $dataTable->filter('AddSegmentByLabelMapping', array('segmentName', array('1' => 'smartphone, '2' => 'desktop')));
  *
  * @api
  */
-class AddSegmentFilterByLabelMapping extends BaseFilter
+class AddSegmentByLabelMapping extends BaseFilter
 {
     private $segment;
     private $mapping;
@@ -41,7 +41,7 @@ class AddSegmentFilterByLabelMapping extends BaseFilter
     }
 
     /**
-     * See {@link AddSegmentFilterByLabelMapping}.
+     * See {@link AddSegmentByLabelMapping}.
      *
      * @param DataTable $table
      */
diff --git a/core/DataTable/Filter/AddSegmentFilterBySegmentValue.php b/core/DataTable/Filter/AddSegmentBySegmentValue.php
index fd185efeaa..89c3b6a59b 100644
--- a/core/DataTable/Filter/AddSegmentFilterBySegmentValue.php
+++ b/core/DataTable/Filter/AddSegmentBySegmentValue.php
@@ -12,16 +12,16 @@ use Piwik\DataTable\BaseFilter;
 use Piwik\DataTable;
 
 /**
- * Converts for each row of a {@link DataTable} a segmentValue to a segmentFilter. The name of the segment
+ * Converts for each row of a {@link DataTable} a segmentValue to a segment (expression). The name of the segment
  * is automatically detected based on the given report.
  *
  * **Basic usage example**
  *
- *     $dataTable->filter('AddSegmentFilterBySegmentValue', array($reportInstance));
+ *     $dataTable->filter('AddSegmentBySegmentValue', array($reportInstance));
  *
  * @api
  */
-class AddSegmentFilterBySegmentValue extends BaseFilter
+class AddSegmentBySegmentValue extends BaseFilter
 {
     /**
      * @var \Piwik\Plugin\Report
@@ -39,7 +39,7 @@ class AddSegmentFilterBySegmentValue extends BaseFilter
     }
 
     /**
-     * See {@link AddSegmentFilterBySegmentValue}.
+     * See {@link AddSegmentBySegmentValue}.
      *
      * @param DataTable $table
      * @return int The number of deleted rows.
diff --git a/core/DataTable/Filter/PrependSegment.php b/core/DataTable/Filter/PrependSegment.php
new file mode 100644
index 0000000000..34d14e6f0a
--- /dev/null
+++ b/core/DataTable/Filter/PrependSegment.php
@@ -0,0 +1,34 @@
+<?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\DataTable\Filter;
+
+use Piwik\DataTable;
+
+/**
+ * Executes a callback for each row of a {@link DataTable} and prepends each existing segment with the
+ * given segment.
+ *
+ * **Basic usage example**
+ *
+ *     $dataTable->filter('PrependSegment', array('segmentName==segmentValue;'));
+ *
+ * @api
+ */
+class PrependSegment extends PrependValueToMetadata
+{
+    /**
+     * @param DataTable $table
+     * @param string $prependSegment The segment to prepend if a segment is already defined. Make sure to include
+     *                               A condition, eg the segment should end with ';' or ','
+     */
+    public function __construct($table, $prependSegment = '')
+    {
+        parent::__construct($table, 'segment', $prependSegment);
+    }
+}
diff --git a/core/DataTable/Filter/PrependSegmentFilter.php b/core/DataTable/Filter/PrependSegmentFilter.php
deleted file mode 100644
index 41718b661f..0000000000
--- a/core/DataTable/Filter/PrependSegmentFilter.php
+++ /dev/null
@@ -1,34 +0,0 @@
-<?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\DataTable\Filter;
-
-use Piwik\DataTable;
-
-/**
- * Executes a callback for each row of a {@link DataTable} and prepends each existing segmentFilter with the
- * given segment.
- *
- * **Basic usage example**
- *
- *     $dataTable->filter('PrependSegmentFilter', array('segmentName==segmentValue;'));
- *
- * @api
- */
-class PrependSegmentFilter extends PrependValueToMetadata
-{
-    /**
-     * @param DataTable $table
-     * @param string $prependSegmentFilter The segment to prepend if a segmentFilter is defined. Make sure to include
-     *                                     A condition, eg the segment should end with ';' or ','
-     */
-    public function __construct($table, $prependSegmentFilter = '')
-    {
-        parent::__construct($table, 'segment', $prependSegmentFilter);
-    }
-}