summaryrefslogtreecommitdiff
path: root/www/wiki/includes/TitleArray.php
diff options
context:
space:
mode:
authorYaco <franco@reevo.org>2020-06-04 11:01:00 -0300
committerYaco <franco@reevo.org>2020-06-04 11:01:00 -0300
commitfc7369835258467bf97eb64f184b93691f9a9fd5 (patch)
treedaabd60089d2dd76d9f5fb416b005fbe159c799d /www/wiki/includes/TitleArray.php
first commit
Diffstat (limited to 'www/wiki/includes/TitleArray.php')
-rw-r--r--www/wiki/includes/TitleArray.php59
1 files changed, 59 insertions, 0 deletions
diff --git a/www/wiki/includes/TitleArray.php b/www/wiki/includes/TitleArray.php
new file mode 100644
index 00000000..a1eabe5b
--- /dev/null
+++ b/www/wiki/includes/TitleArray.php
@@ -0,0 +1,59 @@
+<?php
+/**
+ * Class to walk into a list of Title objects.
+ *
+ * Note: this entire file is a byte-for-byte copy of UserArray.php with
+ * s/User/Title/. If anyone can figure out how to do this nicely with
+ * inheritance or something, please do so.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+use Wikimedia\Rdbms\IResultWrapper;
+
+/**
+ * The TitleArray class only exists to provide the newFromResult method at pre-
+ * sent.
+ */
+abstract class TitleArray implements Iterator {
+ /**
+ * @param IResultWrapper $res A SQL result including at least page_namespace and
+ * page_title -- also can have page_id, page_len, page_is_redirect,
+ * page_latest (if those will be used). See Title::newFromRow.
+ * @return TitleArrayFromResult
+ */
+ static function newFromResult( $res ) {
+ $array = null;
+ if ( !Hooks::run( 'TitleArrayFromResult', [ &$array, $res ] ) ) {
+ return null;
+ }
+ if ( $array === null ) {
+ $array = self::newFromResult_internal( $res );
+ }
+ return $array;
+ }
+
+ /**
+ * @param IResultWrapper $res
+ * @return TitleArrayFromResult
+ */
+ protected static function newFromResult_internal( $res ) {
+ $array = new TitleArrayFromResult( $res );
+ return $array;
+ }
+}