CommentBatch.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\CommentFormatter;
 
use MediaWiki\Linker\LinkTarget;
use Traversable;
 
class CommentBatch {
    private $formatter;
    private $comments;
    private $useBlock;
    private $useParentheses;
    private $selfLinkTarget;
    private $samePage;
    private $wikiId;
    private $enableSectionLinks;
 
    public function __construct( CommentFormatter $formatter ) {
        $this->formatter = $formatter;
    }
 
    public function comments( $comments ) {
        $this->comments = $comments;
        return $this;
    }
 
    public function strings( array $strings ) {
        $this->comments = new StringCommentIterator( $strings );
        return $this;
    }
 
    public function useBlock( $useBlock = true ) {
        $this->useBlock = $useBlock;
        return $this;
    }
 
    public function useParentheses( $useParentheses = true ) {
        $this->useParentheses = $useParentheses;
        return $this;
    }
 
    public function selfLinkTarget( LinkTarget $selfLinkTarget ) {
        $this->selfLinkTarget = $selfLinkTarget;
        return $this;
    }
 
    public function enableSectionLinks( $enable ) {
        $this->enableSectionLinks = $enable;
        return $this;
    }
 
    public function disableSectionLinks() {
        $this->enableSectionLinks = false;
        return $this;
    }
 
    public function samePage( $samePage = true ) {
        $this->samePage = $samePage;
        return $this;
    }
 
    public function wikiId( $wikiId ) {
        $this->wikiId = $wikiId;
        return $this;
    }
 
    public function execute() {
        return $this->formatter->formatItemsInternal(
            $this->comments,
            $this->selfLinkTarget,
            $this->samePage,
            $this->wikiId,
            $this->enableSectionLinks,
            $this->useBlock,
            $this->useParentheses
        );
    }
 
}