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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
<?php
namespace MediaWiki\Page;
use Iterator;
use MediaWiki\Cache\LinkCache;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\LikeValue;
use Wikimedia\Rdbms\SelectQueryBuilder;
/**
* @since 1.36
*/
class PageSelectQueryBuilder extends SelectQueryBuilder {
/** @var PageStore */
private $pageStore;
/** @var LinkCache|null */
private $linkCache;
/**
* @param IReadableDatabase $db
* @param PageStore $pageStore
* @param LinkCache|null $linkCache A link cache to store any retrieved rows into
*
* @internal
*/
public function __construct( IReadableDatabase $db, PageStore $pageStore, ?LinkCache $linkCache = null ) {
parent::__construct( $db );
$this->pageStore = $pageStore;
$this->table( 'page' );
$this->linkCache = $linkCache;
}
/**
* Find by provided page ids.
*
* @param int|int[] $pageIds
*
* @return PageSelectQueryBuilder
*/
public function wherePageIds( $pageIds ): self {
Assert::parameterType( [ 'integer', 'array' ], $pageIds, '$pageIds' );
if ( $pageIds ) {
$this->conds( [ 'page_id' => $pageIds ] );
} else {
$this->conds( '0 = 1' ); // force empty result set
}
return $this;
}
/**
* Find by provided namespace.
*
* @param int $namespace
*
* @return PageSelectQueryBuilder
*/
public function whereNamespace( int $namespace ): self {
$this->conds( [ 'page_namespace' => $namespace ] );
return $this;
}
/**
* Find by provided prefix.
*
* @param int $namespace
* @param string $prefix
*
* @return PageSelectQueryBuilder
*/
public function whereTitlePrefix( int $namespace, string $prefix ): self {
$this->whereNamespace( $namespace );
$this->conds(
$this->db->expr( 'page_title', IExpression::LIKE, new LikeValue( $prefix, $this->db->anyString() ) )
);
return $this;
}
/**
* Find by provided page titles.
*
* @param int $namespace
* @param string|string[] $pageTitles
*
* @return PageSelectQueryBuilder
*/
public function whereTitles( int $namespace, $pageTitles ): self {
Assert::parameterType( [ 'string', 'array' ], $pageTitles, '$pageTitles' );
$this->conds( [ 'page_namespace' => $namespace ] );
$this->conds( [ 'page_title' => $pageTitles ] );
return $this;
}
/**
* Order results by namespace and title in $direction
*
* @param string $dir one of self::SORT_ASC or self::SORT_DESC
*
* @return PageSelectQueryBuilder
*/
public function orderByTitle( string $dir = self::SORT_ASC ): self {
$this->orderBy( [ 'page_namespace', 'page_title' ], $dir );
return $this;
}
/**
* Order results by page id.
*
* @param string $dir one of self::SORT_ASC or self::SORT_DESC
*
* @return PageSelectQueryBuilder
*/
public function orderByPageId( string $dir = self::SORT_ASC ): self {
$this->orderBy( 'page_id', $dir );
return $this;
}
/**
* Fetch a single PageRecord that matches specified criteria.
*
* @return PageRecord|null
*/
public function fetchPageRecord(): ?PageRecord {
$this->fields( $this->pageStore->getSelectFields() );
$row = $this->fetchRow();
if ( !$row ) {
return null;
}
$rec = $this->pageStore->newPageRecordFromRow( $row );
if ( $this->linkCache ) {
$this->linkCache->addGoodLinkObjFromRow( $rec, $row );
}
return $rec;
}
/**
* Fetch PageRecords for the specified query.
*
* @return Iterator<ExistingPageRecord>
*/
public function fetchPageRecords(): Iterator {
$this->fields( $this->pageStore->getSelectFields() );
$result = $this->fetchResultSet();
foreach ( $result as $row ) {
$rec = $this->pageStore->newPageRecordFromRow( $row );
if ( $this->linkCache ) {
$this->linkCache->addGoodLinkObjFromRow( $rec, $row );
}
yield $rec;
}
$result->free();
}
/**
* Fetch PageRecords for the specified query as an associative
* array, using page IDs as array keys.
*
* @return ExistingPageRecord[]
*/
public function fetchPageRecordArray(): array {
$recs = [];
foreach ( $this->fetchPageRecords() as $rec ) {
$recs[ $rec->getId() ] = $rec;
}
return $recs;
}
/**
* Returns an array of page ids matching the query.
*
* @return int[]
*/
public function fetchPageIds(): array {
$this->field( 'page_id' );
return array_map( 'intval', $this->fetchFieldValues() );
}
}
|
