senky\akismet\utility\akismet_factory

Complexity

Total Complexity

2

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	create_akismet()	0	3	1
A	__construct()	0	3	1

<?php
/**
 *
 * Akismet. An extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2018 Jakub Senko <jakubsenko@gmail.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace senky\akismet\utility;

/**
 * The Akismet Factory class is used to create a new vendor Akismet
 * API wrapper class using our configured API key and board URL. These
 * need to be passed into the constructor, so a factory seemed a good
 * approach that would allow us to unit test easily.
 */
class akismet_factory
{
	/** @var \phpbb\config\config */
	protected $config;

	/**
	 * Constructor
	 *
	 * Lightweight initialisation of the API key and user ID.
	 * Heavy lifting is done only if the user actually tries
	 * to post a message, new user tries to register or moderator
	 * approves post (we submit ham to Akismet service).
	 *
	 * @param \phpbb\config\config		$config	phpBB Config class
	 */
	public function __construct(\phpbb\config\config $config)
	{
		$this->config = $config;
	}

	/**
	 * Initialize Akismet client with board-specific data
	 *
	 * @return \Gothick\AkismetClient\Client
	 * @throws \Gothick\AkismetClient\AkismetException
	 */
	public function create_akismet()
	{
		return new \Gothick\AkismetClient\Client(generate_board_url(), 'phpBB', $this->config['version'], $this->config['senky_akismet_api_key']);
	}
}