blob: 6f9057f18dc4038a691f2a4b6591c389695920e4 (
plain)
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
|
<?php
namespace Mediawiki\Api\Service;
use Mediawiki\Api\Generator\ApiGenerator;
use Mediawiki\Api\SimpleRequest;
use Mediawiki\DataModel\Pages;
use Mediawiki\DataModel\Page;
/**
* @access private
*
* @author Addshore
* @author Thomas Arrow
*/
class PagePurger extends Service {
/**
* @since 0.3
*
* @brief Purge a single page
*
* Purges a single page by submitting a
* 'purge' action to the mediawiki api
* with the parameter 'pageids' set to
* the singe page id
*
* @param Page $page the page that is going to be purged
*
* @return bool return true if the purge was successful
*/
public function purge( Page $page ) {
$responseArray = $this->api->postRequest(
new SimpleRequest( 'purge', [ 'pageids' => $page->getId() ] )
);
// the purge response for the page
$purgeResponse = $responseArray['purge'][0];
return array_key_exists( 'purged', $purgeResponse );
}
/**
* @since 0.7
*
* @brief Purge multiple pages
*
* Purges all the pages of the Pages object
* by submitting a 'purge' action to the mediawiki
* api with the parameter 'pageids' set to be the
* pages ids in multiple-value seperation.
*
* @param Pages $pages the pages that are going to be purged
*
* @return Pages the pages that have been purged successfully
*/
public function purgePages( Pages $pages ) {
$pagesArray = $pages->toArray();
$pagesIds = [];
foreach ( $pagesArray as $page ) {
array_push( $pagesIds, $page->getId() );
}
// convert an array to multiple-value format
// because the mediawiki api require multiple
// values to be seperated like the example
// ex: [111, 222, 333] => "111|222|333"
$pageIdsMultiple = implode( '|', $pagesIds );
$responseArray = $this->api->postRequest(
new SimpleRequest( 'purge', [ 'pageids' => $pageIdsMultiple ] )
);
// array that will hold the successfully purged pages
$purgedPages = new Pages();
// for every purge result
foreach ( $responseArray['purge'] as $purgeResponse ) {
// if the purge for the page was successful
if ( array_key_exists( 'purged', $purgeResponse ) ) {
// we iterate all the input pages
foreach ( $pagesArray as $page ) {
// and if the page from the input was successfully purged
if ( $purgeResponse['title'] === $page->getTitle()->getText() ) {
// add it in the purgedPages object
$purgedPages->addPage( $page );
break;
}
}
}
}
return $purgedPages;
}
/**
* @since 0.6
*
* @param ApiGenerator $generator
*
* @return bool
*/
public function purgeGenerator( ApiGenerator $generator ) {
$this->api->postRequest(
new SimpleRequest( 'purge', $generator->getParams() )
);
return true;
}
}
|
