ElkArte\Modules\AbstractModule

Complexity

Total Complexity

4

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getApi()	0	6	3
A	__construct()	0	4	1

<?php

/**
 * Abstract for modules.
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * @version 2.0 dev
 *
 */

namespace ElkArte\Modules;

use ElkArte\Helper\HttpReq;
use ElkArte\UserInfo;

/**
 * Abstract AbstractModule Provides some standard values to modules
 *
 * @package ElkArte\sources\modules
 */
abstract class AbstractModule implements ModuleInterface
{
	/** @var HttpReq|null Access to post/get data */
	protected $_req;

	/** @var UserInfo|null User Info ValuesContainer */
	protected $user;

	/**
	 * AbstractModule constructor.
	 *
	 * @param HttpReq $req
	 * @param UserInfo $user
	 */
	public function __construct(HttpReq $req, UserInfo $user)
	{
		$this->_req = $req;
		$this->user = $user;
	}

	/**
	 * Helper function to see if a request is asking for any api processing
	 *
	 * @return string|false
	 */
	public function getApi()
	{
		// API Call?
		$api = $this->_req->getRequest('api', 'trim', '');

The method getRequest() does not exist on null.

		return in_array($api, ['xml', 'json', 'html']) && !empty($_SERVER['HTTP_X_REQUESTED_WITH']) ? $api : false;
	}
}