JWX\Parameter\Feature\Base64URLValue

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
	value()	0	1	?
A	fromString()	0	3	1
A	_validateEncoding()	0	7	2
A	string()	0	3	1

<?php

namespace JWX\Parameter\Feature;

use JWX\Util\Base64;


/**
 * Trait for parameters having Base64url value.
 */
trait Base64URLValue
{
	use StringParameterValue;
	
	/**
	 * Get the parameter value.
	 *
	 * @return string
	 */
	abstract public function value();
	
	/**
	 * Initialize from native value.
	 *
	 * Value shall be encoded using Base64url encoding.
	 *
	 * @param string $value
	 * @return self
	 */
	public static function fromString($value) {
		return new static(Base64::urlEncode($value));
	}
	
	/**
	 * Validate that value is validly base64url encoded.
	 *
	 * @param string $value
	 * @throws \UnexpectedValueException
	 * @return self
	 */
	protected function _validateEncoding($value) {
		if (!Base64::isValidURLEncoding($value)) {
			throw new \UnexpectedValueException(
				"Value must be base64url encoded.");
		}
		return $this;
	}
	
	/**
	 * Get the parameter value as a decoded string.
	 *
	 * @return string
	 */
	public function string() {
		return Base64::urlDecode($this->value());
	}
}