BotRiconferme\ContextSource

Complexity

Total Complexity

15

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getWiki()	0	2	1
A	getPage()	0	2	1
A	getBotList()	0	2	1
A	getUser()	0	3	1
A	setMessageProvider()	0	2	1
A	getOpt()	0	2	1
A	setConfig()	0	2	1
A	getLogger()	0	2	1
A	__construct()	0	11	1
A	getWikiGroup()	0	2	1
A	msg()	0	2	1
A	setLogger()	0	2	1
A	setWikiGroup()	0	2	1
A	getConfig()	0	2	1
A	getMessageProvider()	0	2	1

<?php declare( strict_types=1 );

namespace BotRiconferme;

use BotRiconferme\Message\Message;
use BotRiconferme\Wiki\Page\Page;
use BotRiconferme\Wiki\Page\PageBotList;
use BotRiconferme\Wiki\User;
use BotRiconferme\Wiki\Wiki;
use BotRiconferme\Wiki\WikiGroup;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;

/**
 * Base class with a few utility methods available to get a logger, the config and a wiki
 */
abstract class ContextSource implements LoggerAwareInterface {
	/** @var LoggerInterface */
	private $logger;

	/** @var Config */
	private $config;

	/** @var WikiGroup */
	private $wikiGroup;

	/** @var MessageProvider */
	private $messageProvider;

	/** @var PageBotList */
	private $pageBotList;

	/**
	 * @param LoggerInterface $logger
	 * @param WikiGroup $wikiGroup
	 * @param MessageProvider $mp
	 * @param PageBotList $pbl
	 */
	public function __construct(
		LoggerInterface $logger,
		WikiGroup $wikiGroup,
		MessageProvider $mp,
		PageBotList $pbl
	) {
		$this->setLogger( $logger );
		$this->setConfig( Config::getInstance() );
		$this->setWikiGroup( $wikiGroup );
		$this->setMessageProvider( $mp );
		$this->pageBotList = $pbl;
	}

	/**
	 * @return LoggerInterface
	 */
	protected function getLogger(): LoggerInterface {
		return $this->logger;
	}

	/**
	 * @inheritDoc
	 */
	public function setLogger( LoggerInterface $logger ): void {
		$this->logger = $logger;
	}

	/**
	 * Shorthand to $this->getConfig()->get
	 *
	 * @param string $optname
	 * @return mixed
	 */
	protected function getOpt( string $optname ) {
		return $this->getConfig()->get( $optname );
	}

	/**
	 * @return Config
	 */
	protected function getConfig(): Config {
		return $this->config;
	}

	/**
	 * @param Config $cfg
	 */
	protected function setConfig( Config $cfg ): void {
		$this->config = $cfg;
	}

	/**
	 * Shorthand
	 * @return Wiki
	 */
	protected function getWiki(): Wiki {
		return $this->getWikiGroup()->getMainWiki();
	}

	/**
	 * @return WikiGroup
	 */
	protected function getWikiGroup(): WikiGroup {
		return $this->wikiGroup;
	}

	/**
	 * @param WikiGroup $wikiGroup
	 */
	protected function setWikiGroup( WikiGroup $wikiGroup ): void {
		$this->wikiGroup = $wikiGroup;
	}

	/**
	 * @return MessageProvider
	 */
	protected function getMessageProvider(): MessageProvider {
		return $this->messageProvider;
	}

	/**
	 * @param MessageProvider $mp
	 */
	protected function setMessageProvider( MessageProvider $mp ): void {
		$this->messageProvider = $mp;
	}

	/**
	 * Get a message
	 *
	 * @param string $key
	 * @return Message
	 */
	protected function msg( string $key ): Message {
		return $this->messageProvider->getMessage( $key );
	}

	/**
	 * @return PageBotList
	 */
	public function getBotList(): PageBotList {
		return $this->pageBotList;
	}

	/**
	 * Shorthand to get a page using the local wiki
	 *
	 * @param string $title
	 * @return Page
	 */
	protected function getPage( string $title ): Page {
		return new Page( $title, $this->getWiki() );
	}

	/**
	 * Shorthand to get a user using the local wiki
	 *
	 * @param string $name
	 * @return User
	 */
	protected function getUser( string $name ): User {
		$ui = $this->getBotList()->getUserInfo( $name );
		return new User( $ui, $this->getWiki() );
	}
}