Page MenuHomeGitPull.it

No OneTemporary

Authored By
Unknown
Size
7 KB
Referenced Files
None
Subscribers
None
diff --git "a/include/class-mw\\API\\PageMatcher.php" "b/include/class-mw\\API\\PageMatcher.php"
index 18f37a3..aeb3869 100644
--- "a/include/class-mw\\API\\PageMatcher.php"
+++ "b/include/class-mw\\API\\PageMatcher.php"
@@ -1,242 +1,242 @@
<?php
# Boz-MW - Another MediaWiki API handler in PHP
# Copyright (C) 2018 Valerio Bozzolan
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# MediaWiki API
namespace mw\API;
/**
* Merge your custom page objects with the API response pages
*
* Useful when you try to retrieve informations from many pages
* with less request as possible.
*/
class PageMatcher {
/**
* Response of the 'action: query' API request
*
* @var object
*/
private $responseQuery;
/**
* Associative array of normalized titles
*
* @var array
*/
private $normalizedTitles;
/**
* Array of my custom page objects
*
* @var array
*/
private $myPages;
/**
* Constructor
*
* @param $response_query object Response of an API query, the part that involves pages. e.g.:
* {
* normalized: [
* { from: , to: },
* { from: , to: },
* ...
* ],
* query: pages: [
* id: { id: , title: , ... },
* id: { id: , title: , ... },
* ...
* ]
* }
* @param $my_pages array My custom page objects
* @param $page_containers string|array Page container e.g. 'query'
* @see https://it.wikipedia.org/w/api.php?action=query&prop=info&titles=Ghhh|%20Main%20page
*/
public function __construct( $response_query, $my_pages, $page_containers = 'query' ) {
$this->responseQuery = $response_query;
if( $page_containers ) {
if( ! is_array( $page_containers ) ) {
$page_containers = [ $page_containers ];
}
foreach( $page_containers as $page_container ) {
if( isset( $this->responseQuery->{ $page_container } ) ) {
$this->responseQuery = $this->responseQuery->{ $page_container };
} else {
- throw new Exception( "missing property $page_container in the response" );
+ throw new \Exception( "missing property $page_container in the response" );
}
}
}
$this->myPages = $my_pages;
}
/**
* Get the response of the 'action: query' API request
*
* @return object
*/
public function getResponseQuery() {
return $this->responseQuery;
}
/**
* Get the response pages
*
* @return array
*/
public function getResponseQueryPages() {
return $this->getResponseQuery()->pages;
}
/**
* Get my custom pages
*
* @return array
*/
public function getMyPages() {
return $this->myPages;
}
/**
* Has some normalized titles?
*
* @return bool
*/
public function hasNormalizedTitles() {
return isset( $this->getResponseQuery()->normalized );
}
/**
* Get an associative array of normalized titles
*
* @result array e.g. [ ' a' => 'A', ... ]
*/
public function getNormalizedTitles() {
if( null === $this->normalizedTitles ) {
$this->normalizedTitles = [];
if( $this->hasNormalizedTitles() ) {
foreach( $this->getResponseQuery()->normalized as $fromto ) {
$this->normalizedTitles[ $fromto->from ] = $fromto->to;
}
}
}
return $this->normalizedTitles;
}
/**
* Get a normalized title
*
* @param $title string Page title that may have been normalized
* @param $normalized bool Is this page title normalized?
* @return string Page title normalized
*/
public function getNormalizedTitle( $title, & $normalized = false ) {
$normalized_titles = $this->getNormalizedTitles();
if( isset( $normalized_titles[ $title ] ) ) {
$normalized = true;
return $normalized_titles[ $title ];
}
return $title;
}
/**
* Walk the response pages matching mine (from a custom key)
*
* @param $my_pages array Array of your custom page objects. Each page object rappresents a requested page.
* @param $matched_callback callback Callback that will be called for each match between a response page and your custom object:
* The 1° argument is the response page object.
* The 2° argument is your related custom page object.
* @param $my_page_callback callback Callback that must return something from your custom page object:
* The 1° argoment is your object.
* It must return something (the join key).
* @param $response_page_callback callback Callback that must return something from a response page:
* The 1° is a response page object.
* It must return something (the join key).
*/
public function matchByCustomJoin( $matched_callback, $my_page_callback, $response_page_callback ) {
foreach( $this->getResponseQueryPages() as $response_page ) {
$response_page_value = $response_page_callback( $response_page );
foreach( $this->getMyPages() as $my_page ) {
$my_page_value = $my_page_callback( $my_page );
if( $my_page_value === $response_page_value ) {
$matched_callback( $response_page, $my_page );
}
}
}
}
/**
* Walk the response pages matching mine (from the page id)
*
* @param $my_pages array Array of your custom page objects. Each page object rappresents a requested page.
* @param $matched_callback callback Callback that will be called for each match between a response page and your custom object:
* The 1° argument is the response page object.
* The 2° argument is your related custom page object.
* @param $my_page_id_callback callback Callback that must returns a page id from your custom object.
* The 1° is your object.
* It must return a page id.
*/
public function matchById( $matched_callback, $my_page_id_callback ) {
$this->matchByCustomJoin(
$matched_callback,
// callback that returns the page id from my custom page object
$my_page_id_callback,
// callback that returns the page id from the response page object
function ( $response_page ) {
return (int) $response_page->id;
}
);
}
/**
* Walk the response pages, matching them and your own objects (from the page title)
*
* @param $my_pages array Array of your custom page objects. Each object rappresents a requested page.
* @param $my_page_id_callback callback Callback that must returns a page title from your custom object.
* The 1° is your object.
* It must return a page title.
* @param $callback callback Callback that will be called for each of your matched pages.
* The 1° argument is your object.
* If unspecified it means that your object it's the title itself
*/
public function matchByTitle( $matched_callback, $my_page_title_callback = null ) {
$this->matchByCustomJoin(
$matched_callback,
// callback that returns the page title from my custom page object... normalized!
function ( $my_page ) use ( $matched_callback, $my_page_title_callback ) {
// callback that returns the page title from my custom page object...
$title =
$my_page_title_callback
? $my_page_title_callback( $my_page )
: $my_page; // or it's just the string title itself?
// normalized!
return $this->getNormalizedTitle( $title );
},
// callback that returns the page title from the response page object
function ( $response_page ) {
return $response_page->title;
}
);
}
}

File Metadata

Mime Type
text/x-diff
Expires
Thu, Nov 19, 03:19 (3 h, 32 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2264313
Default Alt Text
(7 KB)

Event Timeline