xref: /plugin/struct/meta/SearchCloud.php (revision d6d97f6064c3b0f90310be8341edc9585520ee54)
10699ff47SMichael Grosse<?php
20699ff47SMichael Grosse
30699ff47SMichael Grossenamespace dokuwiki\plugin\struct\meta;
40699ff47SMichael Grosse
50699ff47SMichael Grosse/**
60699ff47SMichael Grosse * Class SearchCloud
70699ff47SMichael Grosse *
80699ff47SMichael Grosse * The same as @see SearchConfig, but executed a search that is not pid-focused
90699ff47SMichael Grosse *
100699ff47SMichael Grosse * @package dokuwiki\plugin\struct\meta
110699ff47SMichael Grosse */
12*d6d97f60SAnna Dabrowskaclass SearchCloud extends SearchConfig
13*d6d97f60SAnna Dabrowska{
140699ff47SMichael Grosse
153ec19891SMichael Grosse    protected $limit = '';
163ec19891SMichael Grosse
170699ff47SMichael Grosse
180699ff47SMichael Grosse    /**
190699ff47SMichael Grosse     * Transform the set search parameters into a statement
200699ff47SMichael Grosse     *
2186cfd13cSAnna Dabrowska     * @param string $idColumn Column on which to join tables
220699ff47SMichael Grosse     * @return array ($sql, $opts) The SQL and parameters to execute
230699ff47SMichael Grosse     */
24*d6d97f60SAnna Dabrowska    public function getSQL($idColumn)
25*d6d97f60SAnna Dabrowska    {
260699ff47SMichael Grosse        if (!$this->columns) throw new StructException('nocolname');
270699ff47SMichael Grosse
280699ff47SMichael Grosse        $QB = new QueryBuilder();
290699ff47SMichael Grosse        reset($this->schemas);
300699ff47SMichael Grosse        $schema = current($this->schemas);
310699ff47SMichael Grosse        $datatable = 'data_' . $schema->getTable();
3286cfd13cSAnna Dabrowska        if ($idColumn === 'pid') {
330699ff47SMichael Grosse            $QB->addTable('schema_assignments');
340699ff47SMichael Grosse            $QB->filters()->whereAnd("$datatable.pid = schema_assignments.pid");
350699ff47SMichael Grosse            $QB->filters()->whereAnd("schema_assignments.tbl = '{$schema->getTable()}'");
360699ff47SMichael Grosse            $QB->filters()->whereAnd("schema_assignments.assigned = 1");
370699ff47SMichael Grosse            $QB->filters()->whereAnd("GETACCESSLEVEL($datatable.pid) > 0");
380699ff47SMichael Grosse            $QB->filters()->whereAnd("PAGEEXISTS($datatable.pid) = 1");
390699ff47SMichael Grosse        }
400699ff47SMichael Grosse        $QB->addTable($datatable);
410699ff47SMichael Grosse        $QB->filters()->whereAnd("$datatable.latest = 1");
425b133c8dSMichael Große        $QB->filters()->where('AND', 'tag IS NOT \'\'');
430699ff47SMichael Grosse
440699ff47SMichael Grosse        $col = $this->columns[0];
450699ff47SMichael Grosse        if ($col->isMulti()) {
460699ff47SMichael Grosse            $multitable = "multi_{$col->getTable()}";
4787feee46SMichael Grosse            $MN = $QB->generateTableAlias('M');
480699ff47SMichael Grosse
490699ff47SMichael Grosse            $QB->addLeftJoin(
500699ff47SMichael Grosse                $datatable,
510699ff47SMichael Grosse                $multitable,
520699ff47SMichael Grosse                $MN,
5386cfd13cSAnna Dabrowska                "$datatable.$idColumn = $MN.$idColumn AND
540699ff47SMichael Grosse                     $datatable.rev = $MN.rev AND
550699ff47SMichael Grosse                     $MN.colref = {$col->getColref()}"
560699ff47SMichael Grosse            );
570699ff47SMichael Grosse
580699ff47SMichael Grosse            $col->getType()->select($QB, $MN, 'value', 'tag');
595f11f83eSMichael Grosse            $colname = $MN . '.value';
600699ff47SMichael Grosse        } else {
610699ff47SMichael Grosse            $col->getType()->select($QB, $datatable, $col->getColName(), 'tag');
620699ff47SMichael Grosse            $colname = $datatable . '.' . $col->getColName();
630699ff47SMichael Grosse        }
640699ff47SMichael Grosse        $QB->addSelectStatement("COUNT($colname)", 'count');
650699ff47SMichael Grosse        $QB->addGroupByStatement('tag');
66aafac1c1SMichael Grosse        $QB->addOrderBy('count DESC');
670699ff47SMichael Grosse
683ec19891SMichael Grosse        list($sql, $opts) = $QB->getSQL();
693ec19891SMichael Grosse        return [$sql . $this->limit, $opts];
700699ff47SMichael Grosse    }
710699ff47SMichael Grosse
720699ff47SMichael Grosse    /**
733ec19891SMichael Grosse     * We do not have pagination in clouds, so we can work with a limit within SQL
743ec19891SMichael Grosse     *
753ec19891SMichael Grosse     * @param int $limit
763ec19891SMichael Grosse     */
77*d6d97f60SAnna Dabrowska    public function setLimit($limit)
78*d6d97f60SAnna Dabrowska    {
793ec19891SMichael Grosse        $this->limit = " LIMIT $limit";
803ec19891SMichael Grosse    }
813ec19891SMichael Grosse
823ec19891SMichael Grosse    /**
830699ff47SMichael Grosse     * Execute this search and return the result
840699ff47SMichael Grosse     *
850699ff47SMichael Grosse     * The result is a two dimensional array of Value()s.
860699ff47SMichael Grosse     *
8786cfd13cSAnna Dabrowska     * @param string $idColumn Column on which to join tables
880699ff47SMichael Grosse     * @return Value[][]
890699ff47SMichael Grosse     */
90*d6d97f60SAnna Dabrowska    public function execute($idColumn)
91*d6d97f60SAnna Dabrowska    {
9286cfd13cSAnna Dabrowska        list($sql, $opts) = $this->getSQL($idColumn);
930699ff47SMichael Grosse
940699ff47SMichael Grosse        /** @var \PDOStatement $res */
950699ff47SMichael Grosse        $res = $this->sqlite->query($sql, $opts);
960699ff47SMichael Grosse        if ($res === false) throw new StructException("SQL execution failed for\n\n$sql");
970699ff47SMichael Grosse
983ec19891SMichael Grosse        $result = [];
993ec19891SMichael Grosse        $rows = $this->sqlite->res2arr($res);
100ae457e47SMichael Grosse
1013ec19891SMichael Grosse        foreach ($rows as $row) {
102ae457e47SMichael Grosse            if (!empty($this->config['min']) && $this->config['min'] > $row['count']) {
103ae457e47SMichael Grosse                break;
104ae457e47SMichael Grosse            }
1050699ff47SMichael Grosse
1060699ff47SMichael Grosse            $row['tag'] = new Value($this->columns[0], $row['tag']);
1070699ff47SMichael Grosse            $result[] = $row;
1080699ff47SMichael Grosse        }
1090699ff47SMichael Grosse
1100699ff47SMichael Grosse        $this->sqlite->res_close($res);
1113ec19891SMichael Grosse        $this->count = count($result);
1120699ff47SMichael Grosse        return $result;
1130699ff47SMichael Grosse    }
1140699ff47SMichael Grosse}
115