core/DataAccess/TableMetadata.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
namespace Piwik\DataAccess;

use Piwik\Db;

/**
 * Data Access Object that can be used to get metadata information about
 * the MySQL tables Piwik uses.
 */
class TableMetadata
{
    /**
     * Returns the list of column names for a table.
     *
     * @param string $table Prefixed table name.
     * @return string[] List of column names..
     */
    public function getColumns($table)
    {
        $table = str_replace("`", "", $table);

        $columns = Db::fetchAll("SHOW COLUMNS FROM `" . $table . "`");

        $columnNames = array();
        foreach ($columns as $column) {
            $columnNames[] = $column['Field'];
        }

        return $columnNames;
    }

    /**
     * Returns the list of idaction columns in a table. A column is
     * assumed to be an idaction reference if it has `"idaction"` in its
     * name (eg, `"idaction_url"` or `"idaction_content_name"`.
     *
     * @param string $table Prefixed table name.
     * @return string[]
     */
    public function getIdActionColumnNames($table)
    {
        $columns = $this->getColumns($table);

        $columns = array_filter($columns, function ($columnName) {
            return strpos($columnName, 'idaction') !== false;
        });

        return array_values($columns);
    }
}