122 lines
2.1 KiB
PHP
122 lines
2.1 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of jwt-auth.
|
|
*
|
|
* (c) Sean Tymon <tymon148@gmail.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Tymon\JWTAuth\Claims;
|
|
|
|
use Tymon\JWTAuth\Exceptions\InvalidClaimException;
|
|
|
|
abstract class Claim implements ClaimInterface
|
|
{
|
|
/**
|
|
* The claim name.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $name;
|
|
|
|
/**
|
|
* The claim value.
|
|
*
|
|
* @var mixed
|
|
*/
|
|
private $value;
|
|
|
|
/**
|
|
* @param mixed $value
|
|
*/
|
|
public function __construct($value)
|
|
{
|
|
$this->setValue($value);
|
|
}
|
|
|
|
/**
|
|
* Set the claim value, and call a validate method if available.
|
|
*
|
|
* @param $value
|
|
* @throws \Tymon\JWTAuth\Exceptions\InvalidClaimException
|
|
* @return $this
|
|
*/
|
|
public function setValue($value)
|
|
{
|
|
if (! $this->validate($value)) {
|
|
throw new InvalidClaimException('Invalid value provided for claim "'.$this->getName().'": '.$value);
|
|
}
|
|
|
|
$this->value = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get the claim value.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getValue()
|
|
{
|
|
return $this->value;
|
|
}
|
|
|
|
/**
|
|
* Set the claim name.
|
|
*
|
|
* @param string $name
|
|
* @return $this
|
|
*/
|
|
public function setName($name)
|
|
{
|
|
$this->name = $name;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get the claim name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Validate the Claim value.
|
|
*
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
protected function validate($value)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Build a key value array comprising of the claim name and value.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function toArray()
|
|
{
|
|
return [$this->getName() => $this->getValue()];
|
|
}
|
|
|
|
/**
|
|
* Get the claim as a string.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return json_encode($this->toArray(), JSON_UNESCAPED_SLASHES);
|
|
}
|
|
}
|