chillerlan\OAuth\Storage\OAuthStorageAbstract

Complexity

Total Complexity

10

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getServiceName()	0	13	4
A	toStorage()	0	2	1
A	__construct()	0	3	1
A	fromStorage()	0	8	2
A	setServiceName()	0	10	2

<?php
/**
 * Class OAuthStorageAbstract
 *
 * @created      09.07.2017
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 */

namespace chillerlan\OAuth\Storage;

use chillerlan\OAuth\OAuthOptions;
use chillerlan\OAuth\Core\AccessToken;
use chillerlan\Settings\SettingsContainerInterface;
use Psr\Log\{LoggerAwareTrait, LoggerInterface, NullLogger};
use function is_string;

/**
 * Implements an abstract OAuth storage adapter
 */
abstract class OAuthStorageAbstract implements OAuthStorageInterface{
	use LoggerAwareTrait;

	protected OAuthOptions|SettingsContainerInterface $options;
	protected string $serviceName;

	/**
	 * OAuthStorageAbstract constructor.
	 */
	public function __construct(OAuthOptions|SettingsContainerInterface $options = null, LoggerInterface $logger = null){
		$this->options = ($options ?? new OAuthOptions);
		$this->logger  = ($logger ?? new NullLogger);
	}

	/**
	 * @inheritDoc
	 */
	public function setServiceName(string $service):OAuthStorageInterface{
		$service = trim($service);

		if(empty($service)){
			throw new OAuthStorageException('service name must not be empty');
		}

		$this->serviceName = $service;

		return $this;
	}

	/**
	 * @inheritDoc
	 */
	public function getServiceName(string $service = null):string{

		if($service === null && !isset($this->serviceName)){
			throw new OAuthStorageException('invalid service');
		}

		$name = trim($service ?? $this->serviceName);

		if(empty($name)){
			throw new OAuthStorageException('service name must not be empty');
		}

		return $name;
	}

	/**
	 * @inheritDoc
	 */
	public function toStorage(AccessToken $token):string{
		return $token->toJSON();
	}

	/**
	 * @inheritDoc
	 * @phan-suppress PhanTypeMismatchReturnSuperType
	 */
	public function fromStorage(mixed $data):AccessToken{

		if(!is_string($data)){
			throw new OAuthStorageException('invalid data');
		}

		/** @noinspection PhpIncompatibleReturnTypeInspection */
		return (new AccessToken)->fromJSON($data);
	}

}