getActualMetricColumn() public static method

Helper method that determines the actual column for a metric in a {@link Piwik\DataTable}.
public static getActualMetricColumn ( DataTable $table, string $columnName, int[] | null $mappingNameToId = null ) : string
$table Piwik\DataTable
$columnName string
$mappingNameToId int[] | null A custom mapping of metric names to special index values. By default {@link Metrics::getMappingFromNameToId()} is used.
return string
示例#1
0
文件: Sorter.php 项目: piwik/piwik
 /**
  * Detect the column to be used for sorting
  *
  * @param DataTable $table
  * @param string|int $columnToSort  column name or column id
  * @return int
  */
 public function getPrimaryColumnToSort(DataTable $table, $columnToSort)
 {
     // we fallback to nb_visits in case columnToSort does not exist
     $columnsToCheck = array($columnToSort, 'nb_visits');
     $row = $table->getFirstRow();
     foreach ($columnsToCheck as $column) {
         $column = Metric::getActualMetricColumn($table, $column);
         if ($row->hasColumn($column)) {
             // since getActualMetricColumn() returns a default value, we need to make sure it actually has that column
             return $column;
         }
     }
     return $columnToSort;
 }