RowCommentIterator.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\CommentFormatter;
 
use ArrayIterator;
use IteratorIterator;
use MediaWiki\CommentStore\CommentStore;
use MediaWiki\Title\TitleValue;
use Traversable;
 
class RowCommentIterator extends IteratorIterator {
    private $commentStore;
    private $commentKey;
    private $namespaceField;
    private $titleField;
    private $indexField;
 
    public function __construct( CommentStore $commentStore, $rows ) {
        if ( is_array( $rows ) ) {
            parent::__construct( new ArrayIterator( $rows ) );
        } else {
            parent::__construct( $rows );
        }
 
        $this->commentStore = $commentStore;
    }
 
    public function commentKey( $key ) {
        $this->commentKey = $key;
        return $this;
    }
 
    public function namespaceField( $field ) {
        $this->namespaceField = $field;
        return $this;
    }
 
    public function titleField( $field ) {
        $this->titleField = $field;
        return $this;
    }
 
    public function indexField( $field ) {
        $this->indexField = $field;
        return $this;
    }
 
    public function key(): string {
        if ( $this->indexField ) {
            return parent::current()->{$this->indexField};
        } else {
            return parent::key();
        }
    }
 
    public function current(): CommentItem {
        if ( $this->commentKey === null ) {
            throw new \RuntimeException( __METHOD__ . ': commentKey must be specified' );
        }
        $row = parent::current();
        $comment = $this->commentStore->getComment( $this->commentKey, $row );
        $item = new CommentItem( (string)$comment->text );
        if ( $this->namespaceField && $this->titleField ) {
            $item->selfLinkTarget( new TitleValue(
                (int)$row->{$this->namespaceField},
                (string)$row->{$this->titleField}
            ) );
        }
        return $item;
    }
}